@xtctwins/tctwins-core 1.0.16 → 1.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xtctwins/tctwins-core",
-	"version": "1.0.16",
+	"version": "1.0.17",
 	"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,82 @@ 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;
+		}
+	);
 
-    /**
-     * 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/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,82 @@ 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;
+		}
+	);
 
-    /**
-     * 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;
 }