Browse Source

fix comments

David Catuhe 6 years ago
parent
commit
cb35d70be2
2 changed files with 71 additions and 1 deletions
  1. 66 1
      Playground/babylon.d.txt
  2. 5 0
      src/Debug/debugLayer.ts

+ 66 - 1
Playground/babylon.d.txt

@@ -39141,6 +39141,7 @@ declare module BABYLON {
         constructor(scene: Scene);
         /** Creates the inspector window. */
         private _createInspector;
+        select(entity: any, lineContainerTitle?: string): void;
         /** Get the inspector from bundle or global */
         private _getGlobalInspector;
         /**
@@ -39155,8 +39156,9 @@ declare module BABYLON {
         /**
           * Launch the debugLayer.
           * @param config Define the configuration of the inspector
+          * @return a promise fulfilled when the debug layer is visible
           */
-        show(config?: IInspectorOptions): void;
+        show(config?: IInspectorOptions): Promise<DebugLayer>;
     }
 }
 declare module BABYLON {
@@ -46312,6 +46314,69 @@ declare module BABYLON {
 }
 declare module BABYLON {
     /**
+     * Class used to create a trail following a mesh
+     */
+    export class TrailMesh extends Mesh {
+        private _generator;
+        private _autoStart;
+        private _running;
+        private _diameter;
+        private _length;
+        private _sectionPolygonPointsCount;
+        private _sectionVectors;
+        private _sectionNormalVectors;
+        private _beforeRenderObserver;
+        /**
+         * @constructor
+         * @param name The value used by scene.getMeshByName() to do a lookup.
+         * @param generator The mesh to generate a trail.
+         * @param scene The scene to add this mesh to.
+         * @param diameter Diameter of trailing mesh. Default is 1.
+         * @param length Length of trailing mesh. Default is 60.
+         * @param autoStart Automatically start trailing mesh. Default true.
+         */
+        constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
+        /**
+         * "TrailMesh"
+         * @returns "TrailMesh"
+         */
+        getClassName(): string;
+        private _createMesh;
+        /**
+         * Start trailing mesh.
+         */
+        start(): void;
+        /**
+         * Stop trailing mesh.
+         */
+        stop(): void;
+        /**
+         * Update trailing mesh geometry.
+         */
+        update(): void;
+        /**
+         * Returns a new TrailMesh object.
+         * @param name is a string, the name given to the new mesh
+         * @param newGenerator use new generator object for cloned trail mesh
+         * @returns a new mesh
+         */
+        clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
+        /**
+         * Serializes this trail mesh
+         * @param serializationObject object to write serialization to
+         */
+        serialize(serializationObject: any): void;
+        /**
+         * Parses a serialized trail mesh
+         * @param parsedMesh the serialized mesh
+         * @param scene the scene to create the trail mesh in
+         * @returns the created trail mesh
+         */
+        static Parse(parsedMesh: any, scene: Scene): TrailMesh;
+    }
+}
+declare module BABYLON {
+    /**
      * Class containing static functions to help procedurally build meshes
      */
     export class RibbonBuilder {

+ 5 - 0
src/Debug/debugLayer.ts

@@ -168,6 +168,11 @@ export class DebugLayer {
         this.BJSINSPECTOR.Inspector.Show(this._scene, userOptions);
     }
 
+    /**
+     * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
+     * @param entity defines the entity to select
+     * @param lineContainerTitle defines the specific block to highlight
+     */
     public select(entity: any, lineContainerTitle?: string) {
         if (this.BJSINSPECTOR) {
             this.BJSINSPECTOR.Inspector.MarkLineContainerTitleForHighlighting(lineContainerTitle);