Przeglądaj źródła

LinEdgesRenderer docs update

Bartosz Ostapowicz 7 lat temu
rodzic
commit
f67721b4dd

Plik diff jest za duży
+ 9202 - 9152
dist/preview release/babylon.d.ts


+ 2 - 2
src/Rendering/babylon.edgesRenderer.ts

@@ -29,8 +29,8 @@
         // Beware when you use this class with complex objects as the adjacencies computation can be really long
         /**
          *
-         * @param {BABYLON.AbstractMesh} source
-         * @param {number} epsilon
+         * @param {BABYLON.AbstractMesh} source Mesh used to create edges
+         * @param {number} epsilon sum of angles in adjacency to check for edge
          * @param {boolean} checkVerticesInsteadOfIndices
          * @param {boolean} generateEdgesLines - should generate Lines or only prepare resources.
          */

+ 14 - 14
src/Rendering/babylon.lineEdgesRenderer.ts

@@ -1,7 +1,7 @@
 module BABYLON {
     /**
-     * @class FaceAdjacencies
-     * Helper class to generate edges
+     * @class FaceAdjacencies Helper class to generate edges
+     *
      */
     class FaceAdjacencies {
         public edges = new Array<number>();
@@ -11,17 +11,17 @@
     }
 
     /**
-     * @class LineEdgesRenderer
+     * @class LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
      * @param {string} author Bartosz Ostapowicz
-     * for LineMeshes to remove unnecessary triangulation
-     */
+     *
+     * */
     export class LineEdgesRenderer extends EdgesRenderer {
 
         /**
          * This constructor turns off auto generating edges line in Edges Renderer to make it here.
-         * @param {BABYLON.AbstractMesh} source
-         * @param {number} epsilon
-         * @param {boolean} checkVerticesInsteadOfIndices
+         * @param {BABYLON.AbstractMesh} source LineMesh used to generate edges
+         * @param {number} epsilon not important (specified angle for edge detection)
+         * @param {boolean} checkVerticesInsteadOfIndices not important for LineMesh
          *
          */
         constructor(source: AbstractMesh, epsilon = 0.95, checkVerticesInsteadOfIndices = false) {
@@ -30,12 +30,12 @@
         }
 
         /**
-         * Always create the edge since its a line
-         * @param {number} faceIndex
-         * @param {number} edge
-         * @param {Array<BABYLON.Vector3>} faceNormals
-         * @param {BABYLON.Vector3} p0
-         * @param {BABYLON.Vector3} p1
+         * Always create the edge since its a line so only important things are p0 and p1
+         * @param {number} faceIndex not important for LineMesh
+         * @param {number} edge not important for LineMesh
+         * @param {Array<BABYLON.Vector3>} faceNormals not important for LineMesh
+         * @param {BABYLON.Vector3} p0 beginnig of line
+         * @param {BABYLON.Vector3} p1 end of line
          * @private
          */
         protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void {