@xeokit/xeokit-sdk 2.2.5 → 2.3.0-beta-2

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.2.5",
+  "version": "2.3.0-beta-2",
   "description": "Web Programming Toolkit for 3D/2D BIM and AEC Graphics",
   "module": "/dist/xeokit-sdk.es.js",
   "main": "/dist/xeokit-sdk.cjs.js",
+  "types": "./types/index.d.ts",
   "scripts": {
     "build": "rollup --config rollup.config.js; rollup --config rollup.minified.config.js; cp node_modules/web-ifc/web-ifc.wasm dist/.",
     "test": "percy exec -- node ./snapshots.js",
     "docs": "rm -Rf ./docs/*; ./node_modules/.bin/esdoc",
+    "typedocs": "rm -Rf ./docs/*; typedoc --tsconfig tsconfig.json",
     "publish": "npm publish --access public"
   },
   "repository": {
@@ -44,32 +46,26 @@
   },
   "homepage": "https://xeokit.io",
   "dependencies": {
-    "web-ifc": "0.0.30",
-    "@loaders.gl/core": "^3.0.13",
-    "@loaders.gl/las": "^3.0.13"
+    "@loaders.gl/core": "^3.1.8",
+    "@loaders.gl/las": "^3.1.8",
+    "@loaders.gl/gltf": "^3.1.8",
+    "@loaders.gl/draco": "^3.1.8",
+    "web-ifc": "0.0.34"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.7",
-    "@babel/core": "^7.15.5",
-    "@babel/plugin-transform-modules-commonjs": "^7.15.4",
-    "@babel/preset-env": "^7.15.6",
-    "@percy/script": "^1.1.0",
-    "babel": "^6.23.0",
-    "babel-jest": "^27.2.2",
-    "babel-plugin-transform-es2015-modules-commonjs": "^6.26.2",
-    "esdoc": "^1.0.4",
+    "esdoc": "^1.1.0",
     "esdoc-custom-theme": "^1.4.2",
-    "esdoc-publish-html-plugin": "^1.1.0",
+    "esdoc-publish-html-plugin": "^1.1.2",
     "esdoc-standard-plugin": "^1.0.0",
-    "eslint": "^5.16.0",
-    "http-server": "^0.12.3",
-    "jest": "^27.2.2",
-    "jest-webgl-canvas-mock": "^0.2.3",
-    "rollup": "^2.46.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-terser": "^7.0.2"
+    "eslint": "^8.13.0",
+    "parse5": "^7.0.0",
+    "rollup": "^2.70.2",
+    "@rollup/plugin-node-resolve": "^13.2.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "typedoc": "^0.22.15"
   },
   "files": [
-    "/dist"
+    "/dist",
+    "/types"
   ]
 }

package/types/extras/ContextMenu/ContextMenu.d.ts

@@ -0,0 +1,125 @@
+export declare type ContextMenuConfiguration = {
+  /** The context menu items. These can also be dynamically set on {@link ContextMenu.items}. See the class documentation for an example. */
+  items?: any;
+  /** The context, which is passed into the item callbacks. This can also be dynamically set on {@link ContextMenu.context}. This must be set before calling {@link ContextMenu.show}. */
+  context?: any;
+  /** Whether this ````ContextMenu```` is initially enabled. {@link ContextMenu.show} does nothing while this is ````false````. */
+  enabled?: boolean;
+  /** Whether this ````ContextMenu```` automatically hides whenever we mouse-down or tap anywhere in the page. */
+  hideOnMouseDown?: boolean;
+};
+
+/**
+ * A customizable HTML context menu.
+ */
+export declare class ContextMenu {
+  /**
+   * @constructor
+   * 
+   * @param {ContextMenuConfiguration} [cfg] ````ContextMenu```` configuration.
+   */
+  constructor(cfg?: ContextMenuConfiguration);
+
+  /**
+   * Sets the ````ContextMenu```` items.
+   *
+   * These can be updated dynamically at any time.
+   *
+   * See class documentation for an example.
+   *
+   * @type {Object[]}
+   */
+  set items(arg: any[]);
+
+  /**
+   * Gets the ````ContextMenu```` items.
+   *
+   * @type {Object[]}
+   */
+  get items(): any[];
+
+  /**
+   * Sets the ````ContextMenu```` context.
+   *
+   * The context can be any object that you need to be provides to the callbacks configured on {@link ContextMenu.items}.
+   *
+   * This must be set before calling {@link ContextMenu.show}.
+   *
+   * @type {Object}
+   */
+  set context(arg: any);
+
+  /**
+   * Gets the ````ContextMenu```` context.
+   *
+   * @type {Object}
+   */
+  get context(): any;
+  
+  /**
+   * Sets whether this ````ContextMenu```` is enabled.
+   *
+   * Hides the menu when disabling.
+   *
+   * @type {Boolean}
+   */
+  set enabled(arg: boolean);
+
+  /**
+   * Gets whether this ````ContextMenu```` is enabled.
+   *
+   * {@link ContextMenu.show} does nothing while this is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get enabled(): boolean;
+  
+  /**
+   Subscribes to an event fired at this ````ContextMenu````.
+
+    @param {String} event The event
+    @param {Function} callback Callback fired on the event
+    */
+  on(event: string, callback: Function): void;
+
+  /**
+   Fires an event at this ````ContextMenu````.
+
+    @param {String} event The event type name
+    @param {Object} value The event parameters
+    */
+  fire(event: string, value: any): void;
+
+  /**
+   * Shows this ````ContextMenu```` at the given page coordinates.
+   *
+   * Does nothing when {@link ContextMenu.enabled} is ````false````.
+   *
+   * Logs error to console and does nothing if {@link ContextMenu.context} has not been set.
+   *
+   * Fires a "shown" event when shown.
+   *
+   * @param {Number} pageX Page X-coordinate.
+   * @param {Number} pageY Page Y-coordinate.
+   */
+  show(pageX: number, pageY: number): void;
+
+  /**
+   * Gets whether this ````ContextMenu```` is currently shown or not.
+   *
+   * @returns {Boolean} Whether this ````ContextMenu```` is shown.
+   */
+  get shown(): boolean;
+  
+  /**
+   * Hides this ````ContextMenu````.
+   *
+   * Fires a "hidden" event when hidden.
+   */
+  hide(): void;
+
+  /**
+   * Destroys this ````ContextMenu````.
+   */
+  destroy(): void;
+}

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

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

package/types/extras/index.d.ts

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

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./extras";
+export * from "./plugins";
+export * from "./viewer";

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

@@ -0,0 +1,144 @@
+import { Component } from "../../viewer/scene/Component";
+import { AngleMeasurementsPlugin } from "./AngleMeasurementsPlugin";
+import { Marker } from "../../viewer/scene/marker";
+
+/**
+ * @desc Measures the angle indicated by three 3D points.
+ */
+export declare class AngleMeasurement extends Component {
+  /**
+   * The {@link AngleMeasurementsPlugin} that owns this AngleMeasurement.
+   * @type {AngleMeasurementsPlugin}
+   */
+  plugin: AngleMeasurementsPlugin;
+  
+  /**
+   * Sets whether this AngleMeasurement indicates that its measurement is approximate.
+   *
+   * This is ````true```` by default.
+   *
+   * @type {Boolean}
+   */
+  set approximate(arg: boolean);
+  /**
+   * Gets whether this AngleMeasurement indicates that its measurement is approximate.
+   *
+   * This is ````true```` by default.
+   *
+   * @type {Boolean}
+   */
+  get approximate(): boolean;
+  /**
+   * Sets whether this AngleMeasurement is visible or not.
+   *
+   * @type Boolean
+   */
+  set visible(arg: boolean);
+  /**
+   * Gets whether this AngleMeasurement is visible or not.
+   *
+   * @type Boolean
+   */
+  get visible(): boolean;
+  /**
+   * Sets if the origin {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  set originVisible(arg: boolean);
+  /**
+   * Gets if the origin {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  get originVisible(): boolean;
+  /**
+   * Sets if the corner {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  set cornerVisible(arg: boolean);
+  /**
+   * Gets if the corner {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  get cornerVisible(): boolean;
+  /**
+   * Sets if the target {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  set targetVisible(arg: boolean);
+  /**
+   * Gets if the target {@link Marker} is visible.
+   *
+   * @type {Boolean}
+   */
+  get targetVisible(): boolean;
+  /**
+   * Sets if the wire between the origin and the corner is visible.
+   *
+   * @type {Boolean}
+   */
+  set originWireVisible(arg: boolean);
+  /**
+   * Gets if the wire between the origin and the corner is visible.
+   *
+   * @type {Boolean}
+   */
+  get originWireVisible(): boolean;
+  /**
+   * Sets if the wire between the target and the corner is visible.
+   *
+   * @type {Boolean}
+   */
+  set targetWireVisible(arg: boolean);
+  /**
+   * Gets if the wire between the target and the corner is visible.
+   *
+   * @type {Boolean}
+   */
+  get targetWireVisible(): boolean;
+  /**
+   * Sets if the angle label is visible.
+   *
+   * @type {Boolean}
+   */
+  set angleVisible(arg: boolean);
+  /**
+   * Gets if the angle label is visible.
+   *
+   * @type {Boolean}
+   */
+  get angleVisible(): boolean;
+  
+  /**
+   * Gets the origin {@link Marker}.
+   *
+   * @type {Marker}
+   */
+  get origin(): Marker;
+
+  /**
+   * Gets the corner {@link Marker}.
+   *
+   * @type {Marker}
+   */
+  get corner(): Marker;
+
+  /**
+   * Gets the target {@link Marker}.
+   *
+   * @type {Marker}
+   */
+  get target(): Marker;
+
+  /**
+   * Gets the angle between two connected 3D line segments, given
+   * as three positions on the surface(s) of one or more {@link Entity}s.
+   *
+   * @type {Number}
+   */
+  get angle(): number;
+}

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

@@ -0,0 +1,67 @@
+import { Component } from "../../viewer/scene/Component";
+import { AngleMeasurement } from "./AngleMeasurement";
+import { AngleMeasurementsPlugin } from "./AngleMeasurementsPlugin";
+
+/**
+ * Creates {@link AngleMeasurement}s from mouse and touch input.
+ *
+ * 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;
+
+  /**
+   * 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/AngleMeasurementsPlugin.d.ts

@@ -0,0 +1,99 @@
+import { Entity, Plugin, Viewer } from "../../viewer";
+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;
+};
+
+/**
+ * {@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);
+
+  /**
+   * 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};
+
+  /**
+   * 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;
+
+  /**
+   * 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 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/AngleMeasurementsPlugin/index.d.ts

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

package/types/plugins/AnnotationsPlugin/Annotation.d.ts

@@ -0,0 +1,135 @@
+import { Marker } from "../../viewer/scene/marker";
+import { AnnotationsPlugin } from "./AnnotationsPlugin";
+
+/**
+ * A {@link Marker} with an HTML label attached to it, managed by an {@link AnnotationsPlugin}.
+ */
+export declare class Annotation extends Marker {
+  /**
+   * The {@link AnnotationsPlugin} this Annotation was created by.
+   * @type {AnnotationsPlugin}
+   */
+  plugin: AnnotationsPlugin;
+
+  /**
+   * Optional World-space position for {@link Camera.eye}, used when this Annotation is associated with a {@link Camera} position.
+   *
+   * Undefined by default.
+   *
+   * @type {Number[]} Eye position.
+   */
+  eye: number[];
+  
+  /**
+   * Optional World-space position for {@link Camera.look}, used when this Annotation is associated with a {@link Camera} position.
+   *
+   * Undefined by default.
+   *
+   * @type {Number[]} The "look" vector.
+   */
+  look: number[];
+
+  /**
+   * Optional World-space position for {@link Camera.up}, used when this Annotation is associated with a {@link Camera} position.
+   *
+   * Undefined by default.
+   *
+   * @type {Number[]} The "up" vector.
+   */
+  up: number[];
+
+  /**
+   * Optional projection type for {@link Camera.projection}, used when this Annotation is associated with a {@link Camera} position.
+   *
+   * Undefined by default.
+   *
+   * @type {String} The projection type - "perspective" or "ortho"..
+   */
+  projection: string;
+
+  /**
+   * Sets whether or not to show this Annotation's marker.
+   *
+   * The marker shows the Annotation's position.
+   *
+   * The marker is only visible when both this property and {@link Annotation.visible} are ````true````.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @param {Boolean} shown Whether to show the marker.
+   */
+  setMarkerShown(shown: boolean): void;
+
+  /**
+   * Gets whether or not to show this Annotation's marker.
+   *
+   * The marker shows the Annotation's position.
+   *
+   * The marker is only visible when both this property and {@link Annotation.visible} are ````true````.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @returns {Boolean} Whether to show the marker.
+   */
+  getMarkerShown(): boolean;
+
+  /**
+   * Sets whether or not to show this Annotation's label.
+   *
+   * The label is only visible when both this property and {@link Annotation.visible} are ````true````.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @param {Boolean} shown Whether to show the label.
+   */
+  setLabelShown(shown: boolean): void;
+
+  /**
+   * Gets whether or not to show this Annotation's label.
+   *
+   * The label is only visible when both this property and {@link Annotation.visible} are ````true````.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @returns {Boolean} Whether to show the label.
+   */
+  getLabelShown(): boolean;
+
+  /**
+   * Sets the value of a field within the HTML templates for either the Annotation's marker or label.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @param {String} key Identifies the field.
+   * @param {String} value The field's value.
+   */
+  setField(key: string, value: string): void;
+
+  /**
+   * Gets the value of a field within the HTML templates for either the Annotation's marker or label.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @param {String} key Identifies the field.
+   * @returns {String} The field's value.
+   */
+  getField(key: string): string;
+
+  /**
+   * Sets values for multiple placeholders within the Annotation's HTML templates for marker and label.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @param {{String:(String|Number)}} values Map of field values.
+   */
+  setValues(values: { [key:string] : string | number }): void;
+
+  /**
+   * Gets the values that were set for the placeholders within this Annotation's HTML marker and label templates.
+   *
+   * See {@link AnnotationsPlugin} for more info.
+   *
+   * @RETURNS {{String:(String|Number)}} Map of field values.
+   */
+  getValues(): { [key:string] : string | number };
+}