@xeokit/xeokit-sdk 2.4.0-alpha-81 → 2.4.0-alpha-83

package/src/viewer/scene/webgl/RenderFlags.js

@@ -0,0 +1,203 @@
+/**
+ * Indicates what rendering needs to be done for the layers within a {@link Drawable}.
+ *
+ * Each Drawable has a RenderFlags in {@link Drawable#renderFlags}.
+ *
+ * Before rendering each frame, {@link Renderer} will call {@link Drawable#rebuildRenderFlags} on each {@link Drawable}.
+ *
+ * Then, when rendering a frame, Renderer will apply rendering passes to each Drawable according on what flags are set in {@link Drawable#renderFlags}.
+ *
+ * @private
+ */
+class RenderFlags {
+
+    /**
+     * @private
+     */
+    constructor() {
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate which layers are visible within the {@link Drawable}.
+         *
+         * This is a list of IDs of visible layers within the {@link Drawable}. The IDs will be whatever the
+         * {@link Drawable} uses to identify its layers, usually integers.
+         *
+         * @property visibleLayers
+         * @type {Number[]}
+         */
+        this.visibleLayers = [];
+
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate which {@link SectionPlane}s are active within each layer of the {@link Drawable}.
+         *
+         * Layout is as follows:
+         *
+         * ````[
+         *      false, false, true, // Layer 0, SectionPlanes 0, 1, 2
+         *      false, true, true,  // Layer 1, SectionPlanes 0, 1, 2
+         *      true, false, true   // Layer 2, SectionPlanes 0, 1, 2
+         * ]````
+         *
+         * @property sectionPlanesActivePerLayer
+         * @type {Boolean[]}
+         */
+        this.sectionPlanesActivePerLayer = [];
+
+        this.reset();
+    }
+
+    /**
+     * @private
+     */
+    reset() {
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate whether the {@link Drawable} is culled.
+         * 
+         * When this is ````false````, then all of the other properties on ````RenderFlags```` will remain at their default values.
+         * 
+         * @property culled
+         * @type {Boolean}
+         */
+        this.culled = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate whether the {@link Drawable} is sliced by any {@link SectionPlane}s.
+         *
+         * @property sectioned
+         * @type {Boolean}
+         */
+        this.sectioned  = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the number of layers within the {@link Drawable}.
+         *
+         * @property numLayers
+         * @type {Number}
+         */
+        this.numLayers = 0;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the number of visible layers within the {@link Drawable}.
+         *
+         * @property numVisibleLayers
+         * @type {Number}
+         */
+        this.numVisibleLayers = 0;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs {@link Drawable#drawColorOpaque}.
+         * @property colorOpaque
+         * @type {boolean}
+         */
+        this.colorOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs {@link Drawable#drawColorTransparent}.
+         * @property colorTransparent
+         * @type {boolean}
+         */
+        this.colorTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs {@link Drawable#drawEdgesColorOpaque}.
+         * @property edgesOpaque
+         * @type {boolean}
+         */
+        this.edgesOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs {@link Drawable#drawEdgesColorTransparent}.
+         * @property edgesTransparent
+         * @type {boolean}
+         */
+        this.edgesTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawSilhouetteXRayed}.
+         * @property xrayedSilhouetteOpaque
+         * @type {boolean}
+         */
+        this.xrayedSilhouetteOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawEdgesXRayed}.
+         * @property xrayedEdgesOpaque
+         * @type {boolean}
+         */
+        this.xrayedEdgesOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawSilhouetteXRayed}.
+         * @property xrayedSilhouetteTransparent
+         * @type {boolean}
+         */
+        this.xrayedSilhouetteTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawEdgesXRayed}.
+         * @property xrayedEdgesTransparent
+         * @type {boolean}
+         */
+        this.xrayedEdgesTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawSilhouetteHighlighted}.
+         * @property highlightedSilhouetteOpaque
+         * @type {boolean}
+         */
+        this.highlightedSilhouetteOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawEdgesHighlighted}.
+         * @property highlightedEdgesOpaque
+         * @type {boolean}
+         */
+        this.highlightedEdgesOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawSilhouetteHighlighted}.
+         * @property highlightedSilhouetteTransparent
+         * @type {boolean}
+         */
+        this.highlightedSilhouetteTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawEdgesHighlighted}.
+         * @property highlightedEdgesTransparent
+         * @type {boolean}
+         */
+        this.highlightedEdgesTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawSilhouetteSelected}.
+         * @property selectedSilhouetteOpaque
+         * @type {boolean}
+         */
+        this.selectedSilhouetteOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs an opaque {@link Drawable#drawEdgesSelected}.
+         * @property selectedEdgesOpaque
+         * @type {boolean}
+         */
+        this.selectedEdgesOpaque = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawSilhouetteSelected}.
+         * @property selectedSilhouetteTransparent
+         * @type {boolean}
+         */
+        this.selectedSilhouetteTransparent = false;
+
+        /**
+         * Set by {@link Drawable#rebuildRenderFlags} to indicate the {@link Drawable} needs a transparent {@link Drawable#drawEdgesSelected}.
+         * @property selectedEdgesTransparent
+         * @type {boolean}
+         */
+        this.selectedEdgesTransparent = false;
+    }
+}
+
+export {RenderFlags};

package/src/viewer/scene/webgl/RenderState.js

@@ -0,0 +1,40 @@
+import {Map} from "../utils/Map.js";
+
+const ids = new Map({});
+
+/**
+ * @desc Represents a chunk of state changes applied by the {@link Scene}'s renderer while it renders a frame.
+ *
+ * * Contains properties that represent the state changes.
+ * * Has a unique automatically-generated numeric ID, which the renderer can use to sort these, in order to avoid applying redundant state changes for each frame.
+ * * Initialize your own properties on a RenderState via its constructor.
+ *
+ * @private
+ */
+class RenderState {
+
+    constructor(cfg) {
+
+        /**
+         The RenderState's ID, unique within the renderer.
+         @property id
+         @type {Number}
+         @final
+         */
+        this.id = ids.addItem({});
+        for (const key in cfg) {
+            if (cfg.hasOwnProperty(key)) {
+                this[key] = cfg[key];
+            }
+        }
+    }
+
+    /**
+     Destroys this RenderState.
+     */
+    destroy() {
+        ids.removeItem(this.id);
+    }
+}
+
+export {RenderState};