@xtctwins/tctwins-core 1.0.16 → 1.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xtctwins/tctwins-core",
-	"version": "1.0.16",
+	"version": "1.0.18",
 	"private": false,
 	"description": "Web Programming Toolkit for 3D/2D BIM and CAD",
 	"module": "./dist/tctwins-core.es.js",

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

@@ -1,7 +1,7 @@
 import { AngleMeasurementsControl } from "./AngleMeasurementsControl.js";
 import { math } from "../../viewer/scene/math/math.js";
-import {AngleMeasurementsPlugin} from "./AngleMeasurementsPlugin";
-import {PointerLens} from "../../extras/PointerLens/PointerLens";
+import { AngleMeasurementsPlugin } from "./AngleMeasurementsPlugin";
+import { PointerLens } from "../../extras/PointerLens/PointerLens";
 
 /**
  * Creates {@link AngleMeasurement}s in an {@link AngleMeasurementsPlugin} from mouse input.
@@ -36,58 +36,84 @@ import {PointerLens} from "../../extras/PointerLens/PointerLens";
  * 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.
+	 * @param {offsetX} [cfg.offsetX] offsetX of the mouse
+	 * @param {offsetY} [cfg.offsetY] offsetY of the mouse
+	 */
+	constructor(
+		angleMeasurementsPlugin: AngleMeasurementsPlugin,
+		cfg?: {
+			pointerLens?: PointerLens;
+			snapping?: boolean;
+			offsetX?: number;
+			offsetY?: number;
+		}
+	);
 
-    /**
-     * 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;
-    });
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetX(): number;
 
-    /**
-     * Gets whether this AngleMeasurementsMouseControl is currently active, responding to input.
-     *
-     * @returns {boolean} True if active, false otherwise.
-     */
-    get active(): boolean;
+	/**
+	 * @param {number} offsetX
+	 */
+	set offsetX(offsetX: number);
 
-    /**
-     * 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);
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetY(): number;
 
-    /**
-     * 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;
+	/**
+	 * @param {number} offsetY
+	 */
+	set offsetY(offsetY: number);
 
-    /**
-     * Activates this AngleMeasurementsMouseControl, making it responsive to input.
-     */
-    activate(): void;
+	/**
+	 * Gets whether this AngleMeasurementsMouseControl is currently active, responding to input.
+	 *
+	 * @returns {boolean} True if active, false otherwise.
+	 */
+	get active(): boolean;
 
-    /**
-     * Deactivates this AngleMeasurementsMouseControl, making it unresponsive to input.
-     */
-    deactivate(): void;
+	/**
+	 * 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);
 
-    /**
-     * Resets this AngleMeasurementsMouseControl, destroying any AngleMeasurement under construction.
-     */
-    reset(): void;
+	/**
+	 * 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;
 
-    /**
-     * Destroys this AngleMeasurementsMouseControl.
-     */
-    destroy(): void;
+	/**
+	 * 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/AngleMeasurementsPlugin.d.ts

@@ -3,97 +3,111 @@ import { AngleMeasurement } from "./AngleMeasurement";
 import { AngleMeasurementsControl } from "./AngleMeasurementsControl";
 
 export declare type AngleMeasurementsPluginConfiguration = {
-  /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
-  id?: string;
-  /** Container DOM element for markers and labels. Defaults to ````document.body````. */
-  container?: HTMLElement;
-  /** The default color of the dots, wire and label. */
-  defaultColor?: string;
-  /** If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels). */
-  zIndex?: number;
+	/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
+	id?: string;
+	/** Container DOM element for markers and labels. Defaults to ````document.body````. */
+	container?: HTMLElement;
+	/** The default color of the dots, wire and label. */
+	defaultColor?: string;
+	/** If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels). */
+	zIndex?: number;
 };
 
 /**
  * {@link Viewer} plugin for measuring angles.
  */
 export declare class AngleMeasurementsPlugin extends Plugin {
-  /**
-   * @constructor
-   * @param {Viewer} viewer The Viewer.
-   * @param {AngleMeasurementsPluginConfiguration} [cfg]  Plugin configuration.
-  */
-  constructor(viewer: Viewer, cfg?: AngleMeasurementsPluginConfiguration);
+	/**
+	 * @constructor
+	 * @param {Viewer} viewer The Viewer.
+	 * @param {AngleMeasurementsPluginConfiguration} [cfg]  Plugin configuration.
+	 */
+	constructor(viewer: Viewer, cfg?: AngleMeasurementsPluginConfiguration);
 
-  /**
-   * Gets the {@link AngleMeasurementsControl}, which creates {@link AngleMeasurement}s from user input.
-   *
-   * @type {AngleMeasurementsControl}
-   */
-  get control(): AngleMeasurementsControl;
+	/**
+	 * Gets the {@link AngleMeasurementsControl}, which creates {@link AngleMeasurement}s from user input.
+	 *
+	 * @type {AngleMeasurementsControl}
+	 */
+	get control(): AngleMeasurementsControl;
 
-  /**
-   * Gets the existing {@link AngleMeasurement}s, each mapped to its {@link AngleMeasurement.id}.
-   *
-   * @type {{String:AngleMeasurement}}
-   */
-  get measurements(): { [key:string]: AngleMeasurement};
+	/**
+	 * Gets the existing {@link AngleMeasurement}s, each mapped to its {@link AngleMeasurement.id}.
+	 *
+	 * @type {{String:AngleMeasurement}}
+	 */
+	get measurements(): { [key: string]: AngleMeasurement };
 
-  /**
-   * Creates an {@link AngleMeasurement}.
-   *
-   * The AngleMeasurement is then registered by {@link AngleMeasurement.id} in {@link AngleMeasurementsPlugin.measurements}.
-   *
-   * @param {Object} params {@link AngleMeasurement} configuration.
-   * @param {String} params.id Unique ID to assign to {@link AngleMeasurement.id}. The AngleMeasurement will be registered by this in {@link AngleMeasurementsPlugin.measurements} and {@link Scene.components}. Must be unique among all components in the {@link Viewer}.
-   * @param {Number[]} params.origin.worldPos Origin World-space 3D position.
-   * @param {Entity} params.origin.entity Origin Entity.
-   * @param {Number[]} params.corner.worldPos Corner World-space 3D position.
-   * @param {Entity} params.corner.entity Corner Entity.
-   * @param {Number[]} params.target.worldPos Target World-space 3D position.
-   * @param {Entity} params.target.entity Target Entity.
-   * @param {Boolean} [params.visible=true] Whether to initially show the {@link AngleMeasurement}.
-   * @returns {AngleMeasurement} The new {@link AngleMeasurement}.
-   */
-  createMeasurement(params?: {
-      id: string;
-      origin: {
-        entity: Entity;
-        worldPos: number[];
-      },
-      corner: {
-        entity: Entity;
-        worldPos: number[];
-      },
-      target: {
-        entity: Entity;
-        worldPos: number[];
-      },
-      visible?: boolean;
-  }): AngleMeasurement;
+	/**
+	 * Creates an {@link AngleMeasurement}.
+	 *
+	 * The AngleMeasurement is then registered by {@link AngleMeasurement.id} in {@link AngleMeasurementsPlugin.measurements}.
+	 *
+	 * @param {Object} params {@link AngleMeasurement} configuration.
+	 * @param {String} params.id Unique ID to assign to {@link AngleMeasurement.id}. The AngleMeasurement will be registered by this in {@link AngleMeasurementsPlugin.measurements} and {@link Scene.components}. Must be unique among all components in the {@link Viewer}.
+	 * @param {Number[]} params.origin.worldPos Origin World-space 3D position.
+	 * @param {Entity} params.origin.entity Origin Entity.
+	 * @param {Number[]} params.corner.worldPos Corner World-space 3D position.
+	 * @param {Entity} params.corner.entity Corner Entity.
+	 * @param {Number[]} params.target.worldPos Target World-space 3D position.
+	 * @param {Entity} params.target.entity Target Entity.
+	 * @param {Boolean} [params.visible=true] Whether to initially show the {@link AngleMeasurement}.
+	 * @returns {AngleMeasurement} The new {@link AngleMeasurement}.
+	 */
+	createMeasurement(params?: {
+		id: string;
+		origin: {
+			entity: Entity;
+			worldPos: number[];
+		};
+		corner: {
+			entity: Entity;
+			worldPos: number[];
+		};
+		target: {
+			entity: Entity;
+			worldPos: number[];
+		};
+		visible?: boolean;
+	}): AngleMeasurement;
 
-  /**
-   * Destroys a {@link AngleMeasurement}.
-   *
-   * @param {String} id ID of AngleMeasurement to destroy.
-   */
-  destroyMeasurement(id: string): void;
-  
-  /**
-   * Destroys all {@link AngleMeasurement}s.
-   */
-  clear(): void;
+	/**
+	 * Destroys a {@link AngleMeasurement}.
+	 *
+	 * @param {String} id ID of AngleMeasurement to destroy.
+	 */
+	destroyMeasurement(id: string): void;
 
-  /**
-   * Fires when a measurement is created.
-   * @param {String} event The measurementCreated event
-   * @param {Function} callback Callback fired on the event
-   */
-  on(event: "measurementCreated", callback: (measurement: AngleMeasurement)=> void): void;
+	/**
+	 * Destroys all {@link AngleMeasurement}s.
+	 */
+	clear(): void;
 
-  /**
-   * Fires when a measurement is destroyed.
-   * @param {String} event The measurementDestroyed event
-   * @param {Function} callback Callback fired on the event
-   */
-  on(event: "measurementDestroyed", callback: (measurement: AngleMeasurement)=> void): void;
-}
+	/**
+	 * Fires when a measurement is created.
+	 * @param {String} event The measurementCreated event
+	 * @param {Function} callback Callback fired on the event
+	 */
+	on(event: "measurementCreated", callback: (measurement: AngleMeasurement) => void): void;
+
+	/**
+	 * Fires when a measurement is completed.
+	 * @param {String} event The measurementEnd event
+	 * @param {Function} callback Callback fired on the event
+	 */
+	on(event: "measurementEnd", callback: (measurement: AngleMeasurement) => void): string;
+
+	/**
+	 * Fires when a measurement is cancelled.
+	 * @param {String} event The measurementCancel event
+	 * @param {Function} callback Callback fired on the event
+	 */
+	on(event: "measurementCancel", callback: (measurement: AngleMeasurement) => void): string;
+
+	/**
+	 * Fires when a measurement is destroyed.
+	 * @param {String} event The measurementDestroyed event
+	 * @param {Function} callback Callback fired on the event
+	 */
+	on(event: "measurementDestroyed", callback: (measurement: AngleMeasurement) => void): void;
+}

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

@@ -1,7 +1,7 @@
-import {DistanceMeasurementsControl} from "./DistanceMeasurementsControl.js";
+import { DistanceMeasurementsControl } from "./DistanceMeasurementsControl.js";
 
-import {DistanceMeasurementsPlugin} from "./DistanceMeasurementsPlugin";
-import {PointerLens} from "../../extras/PointerLens/PointerLens";
+import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin";
+import { PointerLens } from "../../extras/PointerLens/PointerLens";
 
 /**
  * Creates {@link DistanceMeasurement}s in a {@link DistanceMeasurementsPlugin} from mouse input.
@@ -14,58 +14,84 @@ import {PointerLens} from "../../extras/PointerLens/PointerLens";
  * });
  */
 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.
+	 * @param {offsetX} [cfg.offsetX] offsetX of the mouse
+	 * @param {offsetY} [cfg.offsetY] offsetY of the mouse
+	 */
+	constructor(
+		distanceMeasurementsPlugin: DistanceMeasurementsPlugin,
+		cfg?: {
+			pointerLens?: PointerLens;
+			snapping?: boolean;
+			offsetX?: number;
+			offsetY?: number;
+		}
+	);
 
-    /**
-     * 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;
-    });
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetX(): number;
 
-    /**
-     * Gets if this DistanceMeasurementsMouseControl is currently active, where it is responding to input.
-     *
-     * @returns {boolean} True if this DistanceMeasurementsMouseControl is active.
-     */
-    get active(): boolean;
+	/**
+	 * @param {number} offsetX
+	 */
+	set offsetX(offsetX: number);
 
-    /**
-     * 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);
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetY(): number;
 
-    /**
-     * 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;
+	/**
+	 * @param {number} offsetY
+	 */
+	set offsetY(offsetY: number);
 
-    /**
-     * Activates this DistanceMeasurementsMouseControl, ready to respond to input.
-     */
-    activate(): void;
+	/**
+	 * Gets if this DistanceMeasurementsMouseControl is currently active, where it is responding to input.
+	 *
+	 * @returns {boolean} True if this DistanceMeasurementsMouseControl is active.
+	 */
+	get active(): boolean;
 
-    /**
-     * Deactivates this DistanceMeasurementsMouseControl, making it unresponsive to input.
-     */
-    deactivate(): void;
+	/**
+	 * 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);
 
-    /**
-     * Resets this DistanceMeasurementsMouseControl.
-     */
-    reset(): void;
+	/**
+	 * 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;
 
-    /**
-     * Destroys this DistanceMeasurementsMouseControl.
-     */
-    destroy(): void;
+	/**
+	 * 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;
 }