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

package/types/plugins/OBJLoaderPlugin/OBJLoaderPlugin.d.ts

@@ -0,0 +1,44 @@
+import { Plugin, Viewer, PerformanceModel } from "../../viewer";
+
+export declare type LoadOBJModel = {
+  /** ID to assign to the model's root {@link Entity}, unique among all components in the Viewer's {@link Scene}. */
+  id: string;
+  /** Path to an OBJ file. */
+  src: string;
+  /** Path to an optional metadata file. */
+  metaModelSrc?: string;
+  /** The model World-space 3D position. */
+  position?: number[];
+  /** The model's World-space scale. */
+  scale?: number[];
+  /** The model's World-space rotation, as Euler angles given 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. */
+  matrix?: number[];
+  /** When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn. */
+  edgeThreshold?: number;
+};
+
+/**
+ * {@link Viewer} plugin that loads models from [OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file) files.
+ */
+export declare class OBJLoaderPlugin extends Plugin {
+  /**
+   * @constructor
+   *
+   * @param {Viewer} viewer The Viewer.
+   * @param {Object} cfg Plugin configuration.
+   * @param {String} [cfg.id="OBJLoader"] Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}.
+   */
+  constructor(viewer: Viewer, cfg: {
+      id?: string;
+  });
+  
+  /**
+   * Loads an OBJ model from a file into this OBJLoader's {@link Viewer}.
+   *
+   * @param {LoadOBJModel} params  Loading parameters.
+   * @returns {PerformanceModel} Entity representing the model, which will have {@link Entity#isModel} set ````true```` and will be registered by {@link Entity#id} in {@link Scene#models}
+   */
+  load(params: LoadOBJModel): PerformanceModel;
+}

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

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

package/types/plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts

@@ -0,0 +1,88 @@
+import { Plugin, Viewer, PerformanceModel } from "../../viewer";
+
+export declare interface ISTLDefaultDataSource {
+  /**
+   * Gets STL data.
+   *
+   * @param {String|Number} src Identifies the STL file.
+   * @param {Function} ok Fired on successful loading of the STL file.
+   * @param {Function} error Fired on error while loading the STL file.
+   */
+  getSTL(src: string | number, ok: Function, error: Function): void;
+}
+
+export declare type STLLoaderPluginCOnfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** A custom data source through which the STLLoaderPlugin can load STL files. Defaults to an instance of {@link STLDefaultDataSource}, which loads over HTTP. */
+  dataSource?: ISTLDefaultDataSource;
+};
+
+export declare type LoadSTLModel = {
+  /** ID to assign to the model's root {@link Entity}, unique among all components in the Viewer's {@link Scene}. */
+  id: string;
+  /** Path to an STL file. Overrides the ````stl```` parameter. */
+  src?: string;
+  /** Contents of an STL file, either binary of ASCII. Overridden by the ````src```` parameter. */
+  stl?: string;
+  /** Whether or not to renders the model with edges emphasized. */
+  edges?: 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. */
+  matrix?: number[];
+  /** When true, allows visible backfaces, wherever specified in the 3DXML. When false, ignores backfaces. */
+  backfaces?: boolean;
+  /** When true, automatically converts face-oriented normals to vertex normals for a smooth appearance. */
+  smoothNormals?: boolean;
+  /** When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn. */
+  smoothNormalsAngleThreshold?: number;
+  /** When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn. */
+  edgeThreshold?: number;
+  /** When true, creates a separate {@link Mesh} for each group of faces that share the same vertex colors. Only works with binary STL. */
+  splitMeshes?: boolean;
+};
+
+/**
+ * {@link Viewer} plugin that loads models from <a href="https://en.wikipedia.org/wiki/STL_(file_format)">STL</a> files.
+ */
+export declare class STLLoaderPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   * @param {STLLoaderPluginCOnfiguration} [cfg]  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?: STLLoaderPluginCOnfiguration);
+
+  /**
+   * Sets a custom data source through which the STLLoaderPlugin can load STL files.
+   *
+   * Default value is {@link STLDefaultDataSource}, which loads via an XMLHttpRequest.
+   *
+   * @type {ISTLDefaultDataSource}
+   */
+  set dataSource(arg: ISTLDefaultDataSource);
+
+  /**
+   * Gets the custom data source through which the STLLoaderPlugin can load STL files.
+   *
+   * Default value is {@link STLDefaultDataSource}, which loads via an XMLHttpRequest.
+   *
+   * @type {ISTLDefaultDataSource}
+   */
+  get dataSource(): ISTLDefaultDataSource;
+
+  /**
+   * Loads an STL model from a file into this STLLoaderPlugin's {@link Viewer}.
+   *
+   * @param {LoadSTLModel} params Loading parameters.
+   * @returns {PerformanceModel} Entity representing the model, which will have {@link Entity#isModel} set ````true```` and will be registered by {@link Entity#id} in {@link Scene#models}
+   */
+  load(params: LoadSTLModel): PerformanceModel;
+}

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

@@ -0,0 +1,2 @@
+export * from "./STLDefaultDataSource.js";
+export * from "./STLLoaderPlugin";

package/types/plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts

@@ -0,0 +1,103 @@
+import { Plugin, Viewer } from "../../viewer";
+import { SectionPlane } from "../../viewer/scene/sectionPlane";
+
+export declare type SectionPlanesPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** ID of a canvas element to display the overview. */
+  overviewCanvasId?: string;
+  /** Initial visibility of the overview canvas. */
+  overviewVisible?: string;
+};
+
+/**
+ * SectionPlanesPlugin is a {@link Viewer} plugin that manages {@link SectionPlane}s.
+ */
+export declare class SectionPlanesPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   * @param {SectionPlanesPluginConfiguration} cfg Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?: SectionPlanesPluginConfiguration);
+  
+  /**
+   * Sets if the overview canvas is visible.
+   *
+   * @param {Boolean} visible Whether or not the overview canvas is visible.
+   */
+  setOverviewVisible(visible: boolean): void;
+  
+  /**
+   * Gets if the overview canvas is visible.
+   *
+   * @return {Boolean} True when the overview canvas is visible.
+   */
+  getOverviewVisible(): boolean;
+
+  /**
+   * Returns a map of the {@link SectionPlane}s created by this SectionPlanesPlugin.
+   *
+   * @returns {{String:SectionPlane}} A map containing the {@link SectionPlane}s, each mapped to its {@link SectionPlane#id}.
+   */
+  get sectionPlanes(): { [key:string]: SectionPlane };
+
+  /**
+   * Creates a {@link SectionPlane}.
+   *
+   * The {@link SectionPlane} will be registered by {@link SectionPlane#id} in {@link SectionPlanesPlugin#sectionPlanes}.
+   *
+   * @param {Object} params {@link SectionPlane} configuration.
+   * @param {String} [params.id] Unique ID to assign to the {@link SectionPlane}. Must be unique among all components in the {@link Viewer}'s {@link Scene}. Auto-generated when omitted.
+   * @param {Number[]} [params.pos=[0,0,0]] World-space position of the {@link SectionPlane}.
+   * @param {Number[]} [params.dir=[0,0,-1]] World-space vector indicating the orientation of the {@link SectionPlane}.
+   * @param {Boolean} [params.active=true] Whether the {@link SectionPlane} is initially active. Only clips while this is true.
+   * @returns {SectionPlane} The new {@link SectionPlane}.
+   */
+  createSectionPlane(params?: {
+      id?: string;
+      pos?: number[];
+      dir?: number[];
+      active?: boolean;
+  }): SectionPlane;
+  
+  /**
+   * Inverts the direction of {@link SectionPlane#dir} on every existing SectionPlane.
+   *
+   * Inverts all SectionPlanes, including those that were not created with SectionPlanesPlugin.
+   */
+  flipSectionPlanes(): void;
+
+  /**
+   * Shows the 3D editing gizmo for a {@link SectionPlane}.
+   *
+   * @param {String} id ID of the {@link SectionPlane}.
+   */
+  showControl(id: string): void;
+
+  /**
+   * Gets the ID of the {@link SectionPlane} that the 3D editing gizmo is shown for.
+   *
+   * Returns ````null```` when the editing gizmo is not shown.
+   *
+   * @returns {String} ID of the the {@link SectionPlane} that the 3D editing gizmo is shown for, if shown, else ````null````.
+   */
+  getShownControl(): string;
+
+  /**
+   * Hides the 3D {@link SectionPlane} editing gizmo if shown.
+   */
+  hideControl(): void;
+
+  /**
+   * Destroys a {@link SectionPlane} created by this SectionPlanesPlugin.
+   *
+   * @param {String} id ID of the {@link SectionPlane}.
+   */
+  destroySectionPlane(id: string): void;
+
+  /**
+   * Destroys all {@link SectionPlane}s created by this SectionPlanesPlugin.
+   */
+  clear(): void;
+}

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

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

package/types/plugins/SkyboxesPlugin/SkyboxesPlugin.d.ts

@@ -0,0 +1,34 @@
+import { Plugin, Viewer } from "../../viewer";
+
+/**
+ * {@link Viewer} plugin that manages skyboxes
+ */
+export class SkyboxesPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   */
+  constructor(viewer: Viewer);
+  
+  /**
+   * Creates a skybox.
+   * @param {String} id Unique ID to assign to the skybox.
+   * @param {Object} params Skybox configuration.
+   * @param {Boolean} [params.active=true] Whether the skybox plane is initially active. Only skyboxes while this is true.
+   * @returns {Skybox} The new skybox.
+   */
+  createSkybox(id: string, params: {
+      active?: boolean;
+  }): any; //Skybox;
+  
+  /**
+   * Destroys a skybox.
+   * @param id
+  */
+  destroySkybox(id: string): void;
+
+  /**
+   Destroys all skyboxes.
+    */
+  clear(): void;
+}

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

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

package/types/plugins/StoreyViewsPlugin/Storey.d.ts

@@ -0,0 +1,47 @@
+import { StoreyViewsPlugin } from "./StoreyViewsPlugin";
+
+/**
+ * Information about an ````IfcBuildingStorey````.
+ */
+export declare class Storey {
+  /**
+   * The {@link StoreyViewsPlugin} this Storey belongs to.
+   *
+   * @type {StoreyViewsPlugin}
+   */
+  plugin: StoreyViewsPlugin;
+
+  /**
+   * ID of the IfcBuildingStorey.
+   *
+   * This matches IDs of the IfcBuildingStorey's {@link MetaObject} and {@link Entity}.
+   *
+   * @type {String}
+   */
+  storeyId: string;
+
+  /**
+   * ID of the model.
+   *
+   * This matches the ID of the {@link MetaModel} that contains the IfcBuildingStorey's {@link MetaObject}.
+   *
+   * @type {String|Number}
+   */
+  modelId: string | number;
+
+  /**
+   * Axis-aligned World-space boundary of the {@link Entity}s that represent the IfcBuildingStorey.
+   *
+   * The boundary is a six-element Float32Array containing the min/max extents of the
+   * axis-aligned boundary, ie. ````[xmin, ymin, zmin, xmax, ymax, zmax]````
+   *
+   * @type {Number[]}
+   */
+  aabb: number[];
+
+  /** Number of {@link Entity}s within the IfcBuildingStorey.
+   *
+   * @type {Number}
+   */
+  numObjects: number;
+}

package/types/plugins/StoreyViewsPlugin/StoreyMap.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @desc A 2D plan view image of an ````IfcBuildingStorey````.
+ */
+export declare class StoreyMap {
+  /**
+   * ID of the IfcBuildingStorey.
+   *
+   * This matches IDs of the IfcBuildingStorey's {@link MetaObject} and {@link Entity}.
+   *
+   * @type {String}
+   */
+  storeyId: string;
+
+  /**
+   * Base64-encoded plan view image.
+   *
+   * @type {String}
+   */
+  imageData: string;
+
+  /**
+   * The image format - "png" or "jpeg".
+   *
+   * @type {String}
+   */
+  format: string;
+
+  /**
+   * Width of the image, in pixels.
+   *
+   * @type {Number}
+   */
+  width: number;
+
+  /**
+   * Height of the image, in pixels.
+   *
+   * @type {Number}
+   */
+  height: number;
+}

package/types/plugins/StoreyViewsPlugin/StoreyViewsPlugin.d.ts

@@ -0,0 +1,173 @@
+import { PickResult } from "../../viewer/scene/webgl/PickResult";
+import { Plugin, Viewer } from "../../viewer";
+import { Storey } from "./Storey";
+import { StoreyMap } from "./StoreyMap";
+
+export declare type IFCStoreyPlanObjectStates = {
+  [key: string] : {
+    visible: boolean;
+    edges?: boolean;
+    colorize?: number[]
+  }
+};
+
+export declare type StoreyViewsPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** Map of visual states for the {@link Entity}s as rendered within each {@link Storey}.  Default value is {@link IFCStoreyPlanObjectStates}. */
+  objectStates?: IFCStoreyPlanObjectStates;
+};
+
+/**
+ * A {@link Viewer} plugin that provides methods for visualizing IfcBuildingStoreys.
+ */
+export declare class StoreyViewsPlugin extends Plugin {
+    /**
+     * @constructor
+     *
+     * @param {Viewer} viewer The Viewer.
+     * @param {StoreyViewsPluginConfiguration} cfg  Plugin configuration.
+     */
+    constructor(viewer: Viewer, cfg?: StoreyViewsPluginConfiguration);
+
+    /**
+     * A {@link Storey} for each ````IfcBuildingStorey```.
+     *
+     * There will be a {@link Storey} for every existing {@link MetaObject} whose {@link MetaObject#type} equals "IfcBuildingStorey".
+     *
+     * These are created and destroyed automatically as models are loaded and destroyed.
+     *
+     * @type {{String:Storey}}
+     */
+    storeys: {[key: string]: Storey };
+
+    /**
+     * A set of {@link Storey}s for each {@link MetaModel}.
+     *
+     * These are created and destroyed automatically as models are loaded and destroyed.
+     *
+     * @type {{String: {String:Storey}}}
+     */
+    modelStoreys: {[key: string]: { [key: string]: Storey} };
+
+    /**
+     * Sets map of visual states for the {@link Entity}s as rendered within each {@link Storey}.
+     *
+     * Default value is {@link IFCStoreyPlanObjectStates}.
+     *
+     * @type {IFCStoreyPlanObjectStates}
+     */
+    set objectStates(arg: IFCStoreyPlanObjectStates);
+
+    /**
+     * Gets map of visual states for the {@link Entity}s as rendered within each {@link Storey}.
+     *
+     * Default value is {@link IFCStoreyPlanObjectStates}.
+     *
+     * @type {IFCStoreyPlanObjectStates}
+     */
+    get objectStates(): IFCStoreyPlanObjectStates;
+
+    /**
+     * Arranges the {@link Camera} for a 3D orthographic view of the {@link Entity}s within the given storey.
+     *
+     * See also: {@link CameraMemento}, which saves and restores the state of the {@link Scene}'s {@link Camera}
+     *
+     * @param {String} storeyId ID of the ````IfcBuildingStorey```` object.
+     * @param {*} [options] Options for arranging the Camera.
+     * @param {String} [options.projection] Projection type to transition the Camera to. Accepted values are "perspective" and "ortho".
+     * @param {Function} [options.done] Callback to fire when the Camera has arrived. When provided, causes an animated flight to the saved state. Otherwise jumps to the saved state.
+     */
+    gotoStoreyCamera(storeyId: string, options?: {
+      projection?: string;
+      done?: Function
+    }): void;
+
+    /**
+     * Shows the {@link Entity}s within the given storey.
+     *
+     * Optionally hides all other Entitys.
+     *
+     * Optionally sets the visual appearance of each of the Entitys according to its IFC type. The appearance of
+     * IFC types in plan views is configured by {@link StoreyViewsPlugin#objectStates}.
+     *
+     * See also: {@link ObjectsMemento}, which saves and restores a memento of the visual state
+     * of the {@link Entity}'s that represent objects within a {@link Scene}.
+     *
+     * @param {String} storeyId ID of the ````IfcBuildingStorey```` object.
+     * @param {*} [options] Options for showing the Entitys within the storey.
+     * @param {Boolean} [options.hideOthers=false] When ````true````, hide all other {@link Entity}s.
+     * @param {Boolean} [options.useObjectStates=false] When ````true````, apply the custom visibilities and appearances configured for IFC types in {@link StoreyViewsPlugin#objectStates}.
+     */
+    showStoreyObjects(storeyId: string, options?: {
+      hideOthers?: boolean;
+      useObjectStates?: boolean
+    }): void;
+
+    /**
+     * Executes a callback on each of the objects within the given storey.
+     *
+     *
+     * @param {String} storeyId ID of the ````IfcBuildingStorey```` object.
+     * @param {Function} callback The callback.
+     */
+    withStoreyObjects(storeyId: string, callback: Function): void;
+
+    /**
+     * Creates a 2D map of the given storey.
+     *
+     * @param {String} storeyId ID of the ````IfcBuildingStorey```` object.
+     * @param {*} [options] Options for creating the image.
+     * @param {Number} [options.width=300] Image width in pixels. Height will be automatically determined from this, if not given.
+     * @param {Number} [options.height=300] Image height in pixels, as an alternative to width. Width will be automatically determined from this, if not given.
+     * @param {String} [options.format="png"] Image format. Accepted values are "png" and "jpeg".
+     * @returns {StoreyMap} The StoreyMap.
+     */
+    createStoreyMap(storeyId: string, options?: {
+      width?: number;
+      height?: number;
+      format?: "png" | "jpeg";
+    }): StoreyMap;
+
+    /**
+     * Attempts to pick an {@link Entity} at the given pixel coordinates within a StoreyMap image.
+     *
+     * @param {StoreyMap} storeyMap The StoreyMap.
+     * @param {Number[]} imagePos 2D pixel coordinates within the bounds of {@link StoreyMap#imageData}.
+     * @param {*} [options] Picking options.
+     * @param {Boolean} [options.pickSurface=false] Whether to return the picked position on the surface of the Entity.
+     * @returns {PickResult} The pick result, if an Entity was successfully picked, else null.
+     */
+    pickStoreyMap(storeyMap: StoreyMap, imagePos: number[], options?: {
+      pickSurface?: boolean;
+    }): PickResult;
+
+    /**
+     * Gets the ID of the storey that contains the given 3D World-space position.
+     *.
+     * @param {Number[]} worldPos 3D World-space position.
+     * @returns {String} ID of the storey containing the position, or null if the position falls outside all the storeys.
+     */
+    getStoreyContainingWorldPos(worldPos: number[]): string;
+
+    /**
+     * Converts a 3D World-space position to a 2D position within a StoreyMap image.
+     *
+     * Use {@link StoreyViewsPlugin#pickStoreyMap} to convert 2D image positions to 3D world-space.
+     *
+     * @param {StoreyMap} storeyMap The StoreyMap.
+     * @param {Number[]} worldPos 3D World-space position within the storey.
+     * @param {Number[]} imagePos 2D pixel position within the {@link StoreyMap#imageData}.
+     * @returns {Boolean} True if ````imagePos```` is within the bounds of the {@link StoreyMap#imageData}, else ````false```` if it falls outside.
+     */
+    worldPosToStoreyMap(storeyMap: StoreyMap, worldPos: number[], imagePos: number[]): boolean;
+
+    /**
+     * Converts a 3D World-space direction vector to a 2D vector within a StoreyMap image.
+     *
+     * @param {StoreyMap} storeyMap The StoreyMap.
+     * @param {Number[]} worldDir 3D World-space direction vector.
+     * @param {Number[]} imageDir Normalized 2D direction vector.
+     */
+    worldDirToStoreyMap(storeyMap: StoreyMap, worldDir: number[], imageDir: number[]): void;
+}

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

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

package/types/plugins/TreeViewPlugin/ModelTreeView.d.ts

@@ -0,0 +1,24 @@
+import { MetaModel } from "../../viewer/metadata";
+
+/**
+ * Represents a model tree view within a {@link TreeViewPlugin}.
+ */
+export declare class ModelTreeView {
+  /**
+   * Contains messages for any errors found in the MetaModel for this ModelTreeView.
+   * @type {String[]}
+   */
+  errors: string[];
+
+  /**
+   * True if errors were found in the MetaModel for this ModelTreeView.
+   * @type {boolean}
+   */
+  valid: boolean;
+
+  /**
+   * The MetaModel corresponding to this ModelTreeView.
+   * @type {MetaModel}
+   */
+  metaModel: MetaModel;
+}

package/types/plugins/TreeViewPlugin/TreeViewNode.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A node within a {@link TreeViewPlugin}.
+ */
+export declare class TreeViewNode {
+  /**
+   * Globally unique node ID.
+   *
+   * @type {String}
+   * @abstract
+   */
+  get nodeId(): string;
+
+  /**
+   * Title of the TreeViewNode.
+   *
+   * @type {String}
+   * @abstract
+   */
+  get title(): string;
+
+  /**
+   * ID of the corresponding {@link MetaObject}.
+   *
+   * This is only defined if the TreeViewNode represents an object.
+   *
+   * @type {Number|String}
+   * @abstract
+   */
+  get objectId(): string | number;
+
+  /**
+   * The child TreeViewNodes.
+   *
+   * @type {Array}
+   * @abstract
+   */
+  get children(): any[];
+
+  /** The parent TreeViewNode.
+   *
+   * @type {TreeViewNode}
+   * @abstract
+   */
+  get parent(): TreeViewNode;
+
+  /** The number of {@link Entity}s within the subtree of this TreeViewNode.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  get numEntities(): number;
+
+  /** The number of {@link Entity}s that are currently visible within the subtree of this TreeViewNode.
+   *
+   * @type {Number}
+   * @abstract
+   */
+  get numVisibleEntities(): number;
+
+  /** Whether or not the TreeViewNode is currently checked.
+   *
+   * @type {Boolean}
+   * @abstract
+   */
+  get checked(): boolean;
+}