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

package/types/plugins/AxisGizmoPlugin/AxisGizmoPlugin.d.ts

@@ -0,0 +1,28 @@
+import { Plugin, Viewer } from "../../viewer";
+
+export declare type AxisGizmoPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** ID of an existing HTML canvas to display the AxisGizmo - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  canvasId?: string;
+  /** Reference of an existing HTML canvas to display the AxisGizmo - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  canvasElement?: HTMLCanvasElement;
+}
+
+/**
+ * {@link Viewer} plugin that shows the axii of the World-space coordinate system.
+ */
+export declare class AxisGizmoPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   * @param {AxisGizmoPluginConfiguration} cfg  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg:AxisGizmoPluginConfiguration );
+
+  /** Shows or hides this AxisGizmoPlugin.
+   *
+   * @param visible
+   */
+  setVisible(visible: boolean): void;
+}

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

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

package/types/plugins/BCFViewpointsPlugin/BCFViewpointsPlugin.d.ts

@@ -0,0 +1,146 @@
+import { Plugin, Viewer } from "../../viewer";
+
+export declare type BCFViewpointsPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** Identifies the originating system for BCF records. */
+  originatingSystem?: string;
+  /** Identifies the authoring tool for BCF records. */
+  authoringTool?: string;
+};
+
+/**
+ * {@link Viewer} plugin that saves and loads BCF viewpoints as JSON objects.
+ */
+export class BCFViewpointsPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   * @param {BCFViewpointsPluginConfiguration} cfg  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?:BCFViewpointsPluginConfiguration );
+
+  /**
+   * Identifies the originating system to include in BCF viewpoints saved by this plugin.
+   * @type {string}
+   */
+  originatingSystem: string;
+
+  /**
+   * Identifies the authoring tool to include in BCF viewpoints saved by this plugin.
+   * @type {string}
+   */
+  authoringTool: string;
+
+  /**
+   * Saves viewer state to a BCF viewpoint.
+   *
+   * Note that xeokit's {@link Camera#look} is the **point-of-interest**, whereas the BCF ````camera_direction```` is a
+   * direction vector. Therefore, we save ````camera_direction```` as the vector from {@link Camera#eye} to {@link Camera#look}.
+   *
+   * @param {*} [options] Options for getting the viewpoint.
+   * @param {Boolean} [options.spacesVisible=false] Indicates whether ````IfcSpace```` types should be forced visible in the viewpoint.
+   * @param {Boolean} [options.openingsVisible=false] Indicates whether ````IfcOpening```` types should be forced visible in the viewpoint.
+   * @param {Boolean} [options.spaceBoundariesVisible=false] Indicates whether the boundaries of ````IfcSpace```` types should be visible in the viewpoint.
+   * @param {Boolean} [options.snapshot=true] Indicates whether the snapshot should be included in the viewpoint.
+   * @param {Boolean} [options.defaultInvisible=false] When ````true````, will save the default visibility of all objects
+   * as ````false````. This means that when we load the viewpoint again, and there are additional models loaded that
+   * were not saved in the viewpoint, those models will be hidden when we load the viewpoint, and that only the
+   * objects in the viewpoint will be visible.
+   * @param {Boolean} [options.reverseClippingPlanes=false] When ````true````, clipping planes are reversed (https://github.com/buildingSMART/BCF-XML/issues/193)
+   * @returns {*} BCF JSON viewpoint object
+   * @example
+   *
+   * const viewer = new Viewer();
+   *
+   * const bcfPlugin = new BCFPlugin(viewer, {
+   *     //...
+   * });
+   *
+   * const viewpoint = bcfPlugin.getViewpoint({ // Options - see constructor
+   *     spacesVisible: false,          // Default
+   *     spaceBoundariesVisible: false, // Default
+   *     openingsVisible: false         // Default
+   * });
+   *
+   * // viewpoint will resemble the following:
+   *
+   * {
+   *     perspective_camera: {
+   *         camera_view_point: {
+   *             x: 0.0,
+   *             y: 0.0,
+   *             z: 0.0
+   *         },
+   *         camera_direction: {
+   *             x: 1.0,
+   *             y: 1.0,
+   *             z: 2.0
+   *         },
+   *         camera_up_vector: {
+   *             x: 0.0,
+   *             y: 0.0,
+   *             z: 1.0
+   *         },
+   *         field_of_view: 90.0
+   *     },
+   *     lines: [],
+   *     clipping_planes: [{
+   *         location: {
+   *             x: 0.5,
+   *             y: 0.5,
+   *             z: 0.5
+   *         },
+   *         direction: {
+   *             x: 1.0,
+   *             y: 0.0,
+   *             z: 0.0
+   *         }
+   *     }],
+   *     bitmaps: [],
+   *     snapshot: {
+   *         snapshot_type: png,
+   *         snapshot_data: "data:image/png;base64,......"
+   *     },
+   *     components: {
+   *         visibility: {
+   *             default_visibility: false,
+   *             exceptions: [{
+   *                 ifc_guid: 4$cshxZO9AJBebsni$z9Yk,
+   *                 originating_system: xeokit.io,
+   *                 authoring_tool_id: xeokit/v1.0
+   *             }]
+   *        },
+   *         selection: [{
+   *            ifc_guid: "4$cshxZO9AJBebsni$z9Yk",
+   *         }]
+   *     }
+   * }
+   */
+  getViewpoint(options?: any): any;
+
+  /**
+   * Sets viewer state to the given BCF viewpoint.
+   *
+   * Note that xeokit's {@link Camera#look} is the **point-of-interest**, whereas the BCF ````camera_direction```` is a
+   * direction vector. Therefore, when loading a BCF viewpoint, we set {@link Camera#look} to the absolute position
+   * obtained by offsetting the BCF ````camera_view_point````  along ````camera_direction````.
+   *
+   * When loading a viewpoint, we also have the option to find {@link Camera#look} as the closest point of intersection
+   * (on the surface of any visible and pickable {@link Entity}) with a 3D ray fired from ````camera_view_point```` in
+   * the direction of ````camera_direction````.
+   *
+   * @param {*} bcfViewpoint  BCF JSON viewpoint object,
+   * shows default visible entities and restores camera to initial default position.
+   * @param {*} [options] Options for setting the viewpoint.
+   * @param {Boolean} [options.rayCast=true] When ````true```` (default), will attempt to set {@link Camera#look} to the closest
+   * point of surface intersection with a ray fired from the BCF ````camera_view_point```` in the direction of ````camera_direction````.
+   * @param {Boolean} [options.immediate=true] When ````true```` (default), immediately set camera position.
+   * @param {Boolean} [options.duration] Flight duration in seconds.  Overrides {@link CameraFlightAnimation#duration}. Only applies when ````immediate```` is ````false````.
+   * @param {Boolean} [options.reset=true] When ````true```` (default), set {@link Entity#xrayed} and {@link Entity#highlighted} ````false```` on all scene objects.
+   * @param {Boolean} [options.reverseClippingPlanes=false] When ````true````, clipping planes are reversed (https://github.com/buildingSMART/BCF-XML/issues/193)
+   * @param {Boolean} [options.updateCompositeObjects=false] When ````true````, then when visibility and selection updates refer to composite objects (eg. an IfcBuildingStorey),
+   * then this method will apply the updates to objects within those composites.
+   */
+  setViewpoint(bcfViewpoint: any, options?: any): void;
+}

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

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

package/types/plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts

@@ -0,0 +1,81 @@
+import { Plugin, Viewer, PerformanceModel } from "../../viewer";
+import { ModelStats } from "../index";
+
+export declare interface ICityJSONDefaultDataSource {
+  /**
+   * Gets the contents of the given CityJSON file.
+   *
+   * @param {String|Number} src Path or ID of an CityJSON file.
+   * @param {Function} ok Callback fired on success, argument is the CityJSON JSON.
+   * @param {Function} error Callback fired on error.
+   */
+  getCityJSON(src: string | number, ok: (json: any)=> void, error: (e: Error)=> void): void;
+}
+
+export declare type CityJSONLoaderPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** A custom data source through which the CityJSONLoaderPlugin can load model and metadata files. Defaults to an instance of {@link CityJSONDefaultDataSource}, which loads over HTTP.*/
+  dataSource?: ICityJSONDefaultDataSource;
+};
+
+export declare type LoadCityJSONModel = {
+  /** ID to assign to the root {@link Entity#id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
+  id?: string;
+  /** Path to a CityJSON file, as an alternative to the ````cityJSON```` parameter. */
+  src?: string;
+  /** The CityJSON file data, as an alternative to the ````src```` parameter. */
+  cityJSON?: ArrayBuffer;
+  /** Whether to load metadata on CityJSON objects. */
+  loadMetadata?: boolean;
+  /** The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates. */
+  origin?: number[];
+  /** The model single-precision 3D position, relative to the ````origin```` parameter. */
+  position?: number[];
+  /** The model's scale. */
+  scale?: number[];
+  /** The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis. */
+  rotation?: number[];
+  /**  The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to ````origin````. */
+  matrix?: number[];
+  /** Collects model statistics. */
+  stats?: ModelStats;
+};
+
+/**
+ * {@link Viewer} plugin that loads models from CityJSON files.
+ */
+export declare class CityJSONLoaderPlugin extends Plugin {
+  /**
+   * @constructor
+   *
+   * @param {Viewer} viewer The Viewer.
+   * @param {CityJSONLoaderPluginConfiguration} cfg  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?: CityJSONLoaderPluginConfiguration);
+
+  /**
+   * Sets a custom data source through which the CityJSONLoaderPlugin can load CityJSON files.
+   *
+   * Default value is {@link CityJSONDefaultDataSource}, which loads via HTTP.
+   *
+   * @type {Object}
+   */
+  set dataSource(arg: ICityJSONDefaultDataSource);
+
+  /**
+   * Gets the custom data source through which the CityJSONLoaderPlugin can load CityJSON files.
+   *
+   * Default value is {@link CityJSONDefaultDataSource}, which loads via HTTP.
+   *
+   * @type {Object}
+   */
+  get dataSource(): ICityJSONDefaultDataSource;
+
+  /**
+   * Loads an ````CityJSON```` model into this CityJSONLoaderPlugin's {@link Viewer}.
+   *
+   * @param {LoadCityJSONModel} params Loading parameters.
+   */
+  load(params: LoadCityJSONModel): PerformanceModel;
+}

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

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

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

@@ -0,0 +1,137 @@
+import { Component } from "../../viewer/scene/Component";
+import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin";
+import { Marker } from "../../viewer/scene/marker";
+
+/**
+ * @desc Measures the distance between two 3D points.
+ */
+export class DistanceMeasurement extends Component {
+  /**
+   * The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurement.
+   * @type {DistanceMeasurementsPlugin}
+   */
+  plugin: DistanceMeasurementsPlugin;
+
+  /**
+   * Sets whether this DistanceMeasurement indicates that its measurement is approximate.
+   *
+   * This is ````true```` by default.
+   *
+   * @type {Boolean}
+   */
+  set approximate(arg: boolean);
+
+  /**
+   * Gets whether this DistanceMeasurement indicates that its measurement is approximate.
+   *
+   * This is ````true```` by default.
+   *
+   * @type {Boolean}
+   */
+  get approximate(): boolean;
+
+  /**
+   * Sets whether this DistanceMeasurement is visible or not.
+   *
+   * @type Boolean
+   */
+  set visible(arg: boolean);
+
+  /**
+   * Gets whether this DistanceMeasurement 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 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 direct point-to-point wire between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} is visible.
+   *
+   * @type {Boolean}
+   */
+  set wireVisible(arg: boolean);
+
+  /**
+   * Gets if the direct point-to-point wire between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} is visible.
+   *
+   * @type {Boolean}
+   */
+  get wireVisible(): boolean;
+
+  /**
+   * Sets if the axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are visible.
+   *
+   * @type {Boolean}
+   */
+  set axisVisible(arg: boolean);
+
+  /**
+   * Gets if the axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are visible.
+   *
+   * @type {Boolean}
+   */
+  get axisVisible(): boolean;
+
+  /**
+   * Gets the origin {@link Marker}.
+   *
+   * @type {Marker}
+   */
+  get origin(): Marker;
+  
+  /**
+   * Gets the target {@link Marker}.
+   *
+   * @type {Marker}
+   */
+  get target(): Marker;
+  
+  /**
+   * Gets the World-space direct point-to-point distance between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target}.
+   *
+   * @type {Number}
+   */
+  get length(): number;
+
+  /**
+   * Sets the color.
+   *
+   * @type {String}
+   */
+  set color(arg: string);
+
+  /**
+   * Gets the color.
+   *
+   * @type {String}
+   */
+  get color(): string;
+}

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

@@ -0,0 +1,40 @@
+import { Component } from "../../viewer/scene/Component";
+import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin";
+
+/**
+ * Creates {@link DistanceMeasurement}s from mouse and touch input.
+ */
+export class DistanceMeasurementsControl extends Component {
+  /**
+   * The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurementsControl.
+   * @type {DistanceMeasurementsPlugin}
+   */
+  plugin: DistanceMeasurementsPlugin;
+  
+  /** Gets if this DistanceMeasurementsControl is currently active, where it is responding to input.
+   *
+   * @returns {boolean}
+   */
+  get active(): boolean;
+
+  /**
+   * Activates this DistanceMeasurementsControl, ready to respond to input.
+   */
+  activate(): void;
+  
+  /**
+   * Deactivates this DistanceMeasurementsControl, making it unresponsive to input.
+   *
+   * Destroys any {@link DistanceMeasurement} under construction.
+   */
+  deactivate(): void;
+
+  /**
+   * Resets this DistanceMeasurementsControl.
+   *
+   * Destroys any {@link DistanceMeasurement} under construction.
+   *
+   * Does nothing if the DistanceMeasurementsControl is not active.
+   */
+  reset(): void;
+}

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

@@ -0,0 +1,120 @@
+import { Entity, Plugin, Viewer } from "../../viewer";
+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;
+};
+
+/**
+ * {@link Viewer} plugin for measuring point-to-point distances.
+ */
+export 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);
+
+  /**
+   * 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;
+
+  /**
+   * Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement#id}.
+   *
+   * @type {{String:DistanceMeasurement}}
+   */
+  get measurements(): { [key:string]: DistanceMeasurement };
+
+  /**
+   * 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;
+
+  /**
+   * Destroys all {@link DistanceMeasurement}s.
+   */
+  clear(): void;
+}

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

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