@xeokit/xeokit-sdk 2.6.3 → 2.6.6

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

@@ -0,0 +1,92 @@
+import { AngleMeasurementsControl } from "./AngleMeasurementsControl";
+import {AngleMeasurementsPlugin} from "./AngleMeasurementsPlugin";
+import {PointerLens} from "../../extras/";
+
+/**
+ * Creates {@link AngleMeasurement}s in an {@link AngleMeasurementsPlugin} from touch input.
+ *
+ * @example
+ * import { Viewer, XKTLoaderPlugin, AngleMeasurementsPlugin, AngleMeasurementsTouchControl, 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 angleMeasurementsTouchControl = new AngleMeasurementsTouchControl(angleMeasurements, {
+ *     pointerLens: pointerLens,
+ *     snapping: true
+ * });
+ *
+ * angleMeasurementsTouchControl.activate();
+ */
+export class AngleMeasurementsTouchControl extends AngleMeasurementsControl {
+
+    /**
+     * Creates a new AngleMeasurementsTouchControl.
+     *
+     * @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 AngleMeasurementsTouchControl.
+     */
+    constructor(angleMeasurementsPlugin: AngleMeasurementsPlugin, cfg?: {
+        pointerLens?: PointerLens;
+        snapping?: boolean;
+    });
+
+    /**
+     * Gets whether this AngleMeasurementsTouchControl 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 AngleMeasurementsTouchControl.
+     *
+     * @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 AngleMeasurementsTouchControl.
+     *
+     * @returns {boolean} True if snap-to-vertex and snap-to-edge are enabled, false otherwise.
+     */
+    get snapping(): boolean;
+
+    /**
+     * Activates this AngleMeasurementsTouchControl, making it responsive to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this AngleMeasurementsTouchControl, making it unresponsive to input.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this AngleMeasurementsTouchControl, destroying any AngleMeasurement under construction.
+     */
+    reset(): void;
+
+    /**
+     * Destroys this AngleMeasurementsTouchControl.
+     */
+    destroy(): void;
+}

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

@@ -88,7 +88,7 @@ export declare class DistanceMeasurementsControl extends Component {
     on(event: "measurementStart", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
 
     /**
-     * Fires when the the control is (de)activated
+     * Fires when the control is (de)activated
      * @param event The activation event
      * @param callback Called fired on the event
      * @param scope  Scope for the callback

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

@@ -3,26 +3,37 @@ 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;
+
   /** The default value of the DistanceMeasurements `labelsOnWires` property. */
   defaultLabelsOnWires?: boolean;
+
   /** If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels). */
   zIndex?: number;
 };
@@ -31,7 +42,8 @@ export declare type DistanceMeasurementsPluginConfiguration = {
  * {@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.
@@ -149,5 +161,4 @@ export declare class DistanceMeasurementsPlugin extends Plugin {
    * @param {Function} callback Callback fired on the event
    */
    on(event: "measurementDestroyed", callback: (measurement: DistanceMeasurement)=> void): string;
-  
 }

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

@@ -0,0 +1,70 @@
+import {DistanceMeasurementsControl} from "./DistanceMeasurementsControl";
+import {DistanceMeasurementsPlugin} from "./DistanceMeasurementsPlugin";
+import {PointerLens} from "../../extras/";
+
+/**
+ * Creates {@link DistanceMeasurement}s in a {@link DistanceMeasurementsPlugin} from touch input.
+ *
+ * @example
+ * // Usage
+ * const distanceMeasurementsControl = new DistanceMeasurementsTouchControl(distanceMeasurementsPlugin, {
+ *     pointerLens: new PointerLens(viewer),
+ *     snapping: true
+ * });
+ */
+export class DistanceMeasurementsTouchControl extends DistanceMeasurementsControl {
+
+    /**
+     * Creates a DistanceMeasurementsTouchControl 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 DistanceMeasurementsTouchControl.
+     */
+    constructor(distanceMeasurementsPlugin: DistanceMeasurementsPlugin, cfg?: {
+        pointerLens?: PointerLens;
+        snapping?: boolean;
+    });
+
+    /**
+     * Gets if this DistanceMeasurementsTouchControl is currently active, where it is responding to input.
+     *
+     * @returns {boolean} True if this DistanceMeasurementsTouchControl is active.
+     */
+    get active(): boolean;
+
+    /**
+     * Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl.
+     *
+     * @param {boolean} snapping Whether to enable snap-to-vertex and snap-to-edge for this DistanceMeasurementsTouchControl.
+     */
+    set snapping(snapping: boolean);
+
+    /**
+     * Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl.
+     *
+     * @returns {boolean} Whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl.
+     */
+    get snapping(): boolean;
+
+    /**
+     * Activates this DistanceMeasurementsTouchControl, ready to respond to input.
+     */
+    activate(): void;
+
+    /**
+     * Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input.
+     */
+    deactivate(): void;
+
+    /**
+     * Resets this DistanceMeasurementsTouchControl.
+     */
+    reset(): void;
+
+    /**
+     * Destroys this DistanceMeasurementsTouchControl.
+     */
+    destroy(): void;
+}