@xeokit/xeokit-sdk 2.4.0-alpha-106 → 2.4.0-beta-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.4.0-alpha-106",
+  "version": "2.4.0-beta-1",
   "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/scene/model/MeshClusteringManager.js

@@ -0,0 +1,31 @@
+export class MeshClusteringManager {
+
+    constructor(sceneModel) {
+        this.sceneModel = sceneModel;
+        this.meshes = [];
+        this.entities = [];
+        this.clusteredMeshes = [];
+    }
+
+    addMeshCfg(meshCfg) {
+        this.meshes.push(meshCfg);
+    }
+
+    addEntityCfg(entityCfg) {
+        this.entities.push(entityCfg);
+    }
+
+    doClustering() {
+        this.clusteredMeshes = this.meshes;
+    }
+
+    finalize() {
+        this.doClustering();
+        for (let i = 0, len = this.clusteredMeshes.length; i < len; i++) {
+            this.sceneModel.addMesh(this.clusteredMeshes[i]);
+        }
+        for (let i = 0, len = this.entities.length; i < len; i++) {
+            this.sceneModel.addEntity(this.entities[i]);
+        }
+    }
+}

package/types/extras/PointerLens/PointerLens.d.ts

@@ -0,0 +1,144 @@
+import {Viewer} from "../../viewer";
+
+/**
+ * A PointerLens shows a magnified view of a {@link Viewer}'s canvas, centered at the position of the
+ * mouse or touch pointer.
+ *
+ * @example
+ * import { Viewer, XKTLoaderPlugin, AngleMeasurementsPlugin, AngleMeasurementsMouseControl, PointerLens } from "../../dist/xeokit-sdk.es.js";
+ *
+ * const viewer = new Viewer({
+ *     canvasId: "myCanvas",
+ *     dtxEnabled: true
+ * });
+ *
+ * viewer.camera.eye = [-3.93, 2.85, 27.01];
+ * viewer.camera.look = [4.40, 3.72, 8.89];
+ * viewer.camera.up = [-0.01, 0.99, 0.039];
+ *
+ * const xktLoader = new XKTLoaderPlugin(viewer);
+ *
+ * const sceneModel = xktLoader.load({
+ *     id: "myModel",
+ *     src: "../../assets/models/xkt/v10/glTF-Embedded/Duplex_A_20110505.glTFEmbedded.xkt",
+ *     edges: true
+ * });
+ *
+ * const angleMeasurements = new AngleMeasurementsPlugin(viewer);
+ *
+ * const angleMeasurementsMouseControl  = new AngleMeasurementsMouseControl(angleMeasurements, {
+ *     pointerLens : new PointerLens(viewer, {
+ *         zoomFactor: 2
+ *     })
+ * });
+ *
+ * angleMeasurementsMouseControl.activate();
+ */
+export class PointerLens {
+
+    /**
+     * Constructs a new PointerLens.
+     *
+     * @param {Viewer} viewer The Viewer instance.
+     * @param {Object} [cfg] PointerLens configuration.
+     * @param {boolean} [cfg.active=true] Whether PointerLens is active. The PointerLens can only be shown when this is `true` (default).
+     * @param {number} [cfg.zoomFactor=2] The zoom factor for the lens.
+     */
+    constructor(viewer: Viewer, cfg?: {
+        active?: boolean;
+        zoomFactor?: number;
+    });
+
+    /**
+     * Sets the zoom factor for the lens.
+     *
+     * This is `2` by default.
+     *
+     * @param {number} zoomFactor The zoom factor for the lens.
+     */
+    set zoomFactor(zoomFactor: number);
+
+    /**
+     * Gets the zoom factor for the lens.
+     *
+     * This is `2` by default.
+     *
+     * @returns {number} The zoom factor for the lens.
+     */
+    get zoomFactor(): number;
+
+    /**
+     * Sets the canvas central position of the lens.
+     *
+     * @param {number[]} centerPos The canvas central position of the lens.
+     */
+    set centerPos(centerPos: number[]);
+
+    /**
+     * Gets the canvas central position of the lens.
+     *
+     * @returns {number[]} The canvas central position of the lens.
+     */
+    get centerPos(): number[];
+
+    /**
+     * Sets the canvas coordinates of the pointer.
+     *
+     * @param {number[]} cursorPos The canvas coordinates of the pointer.
+     */
+    set cursorPos(cursorPos: number[]);
+
+    /**
+     * Gets the canvas coordinates of the pointer.
+     *
+     * @returns {number[]} The canvas coordinates of the pointer.
+     */
+    get cursorPos(): number[];
+
+    /**
+     * Sets whether the cursor has snapped to anything.
+     *
+     * @param {boolean} snapped Whether the cursor has snapped to anything.
+     */
+    set snapped(snapped: boolean);
+
+    /**
+     * Gets whether the cursor has snapped to anything.
+     *
+     * @returns {boolean} Whether the cursor has snapped to anything.
+     */
+    get snapped(): boolean;
+
+    /**
+     * Sets if this PointerLens is active.
+     *
+     * @param {boolean} active Whether this PointerLens is active.
+     */
+    set active(active: boolean);
+
+    /**
+     * Gets if this PointerLens is active.
+     *
+     * @returns {boolean} Whether this PointerLens is active.
+     */
+    get active(): boolean;
+
+    /**
+     * Sets if this PointerLens is visible.
+     *
+     * @param {boolean} visible Whether this PointerLens is visible.
+     */
+    set visible(visible: boolean);
+
+    /**
+     * Gets if this PointerLens is visible.
+     *
+     * @returns {boolean} Whether this PointerLens is visible.
+     */
+    get visible(): boolean;
+
+    /**
+     * Destroys this PointerLens.
+     */
+    destroy(): void;
+}

package/types/extras/PointerLens/index.d.ts

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

package/types/extras/index.d.ts

@@ -1 +1,2 @@
 export * from "./ContextMenu";
+export * from "./PointerLens";

package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsControl.d.ts

@@ -1,6 +1,6 @@
-import { Component } from "../../viewer/scene/Component";
-import { AngleMeasurement } from "./AngleMeasurement";
-import { AngleMeasurementsPlugin } from "./AngleMeasurementsPlugin";
+import {Component} from "../../viewer/scene/Component";
+import {AngleMeasurement} from "./AngleMeasurement";
+import {AngleMeasurementsPlugin} from "./AngleMeasurementsPlugin";
 
 /**
  * Creates {@link AngleMeasurement}s from mouse and touch input.
@@ -8,60 +8,82 @@ import { AngleMeasurementsPlugin } from "./AngleMeasurementsPlugin";
  * Once the AngleMeasurementControl is activated, the first click on any {@link Entity} begins constructing a {@link AngleMeasurement}, fixing its origin to that Entity. The next click on any Entity will complete the AngleMeasurement, fixing its target to that second Entity. The AngleMeasurementControl will then wait for the next click on any Entity, to begin constructing another AngleMeasurement, and so on, until deactivated.
  */
 export declare class AngleMeasurementsControl extends Component {
-  /**
-   * The {@link AngleMeasurementsPlugin} that owns this AngleMeasurementsControl.
-   * @type {AngleMeasurementsPlugin}
-   */
-  plugin: AngleMeasurementsPlugin;
-  
-  /** Gets if this AngleMeasurementsControl is currently active, where it is responding to input.
-   *
-   * @returns {Boolean}
-   */
-  get active(): boolean;
-  
-  /**
-   * Activates this AngleMeasurementsControl, ready to respond to input.
-   */
-  activate(): void;
-  
-  /**
-   * Deactivates this AngleMeasurementsControl, making it unresponsive to input.
-   *
-   * Destroys any {@link AngleMeasurement} under construction.
-   */
-  deactivate(): void;
-  
-  /**
-   * Resets this AngleMeasurementsControl.
-   *
-   * Destroys any {@link AngleMeasurement} under construction.
-   *
-   * Does nothing if the AngleMeasurementsControl is not active.
-   */
-  reset(): void;
+    /**
+     * The {@link AngleMeasurementsPlugin} that owns this AngleMeasurementsControl.
+     * @type {AngleMeasurementsPlugin}
+     */
+    plugin: AngleMeasurementsPlugin;
 
-  /**
-   * Fires when the measurement is ended.
-   * @param event The measurementEnd event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-   on(event: "measurementEnd", callback: (measurement: AngleMeasurement) => void, scope?: any): string
+    /**
+     * Sets whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsControl.
+     *
+     * This is `true` by default.
+     *
+     * Internally, this deactivates then activates the AngleMeasurementsControl when changed, which means that
+     * it will destroy any AngleMeasurements currently under construction, and incurs some overhead, since it unbinds
+     * and rebinds various input handlers.
+     *
+     * @param {boolean} snapping Whether to enable snap-to-vertex and snap-edge for this AngleMeasurementsControl.
+     */
+    set snapping(snapping: boolean);
 
-   /**
-   * Fires when the measurement is cancelled.
-   * @param event The measurementCancel event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "measurementCancel", callback: (measurement: AngleMeasurement) => void, scope?: any): string
+    /**
+     * Gets whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsControl.
+     *
+     * This is `true` by default.
+     *
+     * @returns {boolean} Whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsControl.
+     */
+    get snapping(): boolean;
 
-  /**
-   * Fires when the measurement is started.
-   * @param event The measurementStart event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "measurementStart", callback: (measurement: AngleMeasurement) => void, scope?: any): string
+    /** Gets if this AngleMeasurementsControl is currently active, where it is responding to input.
+     *
+     * @returns {Boolean}
+     */
+    get active(): boolean;
+
+    /**
+     * Activates this AngleMeasurementsControl, ready to respond to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this AngleMeasurementsControl, making it unresponsive to input.
+     *
+     * Destroys any {@link AngleMeasurement} under construction.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this AngleMeasurementsControl.
+     *
+     * Destroys any {@link AngleMeasurement} under construction.
+     *
+     * Does nothing if the AngleMeasurementsControl is not active.
+     */
+    reset(): void;
+
+    /**
+     * Fires when the measurement is ended.
+     * @param event The measurementEnd event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementEnd", callback: (measurement: AngleMeasurement) => void, scope?: any): string
+
+    /**
+     * Fires when the measurement is cancelled.
+     * @param event The measurementCancel event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementCancel", callback: (measurement: AngleMeasurement) => void, scope?: any): string
+
+    /**
+     * Fires when the measurement is started.
+     * @param event The measurementStart event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementStart", callback: (measurement: AngleMeasurement) => void, scope?: any): string
 }

package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsMouseControl.d.ts

@@ -0,0 +1,93 @@
+import { AngleMeasurementsControl } from "./AngleMeasurementsControl.js";
+import { math } from "../../viewer/scene/math/math.js";
+import {AngleMeasurementsPlugin} from "./AngleMeasurementsPlugin";
+import {PointerLens} from "../../extras/PointerLens/PointerLens";
+
+/**
+ * Creates {@link AngleMeasurement}s in an {@link AngleMeasurementsPlugin} from mouse input.
+ *
+ * @example
+ * import { Viewer, XKTLoaderPlugin, AngleMeasurementsPlugin, AngleMeasurementsMouseControl, PointerLens } from "xeokit-sdk.es.js";
+ *
+ * const viewer = new Viewer({
+ *     canvasId: "myCanvas",
+ * });
+ *
+ * viewer.camera.eye = [-3.93, 2.85, 27.01];
+ * viewer.camera.look = [4.40, 3.72, 8.89];
+ * viewer.camera.up = [-0.01, 0.99, 0.039];
+ *
+ * const xktLoader = new XKTLoaderPlugin(viewer);
+ *
+ * const sceneModel = xktLoader.load({
+ *     id: "myModel",
+ *     src: "Duplex.xkt"
+ * });
+ *
+ * const angleMeasurements = new AngleMeasurementsPlugin(viewer);
+ *
+ * const pointerLens = new PointerLens(viewer); // Create a PointerLens instance
+ *
+ * const angleMeasurementsMouseControl = new AngleMeasurementsMouseControl(angleMeasurements, {
+ *     pointerLens: pointerLens,
+ *     snapping: true
+ * });
+ *
+ * angleMeasurementsMouseControl.activate();
+ */
+export class AngleMeasurementsMouseControl extends AngleMeasurementsControl {
+
+    /**
+     * Creates a new AngleMeasurementsMouseControl.
+     *
+     * @param {AngleMeasurementsPlugin} angleMeasurementsPlugin The AngleMeasurementsPlugin to control.
+     * @param {Object} [cfg] Configuration options.
+     * @param {PointerLens} [cfg.pointerLens] A PointerLens to use for providing a magnified view of the cursor when snapping is enabled.
+     * @param {boolean} [cfg.snapping=true] Whether to initially enable snap-to-vertex and snap-to-edge for this AngleMeasurementsMouseControl.
+     */
+    constructor(angleMeasurementsPlugin: AngleMeasurementsPlugin, cfg?: {
+        pointerLens?: PointerLens;
+        snapping?: boolean;
+    });
+
+    /**
+     * Gets whether this AngleMeasurementsMouseControl is currently active, responding to input.
+     *
+     * @returns {boolean} True if active, false otherwise.
+     */
+    get active(): boolean;
+
+    /**
+     * Sets whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsMouseControl.
+     *
+     * @param {boolean} snapping True to enable snap-to-vertex and snap-to-edge, false to disable.
+     */
+    set snapping(snapping: boolean);
+
+    /**
+     * Gets whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsMouseControl.
+     *
+     * @returns {boolean} True if snap-to-vertex and snap-to-edge are enabled, false otherwise.
+     */
+    get snapping(): boolean;
+
+    /**
+     * Activates this AngleMeasurementsMouseControl, making it responsive to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this AngleMeasurementsMouseControl, making it unresponsive to input.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this AngleMeasurementsMouseControl, destroying any AngleMeasurement under construction.
+     */
+    reset(): void;
+
+    /**
+     * Destroys this AngleMeasurementsMouseControl.
+     */
+    destroy(): void;
+}

package/types/plugins/AngleMeasurementsPlugin/index.d.ts

@@ -1 +1,3 @@
 export * from "./AngleMeasurementsPlugin";
+export * from "./AngleMeasurementsControl";
+export * from "./AngleMeasurementsMouseControl";

package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsControl.d.ts

@@ -1,65 +1,89 @@
-import { Component } from "../../viewer/scene/Component";
-import { DistanceMeasurement } from "./DistanceMeasurement";
-import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin";
+import {Component} from "../../viewer/scene/Component";
+import {DistanceMeasurement} from "./DistanceMeasurement";
+import {DistanceMeasurementsPlugin} from "./DistanceMeasurementsPlugin";
 
 /**
  * Creates {@link DistanceMeasurement}s from mouse and touch input.
  */
 export declare class DistanceMeasurementsControl extends Component {
-  /**
-   * The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurementsControl.
-   * @type {DistanceMeasurementsPlugin}
-   */
-  plugin: DistanceMeasurementsPlugin;
-  
-  /** Gets if this DistanceMeasurementsControl is currently active, where it is responding to input.
-   *
-   * @returns {Boolean}
-   */
-  get active(): boolean;
 
-  /**
-   * Activates this DistanceMeasurementsControl, ready to respond to input.
-   */
-  activate(): void;
-  
-  /**
-   * Deactivates this DistanceMeasurementsControl, making it unresponsive to input.
-   *
-   * Destroys any {@link DistanceMeasurement} under construction.
-   */
-  deactivate(): void;
+    /**
+     * The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurementsControl.
+     * @type {DistanceMeasurementsPlugin}
+     */
+    plugin: DistanceMeasurementsPlugin;
 
-  /**
-   * Resets this DistanceMeasurementsControl.
-   *
-   * Destroys any {@link DistanceMeasurement} under construction.
-   *
-   * Does nothing if the DistanceMeasurementsControl is not active.
-   */
-  reset(): void;
+    /**
+     * Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl.
+     *
+     * This is `true` by default.
+     *
+     * Internally, this deactivates then activates the DistanceMeasurementsControl when changed, which means that
+     * it will destroy any DistanceMeasurements currently under construction, and incurs some overhead, since it unbinds
+     * and rebinds various input handlers.
+     *
+     * @param {boolean} snapping Whether to enable snap-to-vertex and snap-edge for this DistanceMeasurementsControl.
+     */
+    set snapping(snapping: boolean);
 
-  /**
-   * Fires when the measurement is ended.
-   * @param event The measurementEnd event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "measurementEnd", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
+    /**
+     * Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl.
+     *
+     * This is `true` by default.
+     *
+     * @returns {boolean} Whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl.
+     */
+    get snapping(): boolean;
 
-   /**
-   * Fires when the measurement is cancelled.
-   * @param event The measurementCancel event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "measurementCancel", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
 
-  /**
-   * Fires when the measurement is started.
-   * @param event The measurementStart event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "measurementStart", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
+    /** Gets if this DistanceMeasurementsControl is currently active, where it is responding to input.
+     *
+     * @returns {Boolean}
+     */
+    get active(): boolean;
+
+    /**
+     * Activates this DistanceMeasurementsControl, ready to respond to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this DistanceMeasurementsControl, making it unresponsive to input.
+     *
+     * Destroys any {@link DistanceMeasurement} under construction.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this DistanceMeasurementsControl.
+     *
+     * Destroys any {@link DistanceMeasurement} under construction.
+     *
+     * Does nothing if the DistanceMeasurementsControl is not active.
+     */
+    reset(): void;
+
+    /**
+     * Fires when the measurement is ended.
+     * @param event The measurementEnd event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementEnd", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
+
+    /**
+     * Fires when the measurement is cancelled.
+     * @param event The measurementCancel event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementCancel", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
+
+    /**
+     * Fires when the measurement is started.
+     * @param event The measurementStart event
+     * @param callback Called fired on the event
+     * @param scope  Scope for the callback
+     */
+    on(event: "measurementStart", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
 }

package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsMouseControl.d.ts

@@ -0,0 +1,71 @@
+import {DistanceMeasurementsControl} from "./DistanceMeasurementsControl.js";
+
+import {DistanceMeasurementsPlugin} from "./DistanceMeasurementsPlugin";
+import {PointerLens} from "../../extras/PointerLens/PointerLens";
+
+/**
+ * Creates {@link DistanceMeasurement}s in a {@link DistanceMeasurementsPlugin} from mouse input.
+ *
+ * @example
+ * // Usage
+ * const distanceMeasurementsControl = new DistanceMeasurementsMouseControl(distanceMeasurementsPlugin, {
+ *     pointerLens: new PointerLens(viewer),
+ *     snapping: true
+ * });
+ */
+export class DistanceMeasurementsMouseControl extends DistanceMeasurementsControl {
+
+    /**
+     * Creates a DistanceMeasurementsMouseControl bound to the given DistanceMeasurementsPlugin.
+     *
+     * @param {DistanceMeasurementsPlugin} distanceMeasurementsPlugin The DistanceMeasurementsPlugin to control.
+     * @param {Object} cfg Configuration options.
+     * @param {PointerLens} [cfg.pointerLens] A PointerLens to provide a magnified view of the cursor when snapping is enabled.
+     * @param {boolean} [cfg.snapping=true] Whether to enable snap-to-vertex and snap-to-edge for this DistanceMeasurementsMouseControl.
+     */
+    constructor(distanceMeasurementsPlugin: DistanceMeasurementsPlugin, cfg?: {
+        pointerLens?: PointerLens;
+        snapping?: boolean;
+    });
+
+    /**
+     * Gets if this DistanceMeasurementsMouseControl is currently active, where it is responding to input.
+     *
+     * @returns {boolean} True if this DistanceMeasurementsMouseControl is active.
+     */
+    get active(): boolean;
+
+    /**
+     * Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsMouseControl.
+     *
+     * @param {boolean} snapping Whether to enable snap-to-vertex and snap-to-edge for this DistanceMeasurementsMouseControl.
+     */
+    set snapping(snapping: boolean);
+
+    /**
+     * Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsMouseControl.
+     *
+     * @returns {boolean} Whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsMouseControl.
+     */
+    get snapping(): boolean;
+
+    /**
+     * Activates this DistanceMeasurementsMouseControl, ready to respond to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this DistanceMeasurementsMouseControl, making it unresponsive to input.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this DistanceMeasurementsMouseControl.
+     */
+    reset(): void;
+
+    /**
+     * Destroys this DistanceMeasurementsMouseControl.
+     */
+    destroy(): void;
+}

package/types/plugins/DistanceMeasurementsPlugin/index.d.ts

@@ -1 +1,3 @@
 export * from "./DistanceMeasurementsPlugin";
+export * from "./DistanceMeasurementsControl";
+export * from "./DistanceMeasurementsMouseControl";