@xeokit/xeokit-sdk 2.5.2-beta-5 → 2.5.2-beta-7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.5.2-beta-5",
+  "version": "2.5.2-beta-7",
   "description": "Web Programming Toolkit for 3D/2D BIM and AEC Graphics",
   "module": "./dist/xeokit-sdk.es.js",
   "main": "./dist/xeokit-sdk.cjs.js",

package/src/plugins/TreeViewPlugin/TreeViewNode.js

@@ -28,12 +28,20 @@ class TreeViewNode {
     get title() {
     }
 
+    /** Type of the corresponding {@link MetaObject}.
+     *
+     * @type {String}
+     * @abstract
+     */
+    get type() {
+    }
+
     /**
      * ID of the corresponding {@link MetaObject}.
      *
      * This is only defined if the TreeViewNode represents an object.
      *
-     * @type {Number|String}
+     * @type {String}
      * @abstract
      */
     get objectId() {
@@ -54,7 +62,6 @@ class TreeViewNode {
      * @abstract
      */
     get parent() {
-
     }
 
     /** The number of {@link Entity}s within the subtree of this TreeViewNode.
@@ -72,7 +79,6 @@ class TreeViewNode {
      * @abstract
      */
     get numVisibleEntities() {
-
     }
 
     /** Whether or not the TreeViewNode is currently checked.
@@ -81,7 +87,6 @@ class TreeViewNode {
      * @abstract
      */
     get checked() {
-
     }
 
     /** Whether or not the TreeViewNode is currently xrayed.
@@ -89,9 +94,8 @@ class TreeViewNode {
      * @type {Boolean}
      * @abstract
      */
-     get xrayed() {
-
+    get xrayed() {
     }
 }
 
-export {TreeViewNode};
+export {TreeViewNode};

package/src/viewer/scene/model/SceneModel.js

@@ -1146,8 +1146,6 @@ export class SceneModel extends Component {
         this._vboBatchingLayers = {};
         this._dtxLayers = {};
 
-        this._meshList = [];
-
         this.layerList = []; // For GL state efficiency when drawing, InstancingLayers are in first part, BatchingLayers are in second
         this._entityList = [];
 
@@ -1159,7 +1157,8 @@ export class SceneModel extends Component {
         this._meshes = {};
         this._entities = {};
 
-        this._scheduledMeshes = {}
+        this._scheduledMeshes = {};
+        this._meshesCfgsBeforeMeshCreation = {};
 
         /** @private **/
         this.renderFlags = new RenderFlags();
@@ -2690,7 +2689,7 @@ export class SceneModel extends Component {
     /**
      * Creates a new {@link SceneModelMesh} within this SceneModel.
      *
-     * * Stores the new SceneModelMesh in {@link SceneModel#meshes}.
+     * * It prepares and saves data for a SceneModelMesh {@link SceneModel#meshes} creation. SceneModelMesh will be created only once the SceneModelEntity (which references this particular SceneModelMesh) will be created.
      * * The SceneModelMesh can either define its own geometry or share it with other SceneModelMeshes. To define own geometry, provide the
      * various geometry arrays to this method. To share a geometry, provide the ID of a geometry created earlier
      * with {@link SceneModel#createGeometry}.
@@ -2725,18 +2724,18 @@ export class SceneModel extends Component {
      * @param {Number} [cfg.opacity=1] Opacity in range ````[0..1]````. Overridden by texture set ````colorTexture````.
      * @param {Number} [cfg.metallic=0] Metallic factor in range ````[0..1]````. Overridden by texture set ````metallicRoughnessTexture````.
      * @param {Number} [cfg.roughness=1] Roughness factor in range ````[0..1]````. Overridden by texture set ````metallicRoughnessTexture````.
-     * @returns {SceneModelMesh} The new mesh.
+     * @returns {Boolean} True = successfully mesh was created. False = error during creation of a mesh.
      */
     createMesh(cfg) {
 
         if (cfg.id === undefined || cfg.id === null) {
             this.error("[createMesh] SceneModel.createMesh() config missing: id");
-            return;
+            return false;
         }
 
         if (this._scheduledMeshes[cfg.id]) {
             this.error(`[createMesh] SceneModel already has a mesh with this ID: ${cfg.id}`);
-            return;
+            return false;
         }
 
         const instancing = (cfg.geometryId !== undefined);
@@ -2751,31 +2750,31 @@ export class SceneModel extends Component {
             }
             if (cfg.primitive !== "points" && cfg.primitive !== "lines" && cfg.primitive !== "triangles" && cfg.primitive !== "solid" && cfg.primitive !== "surface") {
                 this.error(`Unsupported value for 'primitive': '${primitive}'  ('geometryId' is absent) - supported values are 'points', 'lines', 'triangles', 'solid' and 'surface'.`);
-                return;
+                return false;
             }
             if (!cfg.positions && !cfg.positionsCompressed && !cfg.buckets) {
                 this.error("Param expected: 'positions',  'positionsCompressed' or `buckets`  ('geometryId' is absent)");
-                return null;
+                return false;
             }
             if (cfg.positions && (cfg.positionsDecodeMatrix || cfg.positionsDecodeBoundary)) {
                 this.error("Illegal params: 'positions' not expected with 'positionsDecodeMatrix'/'positionsDecodeBoundary' ('geometryId' is absent)");
-                return null;
+                return false;
             }
             if (cfg.positionsCompressed && !cfg.positionsDecodeMatrix && !cfg.positionsDecodeBoundary) {
                 this.error("Param expected: 'positionsCompressed' should be accompanied by 'positionsDecodeMatrix'/'positionsDecodeBoundary' ('geometryId' is absent)");
-                return null;
+                return false;
             }
             if (cfg.uvCompressed && !cfg.uvDecodeMatrix) {
                 this.error("Param expected: 'uvCompressed' should be accompanied by `uvDecodeMatrix` ('geometryId' is absent)");
-                return null;
+                return false;
             }
             if (!cfg.buckets && !cfg.indices && cfg.primitive !== "points") {
                 this.error(`Param expected: indices (required for '${cfg.primitive}' primitive type)`);
-                return null;
+                return false;
             }
             if ((cfg.matrix || cfg.position || cfg.rotation || cfg.scale) && (cfg.positionsCompressed || cfg.positionsDecodeBoundary)) {
                 this.error("Unexpected params: 'matrix', 'rotation', 'scale', 'position' not allowed with 'positionsCompressed'");
-                return null;
+                return false;
             }
 
             const useDTX = (!!this._dtxEnabled && (cfg.primitive === "triangles"
@@ -2940,7 +2939,7 @@ export class SceneModel extends Component {
                     cfg.textureSet = this._textureSets[cfg.textureSetId];
                     if (!cfg.textureSet) {
                         this.error(`[createMesh] Texture set not found: ${cfg.textureSetId} - ensure that you create it first with createTextureSet()`);
-                        return;
+                        return false;
                     }
                 }
             }
@@ -2951,13 +2950,13 @@ export class SceneModel extends Component {
 
             if (cfg.positions || cfg.positionsCompressed || cfg.indices || cfg.edgeIndices || cfg.normals || cfg.normalsCompressed || cfg.uv || cfg.uvCompressed || cfg.positionsDecodeMatrix) {
                 this.error(`Mesh geometry parameters not expected when instancing a geometry (not expected: positions, positionsCompressed, indices, edgeIndices, normals, normalsCompressed, uv, uvCompressed, positionsDecodeMatrix)`);
-                return;
+                return false;
             }
 
             cfg.geometry = this._geometries[cfg.geometryId];
             if (!cfg.geometry) {
                 this.error(`[createMesh] Geometry not found: ${cfg.geometryId} - ensure that you create it first with createGeometry()`);
-                return;
+                return false;
             }
 
             cfg.origin = cfg.origin ? math.addVec3(this._origin, cfg.origin, math.vec3()) : this._origin;
@@ -2971,7 +2970,7 @@ export class SceneModel extends Component {
 
                 if (!cfg.transform) {
                     this.error(`[createMesh] Transform not found: ${cfg.transformId} - ensure that you create it first with createTransform()`);
-                    return;
+                    return false;
                 }
 
                 cfg.aabb = cfg.geometry.aabb;
@@ -3039,7 +3038,7 @@ export class SceneModel extends Component {
                     cfg.textureSet = this._textureSets[cfg.textureSetId];
                     // if (!cfg.textureSet) {
                     //     this.error(`[createMesh] Texture set not found: ${cfg.textureSetId} - ensure that you create it first with createTextureSet()`);
-                    //     return;
+                    //     return false;
                     // }
                 }
             }
@@ -3047,7 +3046,9 @@ export class SceneModel extends Component {
 
         cfg.numPrimitives = this._getNumPrimitives(cfg);
 
-        return this._createMesh(cfg);
+        this._meshesCfgsBeforeMeshCreation[cfg.id] = cfg;
+
+        return true;
     }
 
     _createMesh(cfg) {
@@ -3079,8 +3080,6 @@ export class SceneModel extends Component {
             cfg.meshMatrix = cfg.transform.worldMatrix;
         }
         mesh.portionId = mesh.layer.createPortion(mesh, cfg);
-        this._meshes[cfg.id] = mesh;
-        this._meshList.push(mesh);
         return mesh;
     }
 
@@ -3439,10 +3438,15 @@ export class SceneModel extends Component {
         let meshes = [];
         for (let i = 0, len = cfg.meshIds.length; i < len; i++) {
             const meshId = cfg.meshIds[i];
-            const mesh = this._meshes[meshId];
-            if (!mesh) {
-                this.error(`Mesh with this ID not found: "${meshId}" - ignoring this mesh`);
-                continue;
+            let mesh = this._meshes[meshId]; // Trying to get already created mesh
+            if (!mesh) { // Checks if there is already created mesh for this meshId
+                let meshCfg = this._meshesCfgsBeforeMeshCreation[meshId]; // Trying to get already created cfg
+                if (!meshCfg) { // Checks if there is already created cfg for this meshId
+                    this.error(`Mesh with this ID not found: "${meshId}" - ignoring this mesh`); // There is no such cfg
+                    continue;
+                }
+                mesh = this._createMesh(meshCfg) // There is no such mesh yet, but there is already created cfg, so it creates this mesh
+                this._meshes[cfg.id] = mesh; // Now it will also add this mesh to dictionary of created meshes
             }
             if (mesh.parent) {
                 this.error(`Mesh with ID "${meshId}" already belongs to object with ID "${mesh.parent.id}" - ignoring this mesh`);

package/types/plugins/TreeViewPlugin/TreeViewNode.d.ts

@@ -6,7 +6,6 @@ export declare class TreeViewNode {
    * Globally unique node ID.
    *
    * @type {String}
-   * @abstract
    */
   get nodeId(): string;
 
@@ -14,7 +13,6 @@ export declare class TreeViewNode {
    * Title of the TreeViewNode.
    *
    * @type {String}
-   * @abstract
    */
   get title(): string;
 
@@ -23,51 +21,51 @@ export declare class TreeViewNode {
    *
    * This is only defined if the TreeViewNode represents an object.
    *
-   * @type {Number|String}
-   * @abstract
+   * @type {String}
+   */
+  get objectId(): string;
+
+  /**
+   * Type of the corresponding {@link MetaObject}.
+   *
+   * @type {String}
    */
-  get objectId(): string | number;
+  get type(): string;
 
   /**
    * The child TreeViewNodes.
    *
    * @type {Array}
-   * @abstract
    */
   get children(): any[];
 
   /** The parent TreeViewNode.
    *
-   * @type {TreeViewNode}
-   * @abstract
+   * @type {TreeViewNode|null}
    */
-  get parent(): TreeViewNode;
+  get parent(): TreeViewNode | null;
 
   /** The number of {@link Entity}s within the subtree of this TreeViewNode.
    *
    * @type {Number}
-   * @abstract
    */
   get numEntities(): number;
 
   /** The number of {@link Entity}s that are currently visible within the subtree of this TreeViewNode.
    *
    * @type {Number}
-   * @abstract
    */
   get numVisibleEntities(): number;
 
   /** Whether or not the TreeViewNode is currently checked.
    *
    * @type {Boolean}
-   * @abstract
    */
   get checked(): boolean;
 
   /** Whether or not the TreeViewNode is currently xrayed.
    *
    * @type {Boolean}
-   * @abstract
    */
-     get xrayed(): boolean;
+  get xrayed(): boolean;
 }

package/types/plugins/TreeViewPlugin/renderService.d.ts

@@ -72,7 +72,7 @@ export declare interface ITreeViewRenderService {
    *
    * @returns {String} The node id.
    */
-  getId(element: HTMLElement): string;
+  getId(element: HTMLElement): string | undefined;
 
   /**
    * Returns the node id from the checkbox element.
@@ -90,7 +90,7 @@ export declare interface ITreeViewRenderService {
    *
    * @returns {HTMLElement} The expand/collapse element.
    */
-  getSwitchElement(nodeId: string): HTMLElement
+  getSwitchElement(nodeId: string): HTMLElement | null;
 
   /**
    * Returns the node's checkbox state.

package/types/viewer/scene/models/SceneModel.d.ts

@@ -1,8 +1,8 @@
-import {Component} from "../Component";
-import {SceneModelEntity} from "./SceneModelEntity";
-import {EdgeMaterial, EmphasisMaterial} from "../materials";
-import {SceneModelMesh} from "./SceneModelMesh";
-import {SceneModelTextureSet} from "./SceneModelTextureSet";
+import { Component } from "../Component";
+import { SceneModelEntity } from "./SceneModelEntity";
+import { EdgeMaterial, EmphasisMaterial } from "../materials";
+import { SceneModelMesh } from "./SceneModelMesh";
+import { SceneModelTextureSet } from "./SceneModelTextureSet";
 
 /**
  * A high-performance model representation for efficient rendering and low memory usage.
@@ -168,6 +168,16 @@ export declare class SceneModel extends Component {
      */
     get aabb(): number[];
 
+
+    get numEntities(): number;
+
+    /**
+     * The number of entities in this SceneModel.
+     *
+     * @type {number}
+     */
+    get numEntities(): number;
+
     /**
      * The approximate number of triangle primitives in this SceneModel.
      *
@@ -297,7 +307,7 @@ export declare class SceneModel extends Component {
      *
      * @type {Boolean}
      */
-    set clippable(clippable: boolean) ;
+    set clippable(clippable: boolean);
 
     /**
      * Gets if this SceneModel is collidable.
@@ -395,7 +405,7 @@ export declare class SceneModel extends Component {
      *
      * @type {Boolean}
      */
-    set receivesShadow(receivesShadow: boolean) ;
+    set receivesShadow(receivesShadow: boolean);
 
     /**
      * Gets if Scalable Ambient Obscurance (SAO) will apply to this SceneModel.