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

package/src/viewer/scene/model/vbo/trianglesInstancing/renderers/TrianglesInstancingPickMeshRenderer.js

@@ -8,7 +8,7 @@ class TrianglesInstancingPickMeshRenderer extends VBOSceneModelTriangleInstancin
     _buildVertexShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing geometry picking vertex shader");
@@ -84,7 +84,7 @@ class TrianglesInstancingPickMeshRenderer extends VBOSceneModelTriangleInstancin
     _buildFragmentShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Batched geometry picking fragment shader");
@@ -104,7 +104,7 @@ class TrianglesInstancingPickMeshRenderer extends VBOSceneModelTriangleInstancin
         if (clipping) {
             src.push("in vec4 vWorldPosition;");
             src.push("in float vFlags;");
-            for (let i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (let i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("uniform bool sectionPlaneActive" + i + ";");
                 src.push("uniform vec3 sectionPlanePos" + i + ";");
                 src.push("uniform vec3 sectionPlaneDir" + i + ";");
@@ -117,7 +117,7 @@ class TrianglesInstancingPickMeshRenderer extends VBOSceneModelTriangleInstancin
             src.push("  bool clippable = (int(vFlags) >> 16 & 0xF) == 1;");
             src.push("  if (clippable) {");
             src.push("  float dist = 0.0;");
-            for (let i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (let i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("if (sectionPlaneActive" + i + ") {");
                 src.push("   dist += clamp(dot(-sectionPlaneDir" + i + ".xyz, vWorldPosition.xyz - sectionPlanePos" + i + ".xyz), 0.0, 1000.0);");
                 src.push("}");

package/src/viewer/scene/model/vbo/trianglesInstancing/renderers/TrianglesInstancingPickNormalsFlatRenderer.js

@@ -9,7 +9,7 @@ class TrianglesInstancingPickNormalsFlatRenderer extends VBOSceneModelTriangleIn
     _buildVertexShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing geometry normals vertex shader");
@@ -76,7 +76,7 @@ class TrianglesInstancingPickNormalsFlatRenderer extends VBOSceneModelTriangleIn
     _buildFragmentShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Batched geometry normals fragment shader");
@@ -97,7 +97,7 @@ class TrianglesInstancingPickNormalsFlatRenderer extends VBOSceneModelTriangleIn
         src.push("in vec4 vWorldPosition;");
         if (clipping) {
             src.push("in float vFlags;");
-            for (let i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (let i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("uniform bool sectionPlaneActive" + i + ";");
                 src.push("uniform vec3 sectionPlanePos" + i + ";");
                 src.push("uniform vec3 sectionPlaneDir" + i + ";");
@@ -109,7 +109,7 @@ class TrianglesInstancingPickNormalsFlatRenderer extends VBOSceneModelTriangleIn
             src.push("  bool clippable = (int(vFlags) >> 16 & 0xF) == 1;");
             src.push("  if (clippable) {");
             src.push("  float dist = 0.0;");
-            for (var i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (var i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("if (sectionPlaneActive" + i + ") {");
                 src.push("   dist += clamp(dot(-sectionPlaneDir" + i + ".xyz, vWorldPosition.xyz - sectionPlanePos" + i + ".xyz), 0.0, 1000.0);");
                 src.push("}");

package/src/viewer/scene/model/vbo/trianglesInstancing/renderers/TrianglesInstancingPickNormalsRenderer.js

@@ -9,7 +9,7 @@ class TrianglesInstancingPickNormalsRenderer extends VBOSceneModelTriangleInstan
     _buildVertexShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing geometry normals vertex shader");
@@ -90,7 +90,7 @@ class TrianglesInstancingPickNormalsRenderer extends VBOSceneModelTriangleInstan
     _buildFragmentShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Batched geometry normals fragment shader");
@@ -114,7 +114,7 @@ class TrianglesInstancingPickNormalsRenderer extends VBOSceneModelTriangleInstan
         if (clipping) {
             src.push("in vec4 vWorldPosition;");
             src.push("in float vFlags;");
-            for (let i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (let i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("uniform bool sectionPlaneActive" + i + ";");
                 src.push("uniform vec3 sectionPlanePos" + i + ";");
                 src.push("uniform vec3 sectionPlaneDir" + i + ";");
@@ -127,7 +127,7 @@ class TrianglesInstancingPickNormalsRenderer extends VBOSceneModelTriangleInstan
             src.push("  bool clippable = (int(vFlags) >> 16 & 0xF) == 1;");
             src.push("  if (clippable) {");
             src.push("  float dist = 0.0;");
-            for (var i = 0; i < sectionPlanesState.sectionPlanes.length; i++) {
+            for (var i = 0; i < sectionPlanesState.getNumAllocatedSectionPlanes(); i++) {
                 src.push("if (sectionPlaneActive" + i + ") {");
                 src.push("   dist += clamp(dot(-sectionPlaneDir" + i + ".xyz, vWorldPosition.xyz - sectionPlanePos" + i + ".xyz), 0.0, 1000.0);");
                 src.push("}");

package/src/viewer/scene/model/vbo/trianglesInstancing/renderers/TrianglesInstancingShadowRenderer.js

@@ -9,7 +9,7 @@ class TrianglesInstancingShadowRenderer extends VBOSceneModelTriangleInstancingR
     _buildVertexShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing geometry shadow drawing vertex shader");
@@ -58,7 +58,7 @@ class TrianglesInstancingShadowRenderer extends VBOSceneModelTriangleInstancingR
     _buildFragmentShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing geometry depth drawing fragment shader");
@@ -77,7 +77,7 @@ class TrianglesInstancingShadowRenderer extends VBOSceneModelTriangleInstancingR
         if (clipping) {
             src.push("in vec4 vWorldPosition;");
             src.push("in float vFlags;");
-            for (let i = 0, len = sectionPlanesState.sectionPlanes.length; i < len; i++) {
+            for (let i = 0, len = sectionPlanesState.getNumAllocatedSectionPlanes(); i < len; i++) {
                 src.push("uniform bool sectionPlaneActive" + i + ";");
                 src.push("uniform vec3 sectionPlanePos" + i + ";");
                 src.push("uniform vec3 sectionPlaneDir" + i + ";");
@@ -93,7 +93,7 @@ class TrianglesInstancingShadowRenderer extends VBOSceneModelTriangleInstancingR
             src.push("  bool clippable = (int(vFlags) >> 16 & 0xF) == 1;");
             src.push("  if (clippable) {");
             src.push("  float dist = 0.0;");
-            for (let i = 0, len = sectionPlanesState.sectionPlanes.length; i < len; i++) {
+            for (let i = 0, len = sectionPlanesState.getNumAllocatedSectionPlanes(); i < len; i++) {
                 src.push("if (sectionPlaneActive" + i + ") {");
                 src.push("   dist += clamp(dot(-sectionPlaneDir" + i + ".xyz, vWorldPosition.xyz - sectionPlanePos" + i + ".xyz), 0.0, 1000.0);");
                 src.push("}");

package/src/viewer/scene/model/vbo/trianglesInstancing/renderers/TrianglesInstancingSilhouetteRenderer.js

@@ -13,7 +13,7 @@ class TrianglesInstancingSilhouetteRenderer extends VBOSceneModelTriangleInstanc
     _buildVertexShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing silhouette vertex shader");
@@ -88,7 +88,7 @@ class TrianglesInstancingSilhouetteRenderer extends VBOSceneModelTriangleInstanc
     _buildFragmentShader() {
         const scene = this._scene;
         const sectionPlanesState = scene._sectionPlanesState;
-        const clipping = sectionPlanesState.sectionPlanes.length > 0;
+        const clipping = sectionPlanesState.getNumAllocatedSectionPlanes() > 0;
         const src = [];
         src.push("#version 300 es");
         src.push("// Instancing fill fragment shader");
@@ -108,7 +108,7 @@ class TrianglesInstancingSilhouetteRenderer extends VBOSceneModelTriangleInstanc
         if (clipping) {
             src.push("in vec4 vWorldPosition;");
             src.push("in float vFlags;");
-            for (let i = 0, len = sectionPlanesState.sectionPlanes.length; i < len; i++) {
+            for (let i = 0, len = sectionPlanesState.getNumAllocatedSectionPlanes(); i < len; i++) {
                 src.push("uniform bool sectionPlaneActive" + i + ";");
                 src.push("uniform vec3 sectionPlanePos" + i + ";");
                 src.push("uniform vec3 sectionPlaneDir" + i + ";");
@@ -121,7 +121,7 @@ class TrianglesInstancingSilhouetteRenderer extends VBOSceneModelTriangleInstanc
             src.push("  bool clippable = (int(vFlags) >> 16 & 0xF) == 1;");
             src.push("  if (clippable) {");
             src.push("  float dist = 0.0;");
-            for (let i = 0, len = sectionPlanesState.sectionPlanes.length; i < len; i++) {
+            for (let i = 0, len = sectionPlanesState.getNumAllocatedSectionPlanes(); i < len; i++) {
                 src.push("if (sectionPlaneActive" + i + ") {");
                 src.push("   dist += clamp(dot(-sectionPlaneDir" + i + ".xyz, vWorldPosition.xyz - sectionPlanePos" + i + ".xyz), 0.0, 1000.0);");
                 src.push("}");

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

@@ -338,8 +338,13 @@ class Scene extends Component {
      * @param {Viewer} viewer The Viewer this Scene belongs to.
      * @param {Object} cfg Scene configuration.
      * @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 {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
+     * 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
+     * your expected usage.
      * @throws {String} Throws an exception when both canvasId or canvasElement are missing or they aren't pointing to a valid HTMLCanvasElement.
      */
     constructor(viewer, cfg = {}) {
@@ -362,6 +367,8 @@ class Scene extends Component {
 
         this._aabbDirty = true;
 
+        this._numPreallocatedSectionPlanes = cfg.numPreallocatedSectionPlanes || 0;
+
         /**
          * The {@link Viewer} this Scene belongs to.
          * @type {Viewer}
@@ -624,6 +631,8 @@ class Scene extends Component {
             alphaDepthMask: alphaDepthMask
         });
 
+        const numPreallocatedSectionPlanes = this._numPreallocatedSectionPlanes;
+
         this._sectionPlanesState = new (function () {
 
             this.sectionPlanes = [];
@@ -636,14 +645,15 @@ class Scene extends Component {
                 if (hash) {
                     return hash;
                 }
+                const numAllocatedSectionPlanes = this.getNumAllocatedSectionPlanes();
                 const sectionPlanes = this.sectionPlanes;
-                if (sectionPlanes.length === 0) {
+                if (numAllocatedSectionPlanes === 0) {
                     return this.hash = ";";
                 }
                 let sectionPlane;
 
                 const hashParts = [];
-                for (let i = 0, len = sectionPlanes.length; i < len; i++) {
+                for (let i = 0, len = numAllocatedSectionPlanes; i < len; i++) {
                     sectionPlane = sectionPlanes[i];
                     hashParts.push("cp");
                 }
@@ -666,6 +676,11 @@ class Scene extends Component {
                     }
                 }
             };
+
+            this.getNumAllocatedSectionPlanes = function () {
+                const num = this.sectionPlanes.length;
+                return (num > numPreallocatedSectionPlanes) ? num : numPreallocatedSectionPlanes;
+            };
         })();
 
         this._lightsState = new (function () {
@@ -2588,12 +2603,12 @@ class Scene extends Component {
 
     /**
      * This method will "tickify" the provided `cb` function.
-     * 
+     *
      * This means, the function will be wrapped so:
-     * 
+     *
      * - it runs time-aligned to scene ticks
      * - it runs maximum once per scene-tick
-     * 
+     *
      * @param {Function} cb The function to tickify
      * @returns {Function)}
      */
@@ -2614,7 +2629,7 @@ class Scene extends Component {
 
         /**
          * The provided `cb` function is replaced with a "set-dirty" function
-         * 
+         *
          * @type {Function}
          */
         const wrapperFunc = function (...args) {
@@ -2624,7 +2639,7 @@ class Scene extends Component {
 
         /**
          * An each scene tick, if the "dirty-flag" is set, run the `cb` function.
-         * 
+         *
          * This will make it run time-aligned to the scene tick.
          */
         const tickSubId = this.on("tick", () => {
@@ -2638,7 +2653,7 @@ class Scene extends Component {
         /**
          * And, store the list of subscribers.
          */
-        this._tickifiedFunctions[cbString] = { tickSubId, wrapperFunc };
+        this._tickifiedFunctions[cbString] = {tickSubId, wrapperFunc};
 
         return wrapperFunc;
     }

package/src/viewer/scene/sectionPlane/SectionPlaneCache.js

@@ -0,0 +1,101 @@
+import {Component} from '../Component.js';
+import {math} from "../math/math.js";
+import {SectionPlane} from "./SectionPlane";
+
+const tempVec3a = math.vec3();
+
+/**
+ *  @desc A set of arbitrarily-aligned World-space clipping planes.
+
+ */
+export class SectionPlaneCache extends Component {
+
+    constructor(owner, cfg = {}) {
+        super(owner, cfg);
+
+        this._sectionPlanesMap = {};
+        this._sectionPlanesState = {};
+
+        if (cfg.size) {
+            for (let i = 0, len = cfg.size; i < len; i++) {
+                const sectionPlane = new SectionPlane(this.viewer.scene, {
+                    id: math.createUUID(),
+                    pos: [0, 0, 0],
+                    dir: [0, -1, 0],
+                    active: false
+                });
+                this._sectionPlanesMap[sectionPlane.id] = sectionPlane;
+                this._sectionPlanesState[sectionPlane.id] = {
+                    sectionPlane: sectionPlane,
+                    used: false
+                };
+            }
+        }
+    }
+
+    getSectionPlane(params = {}) {
+        for (let id in this._sectionPlanesState) {
+            const state = this._sectionPlanesState[id];
+            if (!state.used) {
+                state.used = true;
+                const sectionPlane = state.sectionPlane;
+                sectionPlane.active = true;
+                sectionPlane.pos = params.pos;
+                sectionPlane.dir = params.dir;
+                return sectionPlane;
+            }
+        }
+        const sectionPlane = new SectionPlane(this.viewer.scene, {
+            id: params.id, // Optional
+            pos: params.pos,
+            dir: params.dir,
+            active: true
+        });
+        this._sectionPlanesState[sectionPlane.id] = {
+            sectionPlane: sectionPlane,
+            used: true
+        };
+        return sectionPlane;
+    }
+
+    putSectionPlane(sectionPlane) {
+        let state = this._sectionPlanesState[sectionPlane.id];
+        sectionPlane.active = false;
+        if (state) {
+            state.used = false;
+            return;
+        }
+        this._sectionPlanesState[sectionPlane.id] = {
+            sectionPlane: sectionPlane,
+            used: false
+        };
+    }
+
+    putAllSectionPlanes() {
+        for (let id in this._sectionPlanesState) {
+            const state = this._sectionPlanesState[id];
+            state.used = false;
+            state.sectionPlane.active = false;
+        }
+    }
+
+    getSectionPlanesInUse() {
+        const sectionPlanes = [];
+        for (let id in this._sectionPlanesState) {
+            const state = this._sectionPlanesState[id];
+            if (state.used) {
+                sectionPlanes.push(state.sectionPlane);
+            }
+        }
+        return sectionPlanes;
+    }
+
+    /**
+     * @destroy
+     */
+    destroy() {
+        this.scene._sectionPlaneDestroyed(this);
+        super.destroy();
+    }
+}
+