@xeokit/xeokit-sdk 2.4.2-beta-22 → 2.4.2-beta-24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.4.2-beta-22",
+  "version": "2.4.2-beta-24",
   "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/viewer/Viewer.js

@@ -57,7 +57,7 @@ class Viewer {
      * store geometry on the GPU for triangle meshes that don't have textures. This gives a much lower memory footprint for these types of model element. This mode may not perform well on low-end GPUs that are optimized
      * to use textures to hold geometry data. Works great on most medium/high-end GPUs found in desktop computers, including the nVIDIA and Intel HD chipsets. Set this false to use the default vertex buffer object (VBO)
      * mode for storing geometry, which is the standard technique used in most graphics engines, and will work adequately on most low-end GPUs.
-     * @param {number} [cfg.numPreallocatedSectionPlanes=0] Enhances the efficiency of SectionPlane creation by proactively allocating Viewer resources for a specified quantity
+     * @param {number} [cfg.numCachedSectionPlanes=0] Enhances the efficiency of SectionPlane creation by proactively allocating Viewer resources for a specified quantity
      * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
      * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
      * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
@@ -120,7 +120,7 @@ class Viewer {
             pbrEnabled: (!!cfg.pbrEnabled),
             colorTextureEnabled: (cfg.colorTextureEnabled !== false),
             dtxEnabled: (!!cfg.dtxEnabled),
-            numPreallocatedSectionPlanes: cfg.numPreallocatedSectionPlanes
+            numCachedSectionPlanes: cfg.numCachedSectionPlanes
         });
 
         /**

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureDepthRenderer.js

@@ -185,7 +185,7 @@ export class TrianglesDataTextureDepthRenderer {
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
 
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureEdgesColorRenderer.js

@@ -86,7 +86,7 @@ export class TrianglesDataTextureEdgesColorRenderer {
         gl.uniformMatrix4fv(this._uViewMatrix, false, rtcViewMatrix);
         gl.uniformMatrix4fv(this._uProjMatrix, false, camera.projMatrix);
 
-        const numSectionPlanes = scene._sectionPlanesState.sectionPlanes.length;
+        const numSectionPlanes = scene.getMaxSectionPlanes();
         if (numSectionPlanes > 0) {
             const sectionPlanes = scene._sectionPlanesState.sectionPlanes;
             const baseIndex = dataTextureLayer.layerIndex * numSectionPlanes;

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureEdgesRenderer.js

@@ -193,7 +193,7 @@ export class TrianglesDataTextureEdgesRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTexturePickMeshRenderer.js

@@ -166,7 +166,7 @@ export class TrianglesDataTexturePickMeshRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTexturePickNormalsFlatRenderer.js

@@ -182,7 +182,7 @@ export class TrianglesDataTexturePickNormalsFlatRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureSilhouetteRenderer.js

@@ -203,7 +203,7 @@ export class TrianglesDataTextureSilhouetteRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureSnapDepthBufInitRenderer.js

@@ -190,7 +190,7 @@ export class TrianglesDataTextureSnapDepthBufInitRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/model/dtx/triangles/renderers/TrianglesDataTextureSnapDepthRenderer.js

@@ -196,7 +196,7 @@ export class TrianglesDataTextureSnapDepthRenderer {
         this._uViewMatrix = program.getLocation("viewMatrix");
         this._uProjMatrix = program.getLocation("projMatrix");
         this._uSectionPlanes = [];
-        for (let i = 0, len = scene._sectionPlanesState.sectionPlanes.length; i < len; i++) {
+        for (let i = 0, len = scene.getMaxSectionPlanes(); i < len; i++) {
             this._uSectionPlanes.push({
                 active: program.getLocation("sectionPlaneActive" + i),
                 pos: program.getLocation("sectionPlanePos" + i),

package/src/viewer/scene/scene/Scene.js

@@ -340,7 +340,7 @@ class Scene extends Component {
      * @param {String} [cfg.canvasId]  ID of an existing HTML canvas for the {@link Scene#canvas} - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID.
      * @param {HTMLCanvasElement} [cfg.canvasElement] Reference of an existing HTML canvas for the {@link Scene#canvas} - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID.
      * @param {HTMLElement} [cfg.keyboardEventsElement] Optional reference to HTML element on which key events should be handled. Defaults to the HTML Document.
-     * @param {number} [cfg.numPreallocatedSectionPlanes=0] Enhances the efficiency of SectionPlane creation by proactively allocating Viewer resources for a specified quantity
+     * @param {number} [cfg.numCachedSectionPlanes=0] Enhances the efficiency of SectionPlane creation by proactively allocating Viewer resources for a specified quantity
      * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
      * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
      * responsiveness. It is important to consider that each SectionPlane imposes rendering performance, so it is recommended to set this value to a quantity that aligns with
@@ -367,8 +367,6 @@ class Scene extends Component {
 
         this._aabbDirty = true;
 
-        this._numPreallocatedSectionPlanes = cfg.numPreallocatedSectionPlanes || 0;
-
         /**
          * The {@link Viewer} this Scene belongs to.
          * @type {Viewer}
@@ -631,14 +629,14 @@ class Scene extends Component {
             alphaDepthMask: alphaDepthMask
         });
 
-        const numPreallocatedSectionPlanes = this._numPreallocatedSectionPlanes;
-
         this._sectionPlanesState = new (function () {
 
             this.sectionPlanes = [];
 
             this.clippingCaps = false;
 
+            this._numCachedSectionPlanes = 0;
+
             let hash = null;
 
             this.getHash = function () {
@@ -677,12 +675,23 @@ class Scene extends Component {
                 }
             };
 
+            this.setNumCachedSectionPlanes = function(numCachedSectionPlanes) {
+                this._numCachedSectionPlanes = numCachedSectionPlanes;
+                hash = null;
+            }
+
+            this.getNumCachedSectionPlanes = function() {
+                return this._numCachedSectionPlanes;
+            }
+
             this.getNumAllocatedSectionPlanes = function () {
                 const num = this.sectionPlanes.length;
-                return (num > numPreallocatedSectionPlanes) ? num : numPreallocatedSectionPlanes;
+                return (num > this._numCachedSectionPlanes) ? num : this._numCachedSectionPlanes;
             };
         })();
 
+        this._sectionPlanesState.setNumCachedSectionPlanes(cfg.numCachedSectionPlanes || 0);
+
         this._lightsState = new (function () {
 
             const DEFAULT_AMBIENT = math.vec4([0, 0, 0, 0]);
@@ -1258,12 +1267,44 @@ class Scene extends Component {
         return this._logarithmicDepthBufferEnabled;
     }
 
+    /**
+     * Sets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
+     *
+     * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
+     * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
+     * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
+     * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
+     * your expected usage.
+     *
+     * Default is ````0````.
+     */
+    set numCachedSectionPlanes(numCachedSectionPlanes) {
+        this._sectionPlanesState.setNumCachedSectionPlanes(numCachedSectionPlanes || 0);
+        this._needRecompile = true;
+        this.glRedraw();
+    }
+
+    /**
+     * Gets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
+     *
+     * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
+     * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
+     * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
+     * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
+     * your expected usage.
+     *
+     * Default is ````0````.
+     *
+     * @returns {number} The number of {@link SectionPlane}s for which this Scene pre-caches resources.
+     */
+    get numCachedSectionPlanes() {
+        return this._sectionPlanesState.getNumCachedSectionPlanes();
+    }
+
     /**
      * Sets whether physically-based rendering is enabled.
      *
      * Default is ````false````.
-     *
-     * @returns {Boolean} True if quality rendering is enabled.
      */
     set pbrEnabled(pbrEnabled) {
         this._pbrEnabled = !!pbrEnabled;