@xtctwins/tctwins-core 1.0.19 → 1.0.21

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

@@ -3,147 +3,160 @@ import { DistanceMeasurementsControl } from "./DistanceMeasurementsControl";
 import { DistanceMeasurement } from "./DistanceMeasurement";
 
 export declare type DistanceMeasurementsPluginConfiguration = {
-  /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
-  id?: string;
-  /** The minimum length, in pixels, of an axis wire beyond which its label is shown. */
-  labelMinAxisLength?: number;
-  /** Container DOM element for markers and labels. Defaults to ````document.body````. */
-  container?: HTMLElement;
-  /** The default value of the DistanceMeasurements `visible` property. */
-  defaultVisible?: boolean;
-  /** The default value of the DistanceMeasurements `originVisible` property. */
-  defaultOriginVisible?: boolean;
-  /** The default value of the DistanceMeasurements `targetVisible` property. */
-  defaultTargetVisible?: boolean;
-  /** The default value of the DistanceMeasurements `wireVisible` property. */
-  defaultWireVisible?: boolean;
-  /** The default value of the DistanceMeasurements `axisVisible` property. */
-  defaultAxisVisible?: boolean;
-  /** The default color of the length 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;
+	/** The minimum length, in pixels, of an axis wire beyond which its label is shown. */
+	labelMinAxisLength?: number;
+	/** Container DOM element for markers and labels. Defaults to ````document.body````. */
+	container?: HTMLElement;
+	/** The default value of the DistanceMeasurements `visible` property. */
+	defaultVisible?: boolean;
+	/** The default value of the DistanceMeasurements `originVisible` property. */
+	defaultOriginVisible?: boolean;
+	/** The default value of the DistanceMeasurements `targetVisible` property. */
+	defaultTargetVisible?: boolean;
+	/** The default value of the DistanceMeasurements `wireVisible` property. */
+	defaultWireVisible?: boolean;
+	/** The default value of the DistanceMeasurements `axisVisible` property. */
+	defaultAxisVisible?: boolean;
+	/** The default color of the length 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 point-to-point distances.
  */
 export declare class DistanceMeasurementsPlugin extends Plugin {
-  /**
-   * @constructor
-   * @param {Viewer} viewer The Viewer.
-   * @param {DistanceMeasurementsPluginConfiguration} [cfg]  Plugin configuration.
-   */
-  constructor(viewer: Viewer, cfg?: DistanceMeasurementsPluginConfiguration);
-  
-  /**
-   * Sets the minimum length, in pixels, of an axis wire beyond which its label is shown.
-   *
-   * The axis wire's label is not shown when its length is less than this value.
-   *
-   * This is ````25```` pixels by default.
-   *
-   * Must not be less than ````1````.
-   *
-   * @type {number}
-   */
-  set labelMinAxisLength(arg: number);
+	/**
+	 * @constructor
+	 * @param {Viewer} viewer The Viewer.
+	 * @param {DistanceMeasurementsPluginConfiguration} [cfg]  Plugin configuration.
+	 */
+	constructor(viewer: Viewer, cfg?: DistanceMeasurementsPluginConfiguration);
 
-  /**
-   * Gets the minimum length, in pixels, of an axis wire beyond which its label is shown.
-   * @returns {number}
-   */
-  get labelMinAxisLength(): number;
-  
-  /**
-   * Gets the {@link DistanceMeasurementsControl}, which creates {@link DistanceMeasurement}s from user input.
-   *
-   * @type {DistanceMeasurementsControl}
-   */
-  get control(): DistanceMeasurementsControl;
+	/**
+	 * Sets the minimum length, in pixels, of an axis wire beyond which its label is shown.
+	 *
+	 * The axis wire's label is not shown when its length is less than this value.
+	 *
+	 * This is ````25```` pixels by default.
+	 *
+	 * Must not be less than ````1````.
+	 *
+	 * @type {number}
+	 */
+	set labelMinAxisLength(arg: number);
 
-  /**
-   * Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement.id}.
-   *
-   * @type {{String:DistanceMeasurement}}
-   */
-  get measurements(): { [key:string]: DistanceMeasurement };
+	/**
+	 * Gets the minimum length, in pixels, of an axis wire beyond which its label is shown.
+	 * @returns {number}
+	 */
+	get labelMinAxisLength(): number;
 
-  /**
-   * Creates a {@link DistanceMeasurement}.
-   *
-   * The DistanceMeasurement is then registered by {@link DistanceMeasurement.id} in {@link DistanceMeasurementsPlugin.measurements}.
-   *
-   * @param {Object} params {@link DistanceMeasurement} configuration.
-   * @param {String} params.id Unique ID to assign to {@link DistanceMeasurement.id}. The DistanceMeasurement will be registered by this in {@link DistanceMeasurementsPlugin.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.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 DistanceMeasurement}.
-   * @param {Boolean} [params.originVisible=true] Whether to initially show the {@link DistanceMeasurement} origin.
-   * @param {Boolean} [params.targetVisible=true] Whether to initially show the {@link DistanceMeasurement} target.
-   * @param {Boolean} [params.wireVisible=true] Whether to initially show the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
-   * @param {Boolean} [params.axisVisible=true] Whether to initially show the axis-aligned wires between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
-   * @param {string} [params.color] The color of the length dot, wire and label.
-   * @returns {DistanceMeasurement} The new {@link DistanceMeasurement}.
-   */
-  createMeasurement(params?: {
-      id: string;
-      origin: {
-        entity: Entity;
-        worldPos: number[];
-      };
-      target: {
-        entity: Entity;
-        worldPos: number[];
-      };
-      visible?: boolean;
-      originVisible?: boolean;
-      targetVisible?: boolean;
-      wireVisible?: boolean;
-      axisVisible?: boolean;
-      color?: string;
-  }): DistanceMeasurement;
-  
-  /**
-   * Destroys a {@link DistanceMeasurement}.
-   *
-   * @param {String} id ID of DistanceMeasurement to destroy.
-   */
-  destroyMeasurement(id: string): void;
+	/**
+	 * Gets the {@link DistanceMeasurementsControl}, which creates {@link DistanceMeasurement}s from user input.
+	 *
+	 * @type {DistanceMeasurementsControl}
+	 */
+	get control(): DistanceMeasurementsControl;
 
-  /**
-   * Destroys all {@link DistanceMeasurement}s.
-   */
-  clear(): void;
+	/**
+	 * Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement.id}.
+	 *
+	 * @type {{String:DistanceMeasurement}}
+	 */
+	get measurements(): { [key: string]: DistanceMeasurement };
 
-  /**
-   * 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: DistanceMeasurement)=> void): string;
+	/**
+	 * Creates a {@link DistanceMeasurement}.
+	 *
+	 * The DistanceMeasurement is then registered by {@link DistanceMeasurement.id} in {@link DistanceMeasurementsPlugin.measurements}.
+	 *
+	 * @param {Object} params {@link DistanceMeasurement} configuration.
+	 * @param {String} params.id Unique ID to assign to {@link DistanceMeasurement.id}. The DistanceMeasurement will be registered by this in {@link DistanceMeasurementsPlugin.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.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 DistanceMeasurement}.
+	 * @param {Boolean} [params.originVisible=true] Whether to initially show the {@link DistanceMeasurement} origin.
+	 * @param {Boolean} [params.targetVisible=true] Whether to initially show the {@link DistanceMeasurement} target.
+	 * @param {Boolean} [params.wireVisible=true] Whether to initially show the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
+	 * @param {Boolean} [params.axisVisible=true] Whether to initially show the axis-aligned wires between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
+	 * @param {string} [params.color] The color of the length dot, wire and label.
+	 * @returns {DistanceMeasurement} The new {@link DistanceMeasurement}.
+	 */
+	createMeasurement(params?: {
+		id: string;
+		origin: {
+			entity: Entity;
+			worldPos: number[];
+		};
+		target: {
+			entity: Entity;
+			worldPos: number[];
+		};
+		visible?: boolean;
+		originVisible?: boolean;
+		targetVisible?: boolean;
+		wireVisible?: boolean;
+		axisVisible?: boolean;
+		color?: string;
+	}): DistanceMeasurement;
 
-  /**
-   * 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: DistanceMeasurement)=> void): string;
+	/**
+	 * Destroys a {@link DistanceMeasurement}.
+	 *
+	 * @param {String} id ID of DistanceMeasurement to destroy.
+	 */
+	destroyMeasurement(id: string): void;
 
-  /**
-   * 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: DistanceMeasurement)=> void): string;
+	/**
+	 * Destroys all {@link DistanceMeasurement}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: DistanceMeasurement)=> void): string;
-  
+	/**
+	 * 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: DistanceMeasurement) => void): string;
+
+	/**
+	 * 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: DistanceMeasurement) => 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: DistanceMeasurement) => 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: DistanceMeasurement) => void): string;
+
+	/**
+	 * trigger when hover measure object
+	 * @param event
+	 * @param e
+	 */
+	on(event: "mouseOver", e: any): void;
+
+	/**
+	 * trigger when leave measure object
+	 * @param event
+	 * @param e
+	 */
+	on(event: "mouseLeave", e: any): void;
 }

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

@@ -0,0 +1,96 @@
+import { DistanceMeasurementsControl } from "./DistanceMeasurementsControl.js";
+import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin.js";
+import { PointerLens } from "../../extras/PointerLens/PointerLens.js";
+import { PointerCircle } from "../../extras/PointerCircle/PointerCircle.js";
+
+/**
+ * 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 DistanceMeasurementsTouchControl extends DistanceMeasurementsControl {
+	/**
+	 * Creates a DistanceMeasurementsTouchControl bound to the given DistanceMeasurementsPlugin.
+	 * @param {PointerLens} [cfg.pointerLens] A PointerLens to use to provide a magnified view of the cursor when snapping is enabled.
+	 * @param {boolean} [cfg.snapToEdge=true] Whether to initially enable snap-to-vertex and snap-to-edge for this DistanceMeasurementsTouchControl.
+	 * @param {boolean} [cfg.snapToVertex=true] Whether to initially enable snap-to-vertex and snap-to-edge for this DistanceMeasurementsTouchControl.
+	 * @param {_offsetX} [cfg._offsetX] _offsetX of the mouse
+	 * @param {_offsetY} [cfg._offsetY] _offsetY of the mouse
+	 */
+	constructor(
+		distanceMeasurementsPlugin: DistanceMeasurementsPlugin,
+		cfg?: {
+			pointerLens?: PointerLens;
+			snapToEdge?: boolean;
+			snapToVertex?: boolean;
+			offsetX?: number;
+			offsetY?: number;
+		}
+	);
+
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetX(): number;
+
+	/**
+	 * @param {number} offsetX
+	 */
+	set offsetX(offsetX: number);
+
+	/**
+	 * @return {number}  mouse offset
+	 */
+	get offsetY(): number;
+
+	/**
+	 * @param {number} offsetY
+	 */
+	set offsetY(offsetY: number);
+
+	/**
+	 * Gets whether this DistanceMeasurementsTouchControl 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 DistanceMeasurementsTouchControl.
+	 *
+	 * @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 DistanceMeasurementsTouchControl.
+	 *
+	 * @returns {boolean} True if snap-to-vertex and snap-to-edge are enabled, false otherwise.
+	 */
+	get snapping(): boolean;
+
+	/**
+	 * Activates this DistanceMeasurementsTouchControl, making it responsive to input.
+	 */
+	activate(): void;
+
+	/**
+	 * Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input.
+	 */
+	deactivate(): void;
+
+	/**
+	 * Resets this DistanceMeasurementsTouchControl, destroying any DistanceMeasurement under construction.
+	 */
+	reset(): void;
+
+	/**
+	 * Destroys this DistanceMeasurementsTouchControl.
+	 */
+	destroy(): void;
+}

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

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

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

@@ -9,45 +9,61 @@ import { Component } from "../Component";
  * * Located at {@link Scene#input}
  */
 export declare class Input extends Component {
-  readonly KEY_CTRL: number;
-
-  keyDown: boolean[];
-
-  keyboardEnabled: boolean;
-
-  /**
-   * Sets whether input handlers are enabled.
-   */
-  setEnabled(enable: boolean): void;
-
-  /**
-   * Gets whether input handlers are enabled.
-   */
-  getEnabled(): boolean
-
-  /**
-   * Sets whether or not keyboard input is enabled.
-   */
-  setKeyboardEnabled(enable: boolean): void;
-
-  /**
-   * Gets whether keyboard input is enabled.
-   */
-  getKeyboardEnabled(): boolean;
-
-  /**
-   * Fires on mouse events
-   * @param event The loaded event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-  on(event: "mousedown" | "mouseup" | "mouseclicked" | "dblclick", callback: (canvasCoords: number[]) => void, scope?: any): string;
-
-   /**
-   * Fires on keyboard events
-   * @param event The loaded event
-   * @param callback Called fired on the event
-   * @param scope  Scope for the callback
-   */
-   on(event: "keydown" | "keyup", callback: (keyCode: number) => void, scope?: any): string;
-}
+	readonly KEY_CTRL: number;
+
+	keyDown: boolean[];
+
+	keyboardEnabled: boolean;
+
+	/**
+	 * Sets whether input handlers are enabled.
+	 */
+	setEnabled(enable: boolean): void;
+
+	/**
+	 * Gets whether input handlers are enabled.
+	 */
+	getEnabled(): boolean;
+
+	/**
+	 * Sets whether or not keyboard input is enabled.
+	 */
+	setKeyboardEnabled(enable: boolean): void;
+
+	/**
+	 * Gets whether keyboard input is enabled.
+	 */
+	getKeyboardEnabled(): boolean;
+
+	/**
+	 * Fires on mouse events
+	 * @param event The loaded event
+	 * @param callback Called fired on the event
+	 * @param scope  Scope for the callback
+	 */
+	on(
+		event: "mousedown" | "mouseup" | "mouseclicked" | "dblclick",
+		callback: (canvasCoords: number[]) => void,
+		scope?: any
+	): string;
+
+	/**
+	 * Fires on touch events
+	 * @param event The loaded event
+	 * @param callback Called fired on the event
+	 * @param scope  Scope for the callback
+	 */
+	on(
+		event: "touchstart" | "touchend" | "touchclicked",
+		callback: (canvasCoords: number[]) => void,
+		scope?: any
+	): string;
+
+	/**
+	 * Fires on keyboard events
+	 * @param event The loaded event
+	 * @param callback Called fired on the event
+	 * @param scope  Scope for the callback
+	 */
+	on(event: "keydown" | "keyup", callback: (keyCode: number) => void, scope?: any): string;
+}