From 954be854c9aa75d887deb3487afd5b4f637d84bd Mon Sep 17 00:00:00 2001
From: Remco Veldkamp <remcoder@gmail.com>
Date: Mon, 27 Jan 2025 22:01:46 +0100
Subject: [PATCH] Add missing docs and improve naming

---
 src/webgl-preview.ts | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/src/webgl-preview.ts b/src/webgl-preview.ts
index da7a6a4..db843ce 100644
--- a/src/webgl-preview.ts
+++ b/src/webgl-preview.ts
@@ -441,6 +441,15 @@ export class WebGLPreview {
     this.updateLineClipping(minZ, maxZ);
   }
 
+
+  /**
+   * Updates the clipping planes for all shader materials in the scene.
+   * This method sets the min and max Z values for the clipping planes in the shader materials.
+   *
+   * @param minZ - The minimum Z value for the clipping plane.
+   * @param maxZ - The maximum Z value for the clipping plane
+   */
+    
   private updateClippingPlanesForShaderMaterials(minZ: number, maxZ: number) {
     this.materials.forEach((material) => {
       material.uniforms.clipMinY.value = minZ;
@@ -448,7 +457,17 @@ export class WebGLPreview {
     });
   }
 
-  private applyClippingPlanes(material: Material, minZ: number, maxZ: number) {
+  /**
+   * Applies clipping planes to the specified material based on the minimum and maximum Z values.
+   *
+   * This method creates clipping planes for the top and bottom of the specified Z range,
+   * then applies them to the material's clippingPlanes property.
+   *
+   * @param material - Shader material to apply clipping planes to
+   * @param minZ - The minimum Z value for the clipping plane.
+   * @param maxZ - The maximum Z value for the clipping plane.
+   */ 
+  private applyMinMaxClippingPlanes(material: Material, minZ: number, maxZ: number) {
     material.clippingPlanes = [new Plane(new Vector3(0, 1, 0), -minZ), new Plane(new Vector3(0, -1, 0), maxZ)];
   }
 
@@ -464,7 +483,7 @@ export class WebGLPreview {
     this.scene.traverse((obj) => {
       if (obj instanceof LineSegments2) {
         const material = obj.material as LineMaterial;
-        this.applyClippingPlanes(material, minZ, maxZ);
+        this.applyMinMaxClippingPlanes(material, minZ, maxZ);
       }
     });
   }
@@ -806,7 +825,7 @@ export class WebGLPreview {
       linewidth: this.lineWidth
     });
 
-    this.applyClippingPlanes(material, minZ, maxZ);
+    this.applyMinMaxClippingPlanes(material, minZ, maxZ);
 
     const lineVertices: number[] = [];