@xeokit/xeokit-sdk 2.6.71 → 2.6.73

package/src/viewer/scene/geometry/ReadableGeometry.js

@@ -613,6 +613,66 @@ class ReadableGeometry extends Geometry {
         return this._obb;
     }
 
+    _getMetrics() {
+        if (! ("_metrics" in this)) {
+            switch (this._state.primitiveName) {
+            case "solid":
+            case "surface":
+            case "triangles": {
+                const indices = this._state.indices;
+                const positions = this._state.positions;
+                const getPos = (i, out) => {
+                    const idx = indices[i] * 3;
+                    for (let j = 0; j < 3; ++j) {
+                        out[j] = positions[idx + j];
+                    };
+                    return out;
+                };
+                const tmp = [ math.vec3(), math.vec3(), math.vec3(), math.vec3() ];
+                let totalArea = 0;
+                const centroid = math.vec3([ 0, 0, 0 ]);
+                for (let i = 0; i < indices.length; i += 3) {
+                    const v0 = getPos(i,   tmp[0]);
+                    const v1 = getPos(i+1, tmp[1]);
+                    const v2 = getPos(i+2, tmp[2]);
+                    math.addVec3(v0, v1, tmp[3]);
+                    math.addVec3(v2, tmp[3], tmp[3]);
+                    const faceArea = math.lenVec3(
+                        math.cross3Vec3(
+                            math.subVec3(v1, v0, tmp[1]),
+                            math.subVec3(v2, v0, tmp[2]),
+                            tmp[0])) / 2;
+                    totalArea += faceArea;
+                    math.mulVec3Scalar(tmp[3], faceArea, tmp[3]);
+                    math.addVec3(centroid, tmp[3], centroid);
+                }
+                this._metrics = { surfaceArea: totalArea, centroid: math.mulVec3Scalar(centroid, 1 / totalArea / 3, centroid) };
+                break;
+            }
+            default:
+                this._metrics = { surfaceArea: 0 };
+                break;
+            }
+        }
+        return this._metrics;
+    }
+
+    /**
+     * Returns the surface area of this Mesh.
+     * @returns {number}
+     */
+    get surfaceArea() {
+        return this._getMetrics().surfaceArea;
+    }
+
+    /**
+     * Returns the centroid of this Mesh.
+     * @returns {number}
+     */
+    get centroid() {
+        return this._getMetrics().centroid;
+    }
+
     /**
      * Approximate number of triangles in this ReadableGeometry.
      *

package/src/viewer/scene/geometry/builders/buildPlaneGeometry.js

@@ -122,7 +122,7 @@ function buildPlaneGeometry(cfg = {}) {
             positions[offset + 1] = centerY;
             positions[offset + 2] = -z + centerZ;
 
-            normals[offset + 2] = -1;
+            normals[offset + 1] = 1;
 
             uvs[offset2] = (ix) / planeX;
             uvs[offset2 + 1] = ((planeZ - iz) / planeZ);

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

@@ -347,13 +347,12 @@ class Scene extends Component {
      * 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.
+     * @throws {String} Throws an exception when  canvasId or canvasElement are missing or they aren't pointing to a valid HTMLCanvasElement.
      */
     constructor(viewer, cfg = {}) {
 
         super(null, cfg);
-
-        const canvas = cfg.canvasElement || document.getElementById(cfg.canvasId);
+        const canvas = cfg.canvasElement || document.querySelector(`#${cfg.canvasId}`);
 
         if (!(canvas instanceof HTMLCanvasElement)) {
             throw "Mandatory config expected: valid canvasId or canvasElement";

package/src/viewer/scene/sectionCaps/SectionCaps.js

@@ -127,8 +127,7 @@ class SectionCaps {
         if(!this._resourcesAllocated) {
             this._resourcesAllocated = true;
             this._sectionPlanes = [];
-            this._verticesMap = {};
-            this._indicesMap = {};
+            this._sceneModelsData = {};
             this._dirtyMap = {};
             this._prevIntersectionModelsMap = {};
             this._sectionPlaneTimeout = null;
@@ -143,7 +142,8 @@ class SectionCaps {
                 this._sectionPlanes.push(sectionPlane);
                 sectionPlane.on('pos', onSectionPlaneUpdated);
                 sectionPlane.on('dir', onSectionPlaneUpdated);
-                sectionPlane.once('destroyed', ((sectionPlane) => {
+                sectionPlane.on('active', onSectionPlaneUpdated);
+                sectionPlane.once('destroyed', (() => {
                     const sectionPlaneId = sectionPlane.id;
                     if (sectionPlaneId) {
                         this._sectionPlanes = this._sectionPlanes.filter((sectionPlane) => sectionPlane.id !== sectionPlaneId);
@@ -160,14 +160,20 @@ class SectionCaps {
 
             this._onTick = this.scene.on("tick", () => {
                 //on ticks we only check if there is a model that we have saved vertices for,
-                //but it's no more available on the scene
-                for(const key in this._verticesMap) {
-                    if(!this.scene.models[key]){
-                        delete this._verticesMap[key];
-                        delete this._indicesMap[key];
-                        this._update();
+                //but it's no more available on the scene, or if its visibility changed
+                let dirty = false;
+                for(const sceneModelId in this._sceneModelsData) {
+                    if(!this.scene.models[sceneModelId]){
+                        delete this._sceneModelsData[sceneModelId];
+                        dirty = true;
+                    } else if (this._sceneModelsData[sceneModelId].visible !== (!!this.scene.models[sceneModelId].visible)) {
+                        this._sceneModelsData[sceneModelId].visible = !!this.scene.models[sceneModelId].visible;
+                        dirty = true;
                     }
                 }
+                if (dirty) {
+                    this._update();
+                }
             })
         }
 
@@ -183,8 +189,8 @@ class SectionCaps {
         this._deletePreviousModels();
         this._updateTimeout = setTimeout(() => {
             clearTimeout(this._updateTimeout);
-            const sceneModels = Object.keys(this.scene.models).map((key) => this.scene.models[key]);
-            this._addHatches(sceneModels, this._sectionPlanes);
+            const sceneModels = Object.values(this.scene.models).filter(sceneModel => sceneModel.visible);
+            this._addHatches(sceneModels, this._sectionPlanes.filter(sectionPlane => sectionPlane.active));
             this._setAllDirty(false);
         }, 100);
     }
@@ -197,21 +203,9 @@ class SectionCaps {
 
     _addHatches(sceneModels, planes) {
 
-        if (planes.length <= 0) return;
-
         planes.forEach((plane) => {
             sceneModels.forEach((sceneModel) => {
-                //#region creating a plane equation
-                //we create a plane equation that will be used to slice through each triangle
-                const planeEquation = {
-                    A: plane.dir[0],
-                    B: plane.dir[1],
-                    C: plane.dir[2],
-                    D: -(plane.dir[0] * plane.pos[0] + plane.dir[1] * plane.pos[1] + plane.dir[2] * plane.pos[2])
-                }
-                //#endregion
-                
-                if(!this._doesPlaneIntersectBoundingBox(sceneModel.aabb, planeEquation)) return;
+                if(!this._doesPlaneIntersectBoundingBox(sceneModel.aabb, plane)) return;
 
                 if(!this._dirtyMap[sceneModel.id]) return;
 
@@ -233,39 +227,35 @@ class SectionCaps {
 
                     const object = objects[objectId];
 
-                    if(!this._doesPlaneIntersectBoundingBox(object.aabb, planeEquation)) return;
+                    if(!this._doesPlaneIntersectBoundingBox(object.aabb, plane)) return;
 
-                    if(!this._verticesMap[sceneModel.id]) {
-                        this._verticesMap[sceneModel.id] = new Map();
-                        this._indicesMap[sceneModel.id] = new Map();
+                    if(!this._sceneModelsData[sceneModel.id]) {
+                        this._sceneModelsData[sceneModel.id] = {
+                            verticesMap: new Map(),
+                            indicesMap:  new Map()
+                        };
                     }
 
-                    let vertices = [], indices = [];
+                    const sceneModelData = this._sceneModelsData[sceneModel.id];
 
-                    if(!this._verticesMap[sceneModel.id].has(objectId)) {
+                    if(!sceneModelData.verticesMap.has(objectId)) {
                         const isSolid = object.meshes[0].isSolid();
+                        const vertices = [ ];
+                        const indices  = [ ];
                         if(isSolid && object.capMaterial) {
-                            object.getEachVertex((_vertices) => {
-                                vertices.push(_vertices[0], _vertices[1], _vertices[2]);
-                            })
-                            object.getEachIndex((_indices) => {
-                                indices.push(_indices);
-                            })
+                            object.getEachVertex(v => vertices.push(v[0], v[1], v[2]));
+                            object.getEachIndex(i  => indices.push(i));
                         }
-                        this._verticesMap[sceneModel.id].set(objectId, vertices);
-                        this._indicesMap[sceneModel.id].set(objectId, indices);
-                    }
-                    else {
-                        vertices = this._verticesMap[sceneModel.id].get(objectId);
-                        indices = this._indicesMap[sceneModel.id].get(objectId);
+                        sceneModelData.verticesMap.set(objectId, vertices);
+                        sceneModelData.indicesMap.set(objectId, indices);
                     }
-                    
+
+                    const vertices = sceneModelData.verticesMap.get(objectId);
+                    const indices  = sceneModelData.indicesMap.get(objectId);
+
                     const capSegments = [];
                     const vertCount = indices.length;
-                    
-                    // Preallocate intersection result array
-                    const intersectionBuffer = new Float32Array(3);
-                    
+
                     for (let i = 0; i < vertCount; i += 3) {
                         // Reuse triangle buffer instead of creating new arrays
                         for (let j = 0; j < 3; j++) {
@@ -282,21 +272,15 @@ class SectionCaps {
                         for (let i = 0; i < 3; i++) {
                             const p1 = triangle[i];
                             const p2 = triangle[(i + 1) % 3];
-                            
-                            // Inline the distance calculations to avoid function calls
-                            const d1 = planeEquation.A * p1[0] + planeEquation.B * p1[1] + planeEquation.C * p1[2] + planeEquation.D;
-                            const d2 = planeEquation.A * p2[0] + planeEquation.B * p2[1] + planeEquation.C * p2[2] + planeEquation.D;
-                            
+
+                            const d1 = plane.dist + math.dotVec3(plane.dir, p1);
+                            const d2 = plane.dist + math.dotVec3(plane.dir, p2);
+
                             if (d1 * d2 > 0) continue;
-                            
+
                             const t = -d1 / (d2 - d1);
-                            // Reuse intersection buffer
-                            intersectionBuffer[0] = p1[0] + t * (p2[0] - p1[0]);
-                            intersectionBuffer[1] = p1[1] + t * (p2[1] - p1[1]);
-                            intersectionBuffer[2] = p1[2] + t * (p2[2] - p1[2]);
-                            
-                            // Clone the buffer for storage
-                            intersections.push(new Float32Array(intersectionBuffer));
+
+                            intersections.push(math.lerpVec3(t, 0, 1, p1, p2, math.vec3()));
                         }
 
                         if(intersections.length === 2) capSegments.push(intersections);
@@ -576,7 +560,7 @@ class SectionCaps {
 
     }
 
-    _doesPlaneIntersectBoundingBox(bb, planeEquation) {
+    _doesPlaneIntersectBoundingBox(bb, plane) {
         const min = [bb[0], bb[1], bb[2]];
         const max = [bb[3], bb[4], bb[5]];
 
@@ -596,10 +580,7 @@ class SectionCaps {
         let hasNegative = false;
 
         for (const corner of corners) {
-            const distance = planeEquation.A * corner[0] +
-                planeEquation.B * corner[1] +
-                planeEquation.C * corner[2] +
-                planeEquation.D;
+            const distance = plane.dist + math.dotVec3(plane.dir, corner);
 
             if (distance > 0) hasPositive = true;
             if (distance < 0) hasNegative = true;

package/types/plugins/NavCubePlugin/NavCubePlugin.d.ts

@@ -159,4 +159,4 @@ export declare class NavCubePlugin extends Plugin {
      * @return {Boolean} True when NavCube projection is synchronized with {@link Camera.projection}.
      */
     getSynchProjection(): boolean;
-}
+}

package/types/viewer/scene/ImagePlane/ImagePlane.d.ts

@@ -0,0 +1,397 @@
+import {Component} from '../Component.js';
+import {Node} from '../nodes/Node.js';
+import {Mesh} from '../mesh/Mesh.js';
+import {Texture} from '../materials/Texture.js';
+
+/**
+ *  @desc A plane-shaped 3D object containing a bitmap image.
+ *
+ * Use ````ImagePlane```` to embed bitmap images in your scenes.
+ *
+ * As shown in the examples below, ````ImagePlane```` is useful for creating ground planes from satellite maps and embedding 2D plan
+ * view images in cross-section slicing planes.
+ *
+ * # Example 1: Create a ground plane from a satellite image
+ *
+ * In our first example, we'll load the Schependomlaan model, then use
+ * an ````ImagePlane```` to create a ground plane, which will contain
+ * a satellite image sourced from Google Maps.
+ *
+ * <img src="http://xeokit.io/img/docs/ImagePlane/schependomlaanGoogleSatMapMed.png">
+ *
+ * [<img src="http://xeokit.io/img/docs/ImagePlane/ImagePlane.png">](https://xeokit.github.io/xeokit-sdk/examples/scenegraph/#ImagePlane_groundPlane)
+ *
+ * [[Run this example](https://xeokit.github.io/xeokit-sdk/examples/scenegraph/#ImagePlane_groundPlane)]
+ *
+ * ````javascript
+ * import {Viewer, ImagePlane, XKTLoaderPlugin} from "xeokit-sdk.es.js";
+ *
+ * const viewer = new Viewer({
+ *      canvasId: "myCanvas",
+ *      transparent: true
+ *  });
+ *
+ * viewer.camera.eye = [-8.31, 42.21, 54.30];
+ * viewer.camera.look = [-0.86, 15.40, 14.90];
+ * viewer.camera.up = [0.10, 0.83, -0.54];
+ *
+ * const xktLoader = new XKTLoaderPlugin(viewer);
+ *
+ * xktLoader.load({             // Load IFC model
+ *      id: "myModel",
+ *      src: "./models/xkt/Schependomlaan.xkt",
+ *      edges: true,
+ *
+ *      rotation: [0, 22, 0],   // Rotate, position and scale the model to align it correctly with the ImagePlane
+ *      position: [-8, 0, 15],
+ *      scale: [1.1, 1.1, 1.1]
+ *  });
+ *
+ * new ImagePlane(viewer.scene, {
+ *      src: "./images/schependomlaanSatMap.png",       // Google satellite image; accepted file types are PNG and JPEG
+ *      visible: true,                                  // Show the ImagePlane
+ *      gridVisible: true,                              // Show the grid - grid is only visible when ImagePlane is also visible
+ *      size: 190,                                      // Size of ImagePlane's longest edge
+ *      position: [0, -1, 0],                           // World-space position of ImagePlane's center
+ *      rotation: [0, 0, 0],                            // Euler angles for X, Y and Z
+ *      opacity: 1.0,                                   // Fully opaque
+ *      collidable: false,                              // ImagePlane does not contribute to Scene boundary
+ *      clippable: true,                                // ImagePlane can be clipped by SectionPlanes
+ *      pickable: true                                  // Allow the ground plane to be picked
+ * });
+ * ````
+ *<br>
+ *
+ * # Example 2: Embed an image in a cross-section plane
+ *
+ * In our second example, we'll load the Schependomlaan model again, then slice it in half with
+ * a {@link SectionPlanesPlugin}, then use an ````ImagePlane```` to embed a 2D plan view image in the slicing plane.
+ *
+ * <img src="http://xeokit.io/img/docs/ImagePlane/schependomlaanPlanViewMed.png">
+ *
+ * [<img src="http://xeokit.io/img/docs/ImagePlane/ImagePlane_planView.png">](https://xeokit.github.io/xeokit-sdk/examples/scenegraph/#ImagePlane_imageInSectionPlane)
+ *
+ * [[Run this example](https://xeokit.github.io/xeokit-sdk/examples/scenegraph/#ImagePlane_imageInSectionPlane)]
+ *
+ * ````javascript
+ * import {Viewer, XKTLoaderPlugin, SectionPlanesPlugin, ImagePlane} from "xeokit-sdk.es.js";
+ *
+ * const viewer = new Viewer({
+ *     canvasId: "myCanvas",
+ *     transparent: true
+ * });
+ *
+ * viewer.camera.eye = [-9.11, 20.01, 5.13];
+ * viewer.camera.look = [9.07, 0.77, -9.78];
+ * viewer.camera.up = [0.47, 0.76, -0.38];
+ *
+ * const xktLoader = new XKTLoaderPlugin(viewer);
+ *
+ * const sectionPlanes = new SectionPlanesPlugin(viewer, {
+ *     overviewVisible: false
+ * });
+ *
+ * model = xktLoader.load({
+ *     id: "myModel",
+ *     src: "./models/xkt/schependomlaan/schependomlaan.xkt",
+ *     metaModelSrc: "./metaModels/schependomlaan/metaModel.json",
+ *     edges: true,
+ * });
+ *
+ * const sectionPlane = sectionPlanes.createSectionPlane({
+ *     id: "mySectionPlane",
+ *     pos: [10.95, 1.95, -10.35],
+ *     dir: [0.0, -1.0, 0.0]
+ * });
+ *
+ * const imagePlane = new ImagePlane(viewer.scene, {
+ *     src: "./images/schependomlaanPlanView.png",  // Plan view image; accepted file types are PNG and JPEG
+ *     visible: true,
+ *     gridVisible: true,
+ *     size: 23.95,
+ *     position: sectionPlane.pos,
+ *     dir: sectionPlane.dir,
+ *     collidable: false,
+ *     opacity: 0.75,
+ *     clippable: false,                            // Don't allow ImagePlane to be clipped by the SectionPlane
+ *     pickable: false                              // Don't allow ImagePlane to be picked
+ *  });
+ * ````
+ */
+export declare class ImagePlane extends Component {
+    /**
+     * @constructor
+     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this ImagePlane as well.
+     * @param {*} [cfg]  ImagePlane configuration
+     * @param {String} [cfg.id] Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
+     * @param {Boolean} [cfg.visible=true] Indicates whether or not this ImagePlane is visible.
+     * @param {Boolean} [cfg.gridVisible=true] Indicates whether or not the grid is visible. Grid is only visible when ImagePlane is also visible.
+     * @param {Number[]} [cfg.position=[0,0,0]] World-space position of the ImagePlane.
+     * @param {Number[]} [cfg.size=1] World-space size of the longest edge of the ImagePlane.
+     * @param {Number[]} [cfg.rotation=[0,0,0]] Local rotation of the ImagePlane, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     * @param {Number[]} [cfg.matrix=[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]] Modelling transform matrix for the ImagePlane. Overrides the position, size, rotation and dir parameters.
+     * @param {Boolean} [cfg.collidable=true] Indicates if the ImagePlane is initially included in boundary calculations.
+     * @param {Boolean} [cfg.clippable=true] Indicates if the ImagePlane is initially clippable.
+     * @param {Boolean} [cfg.pickable=true] Indicates if the ImagePlane is initially pickable.
+     * @param {Number} [cfg.opacity=1.0] ImagePlane's initial opacity factor, multiplies by the rendered fragment alpha.
+     * @param {String} [cfg.src] URL of image. Accepted file types are PNG and JPEG.
+     * @param {HTMLImageElement} [cfg.image] An HTMLImageElement to source the image from. Overrides src.
+     */
+    constructor(owner: Component, cfg?: {
+        id?: string;
+        visible?: boolean;
+        gridVisible?: boolean;
+        position?: number[];
+        size?: number;
+        rotation?: number[];
+        matrix?: number[];
+        collidable?: boolean;
+        clippable?: boolean;
+        pickable?: boolean;
+        opacity?: number;
+        src?: string;
+        image?: HTMLImageElement;
+        dir?: number[];
+    });
+
+    /**
+     * Sets if this ````ImagePlane```` is visible or not.
+     *
+     * Default value is ````true````.
+     *
+     * @param {Boolean} visible Set ````true```` to make this ````ImagePlane```` visible.
+     */
+    set visible(visible: boolean);
+
+    /**
+     * Gets if this ````ImagePlane```` is visible or not.
+     *
+     * Default value is ````true````.
+     *
+     * @returns {Boolean} Returns ````true```` if visible.
+     */
+    get visible(): boolean;
+
+    /**
+     * Sets if this ````ImagePlane````'s grid  is visible or not.
+     *
+     * Default value is ````false````.
+     *
+     * Grid is only visible when ````ImagePlane```` is also visible.
+     *
+     * @param {Boolean} visible Set ````true```` to make this ````ImagePlane````'s grid visible.
+     */
+    set gridVisible(visible: boolean);
+
+    /**
+     * Gets if this ````ImagePlane````'s grid is visible or not.
+     *
+     * Default value is ````false````.
+     *
+     * @returns {Boolean} Returns ````true```` if visible.
+     */
+    get gridVisible(): boolean;
+
+    /**
+     * Sets an ````HTMLImageElement```` to source the image from.
+     *
+     * Sets {@link Texture#src} null.
+     *
+     * @type {HTMLImageElement}
+     */
+    set image(image: HTMLImageElement | null);
+
+    /**
+     * Gets the ````HTMLImageElement```` the ````ImagePlane````'s image is sourced from, if set.
+     *
+     * Returns null if not set.
+     *
+     * @type {HTMLImageElement}
+     */
+    get image(): HTMLImageElement | null;
+
+    /**
+     * Sets an image file path that the ````ImagePlane````'s image is sourced from.
+     *
+     * Accepted file types are PNG and JPEG.
+     *
+     * Sets {@link Texture#image} null.
+     *
+     * @type {String}
+     */
+    set src(src: string | null);
+
+    /**
+     * Gets the image file path that the ````ImagePlane````'s image is sourced from, if set.
+     *
+     * Returns null if not set.
+     *
+     * @type {String}
+     */
+    get src(): string | null;
+
+    /**
+     * Sets the World-space position of this ````ImagePlane````.
+     *
+     * Default value is ````[0, 0, 0]````.
+     *
+     * @param {Number[]} value New position.
+     */
+    set position(value: number[]);
+
+    /**
+     * Gets the World-space position of this ````ImagePlane````.
+     *
+     * Default value is ````[0, 0, 0]````.
+     *
+     * @returns {Number[]} Current position.
+     */
+    get position(): number[];
+
+    /**
+     * Sets the direction of this ````ImagePlane```` using Euler angles.
+     *
+     * Default value is ````[0, 0, 0]````.
+     *
+     * @param {Number[]} value Euler angles for ````X````, ````Y```` and ````Z```` axis rotations.
+     */
+    set rotation(value: number[]);
+
+    /**
+     * Gets the direction of this ````ImagePlane```` as Euler angles.
+     *
+     * @returns {Number[]} Euler angles for ````X````, ````Y```` and ````Z```` axis rotations.
+     */
+    get rotation(): number[];
+
+    /**
+     * Sets the World-space size of the longest edge of the ````ImagePlane````.
+     *
+     * Note that ````ImagePlane```` sets its aspect ratio to match its image. If we set a value of ````1000````, and
+     * the image has size ````400x300````, then the ````ImagePlane```` will then have size ````1000 x 750````.
+     *
+     * Default value is ````1.0````.
+     *
+     * @param {Number} size New World-space size of the ````ImagePlane````.
+     */
+    set size(size: number);
+
+    /**
+     * Gets the World-space size of the longest edge of the ````ImagePlane````.
+     *
+     * @returns {Number} World-space size of the ````ImagePlane````.
+     */
+    get size(): number;
+
+    /**
+     * Sets the direction of this ````ImagePlane```` as a direction vector.
+     *
+     * Default value is ````[0, 0, -1]````.
+     *
+     * @param {Number[]} dir New direction vector.
+     */
+    set dir(dir: number[]);
+
+    /**
+     * Gets the direction of this ````ImagePlane```` as a direction vector.
+     *
+     * @returns {Number[]} value Current direction.
+     */
+    get dir(): number[];
+
+    /**
+     * Sets if this ````ImagePlane```` is included in boundary calculations.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    set collidable(value: boolean);
+
+    /**
+     * Gets if this ````ImagePlane```` is included in boundary calculations.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    get collidable(): boolean;
+
+    /**
+     * Sets if this ````ImagePlane```` is clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    set clippable(value: boolean);
+
+    /**
+     * Gets if this ````ImagePlane````  is clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    get clippable(): boolean;
+
+    /**
+     * Sets if this ````ImagePlane```` is pickable.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    set pickable(value: boolean);
+
+    /**
+     * Gets if this ````ImagePlane````  is pickable.
+     *
+     * Default is ````true````.
+     *
+     * @type {Boolean}
+     */
+    get pickable(): boolean;
+
+    /**
+     * Sets the opacity factor for this ````ImagePlane````.
+     *
+     * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+     *
+     * @type {Number}
+     */
+    set opacity(opacity: number);
+
+    /**
+     * Gets this ````ImagePlane````'s opacity factor.
+     *
+     * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+     *
+     * @type {Number}
+     */
+    get opacity(): number;
+
+    /**
+     * @destroy
+     */
+    destroy(): void;
+
+    protected _node: Node;
+    protected _plane: Mesh;
+    protected _grid: Mesh;
+    protected _texture: Texture;
+    protected _src: string | null;
+    protected _image: HTMLImageElement | null;
+    protected _pos: Float32Array;
+    protected _origin: Float32Array;
+    protected _rtcPos: Float32Array;
+    protected _dir: Float32Array;
+    protected _size: number;
+    protected _imageSize: Float32Array;
+    protected _gridVisible: boolean;
+    protected _updatePlaneSizeFromImage(): void;
+}

package/types/viewer/scene/ImagePlane/index.d.ts

@@ -0,0 +1 @@
+export * from "./ImagePlane";