Browse Source

Add code comments for geometry class

David Catuhe 7 years ago
parent
commit
a7ab12967f

File diff suppressed because it is too large
+ 2690 - 2026
Playground/babylon.d.txt


+ 6 - 0
Tools/Gulp/gulp-validateTypedoc.js

@@ -445,6 +445,12 @@ Validate.prototype.validateComment = function(node) {
         return true;
         return true;
     }
     }
 
 
+    // Return true for overwrited properties
+    if (node.overwrites) {
+        return true;
+    }
+    
+
     if (node.comment) {
     if (node.comment) {
 
 
         if (node.comment.text || node.comment.shortText) {
         if (node.comment.text || node.comment.shortText) {

File diff suppressed because it is too large
+ 3307 - 2645
dist/preview release/babylon.d.ts


File diff suppressed because it is too large
+ 31 - 31
dist/preview release/babylon.js


File diff suppressed because it is too large
+ 553 - 35
dist/preview release/babylon.max.js


File diff suppressed because it is too large
+ 31 - 31
dist/preview release/babylon.worker.js


File diff suppressed because it is too large
+ 3480 - 2818
dist/preview release/customConfigurations/minimalGLTFViewer/babylon.d.ts


File diff suppressed because it is too large
+ 31 - 31
dist/preview release/customConfigurations/minimalGLTFViewer/babylon.js


File diff suppressed because it is too large
+ 553 - 35
dist/preview release/customConfigurations/minimalGLTFViewer/babylon.max.js


File diff suppressed because it is too large
+ 553 - 35
dist/preview release/customConfigurations/minimalGLTFViewer/es6.js


File diff suppressed because it is too large
+ 553 - 35
dist/preview release/es6.js


File diff suppressed because it is too large
+ 2901 - 12169
dist/preview release/typedocValidationBaseline.json


File diff suppressed because it is too large
+ 34 - 34
dist/preview release/viewer/babylon.viewer.js


+ 15 - 1
src/Collisions/babylon.collisionCoordinator.ts

@@ -44,12 +44,26 @@ module BABYLON {
         boxMaximum: Array<number>;
         boxMaximum: Array<number>;
     }
     }
 
 
+    /**
+     * Interface describing the value associated with a geometry
+     */
     export interface SerializedGeometry {
     export interface SerializedGeometry {
+        /**
+         * Defines the unique ID of the geometry
+         */
         id: string;
         id: string;
+        /**
+         * Defines the array containing the positions
+         */
         positions: Float32Array;
         positions: Float32Array;
+        /**
+         * Defines the array containing the indices
+         */        
         indices: Uint32Array;
         indices: Uint32Array;
+        /**
+         * Defines the array containing the normals
+         */        
         normals: Float32Array;
         normals: Float32Array;
-        //uvs?: Float32Array;
     }
     }
 
 
     export interface BabylonMessage {
     export interface BabylonMessage {

File diff suppressed because it is too large
+ 585 - 35
src/Mesh/babylon.geometry.ts


+ 2 - 2
src/Mesh/babylon.mesh.ts

@@ -2492,14 +2492,14 @@
                     mesh._delayInfo.push(VertexBuffer.MatricesWeightsKind);
                     mesh._delayInfo.push(VertexBuffer.MatricesWeightsKind);
                 }
                 }
 
 
-                mesh._delayLoadingFunction = Geometry.ImportGeometry;
+                mesh._delayLoadingFunction = Geometry._ImportGeometry;
 
 
                 if (SceneLoader.ForceFullSceneLoadingForIncremental) {
                 if (SceneLoader.ForceFullSceneLoadingForIncremental) {
                     mesh._checkDelayState();
                     mesh._checkDelayState();
                 }
                 }
 
 
             } else {
             } else {
-                Geometry.ImportGeometry(parsedMesh, mesh);
+                Geometry._ImportGeometry(parsedMesh, mesh);
             }
             }
 
 
             // Material
             // Material

+ 1 - 0
src/Mesh/babylon.vertexBuffer.ts

@@ -145,6 +145,7 @@
 
 
         /**
         /**
          * Updates the underlying WebGLBuffer according to the passed numeric array or Float32Array.  
          * Updates the underlying WebGLBuffer according to the passed numeric array or Float32Array.  
+         * This function will create a new buffer if the current one is not updatable
          * Returns the updated WebGLBuffer.  
          * Returns the updated WebGLBuffer.  
          */
          */
         public update(data: FloatArray): void {
         public update(data: FloatArray): void {