Browse Source

add docs to asset container

Trevor Baron 7 năm trước cách đây
mục cha
commit
5cefb634e4

+ 0 - 115
dist/preview release/typedocValidationBaseline.json

@@ -4619,121 +4619,6 @@
         }
         }
       }
       }
     },
     },
-    "AssetContainer": {
-      "Class": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Constructor": {
-        "new AssetContainer": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "scene": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      },
-      "Property": {
-        "actionManagers": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "animations": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "cameras": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "geometries": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "lensFlareSystems": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "lights": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "materials": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "meshes": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "morphTargetManagers": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "multiMaterials": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "particleSystems": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "scene": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "shadowGenerators": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "skeletons": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "sounds": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "transformNodes": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      },
-      "Method": {
-        "addAllToScene": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "removeAllFromScene": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
     "AsyncLoop": {
     "AsyncLoop": {
       "Property": {
       "Property": {
         "index": {
         "index": {

+ 82 - 0
src/babylon.assetContainer.ts

@@ -1,34 +1,108 @@
 module BABYLON {
 module BABYLON {
+    /**
+     * Set of assets to keep when moving a scene into an asset container.
+     */
     export class KeepAssets {
     export class KeepAssets {
+        /**
+         * Cameras to keep.
+         */
         cameras: BABYLON.Camera[] = [];
         cameras: BABYLON.Camera[] = [];
+        /**
+         * Meshes to keep.
+         */
         meshes: BABYLON.Mesh[] = [];
         meshes: BABYLON.Mesh[] = [];
+        /**
+         * Geometries to keep.
+         */
         geometries: BABYLON.Geometry[] = [];
         geometries: BABYLON.Geometry[] = [];
+        /**
+         * Materials to keep.
+         */
         materials: BABYLON.Material[] = [];
         materials: BABYLON.Material[] = [];
     }
     }
+
+    /**
+     * Container with a set of assets that can be added or removed from a scene.
+     */
     export class AssetContainer {
     export class AssetContainer {
+        /**
+         * The scene the AssetContainer belongs to.
+         */
         public scene: Scene;
         public scene: Scene;
 
 
         // Objects
         // Objects
+        /**
+         * Cameras populated in the container.
+         */
         public cameras = new Array<Camera>();
         public cameras = new Array<Camera>();
+        /**
+         * Lights populated in the container.
+         */
         public lights = new Array<Light>();
         public lights = new Array<Light>();
+        /**
+         * Meshes populated in the container.
+         */
         public meshes = new Array<AbstractMesh>();
         public meshes = new Array<AbstractMesh>();
+        /**
+         * Skeletons populated in the container.
+         */
         public skeletons = new Array<Skeleton>();
         public skeletons = new Array<Skeleton>();
+        /**
+         * ParticleSystems populated in the container.
+         */
         public particleSystems = new Array<ParticleSystem>();
         public particleSystems = new Array<ParticleSystem>();
+        /**
+         * Animations populated in the container.
+         */
         public animations = new Array<Animation>();
         public animations = new Array<Animation>();
+        /**
+         * MultiMaterials populated in the container.
+         */
         public multiMaterials = new Array<MultiMaterial>();
         public multiMaterials = new Array<MultiMaterial>();
+        /**
+         * Materials populated in the container.
+         */
         public materials = new Array<Material>();
         public materials = new Array<Material>();
+        /**
+         * MorphTargetManagers populated in the container.
+         */
         public morphTargetManagers = new Array<MorphTargetManager>();
         public morphTargetManagers = new Array<MorphTargetManager>();
+        /**
+         * Geometries populated in the container.
+         */
         public geometries = new Array<Geometry>();
         public geometries = new Array<Geometry>();
+        /**
+         * TransformNodes populated in the container.
+         */
         public transformNodes = new Array<TransformNode>();
         public transformNodes = new Array<TransformNode>();
+        /**
+         * LensFlareSystems populated in the container.
+         */
         public lensFlareSystems = new Array<LensFlareSystem>();
         public lensFlareSystems = new Array<LensFlareSystem>();
+        /**
+         * ShadowGenerators populated in the container.
+         */
         public shadowGenerators = new Array<ShadowGenerator>();
         public shadowGenerators = new Array<ShadowGenerator>();
+        /**
+         * ActionManagers populated in the container.
+         */
         public actionManagers = new Array<ActionManager>();
         public actionManagers = new Array<ActionManager>();
+        /**
+         * Sounds populated in the container.
+         */
         public sounds = new Array<Sound>();
         public sounds = new Array<Sound>();
         
         
+        /**
+         * Instantiates an AssetContainer.
+         * @param scene The scene the AssetContainer belongs to.
+         */
         constructor(scene:Scene){
         constructor(scene:Scene){
             this.scene = scene;
             this.scene = scene;
         }
         }
         
         
+        /**
+         * Adds all the assets from the container to the scene.
+         */
         addAllToScene(){
         addAllToScene(){
             this.cameras.forEach((o)=>{
             this.cameras.forEach((o)=>{
                 this.scene.addCamera(o);
                 this.scene.addCamera(o);
@@ -75,6 +149,10 @@ module BABYLON {
                 this.scene.mainSoundTrack.AddSound(o);
                 this.scene.mainSoundTrack.AddSound(o);
             })
             })
         }
         }
+
+        /**
+         * Removes all the assets in the container from the scene
+         */
         removeAllFromScene(){
         removeAllFromScene(){
             this.cameras.forEach((o)=>{
             this.cameras.forEach((o)=>{
                 this.scene.removeCamera(o);
                 this.scene.removeCamera(o);
@@ -138,6 +216,10 @@ module BABYLON {
             }
             }
         }
         }
 
 
+        /**
+         * Removes all the assets contained in the scene and adds them to the container.
+         * @param keepAssets Set of assets keep in the scene. (default: empty)
+         */
         moveAllFromScene(keepAssets?: KeepAssets): void {
         moveAllFromScene(keepAssets?: KeepAssets): void {
 
 
             if (keepAssets === undefined) {
             if (keepAssets === undefined) {