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

package/types/plugins/NavCubePlugin/NavCubePlugin.d.ts

@@ -0,0 +1,160 @@
+import { Plugin } from "../../viewer/Plugin";
+import { Viewer } from "../../viewer/Viewer";
+
+export declare type NavCubePluginConfiguration = {
+  /** 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 NavCube - 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 NavCube - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  canvasElement?: HTMLCanvasElement;
+  /** Initial visibility. */
+  visible?: boolean;
+  /** Whether the shadow of the cube is visible. */
+  shadowVisible?: boolean;
+  /** Whether the {@link Camera} flies or jumps to each selected axis or diagonal. */
+  cameraFly?: string;
+  /** How much of the field-of-view, in degrees, that the 3D scene should fill the {@link Canvas} when the {@link Camera} moves to an axis or diagonal. */
+  cameraFitFOV?: string;
+  /** When flying the {@link Camera} to each new axis or diagonal, how long, in seconds, that the Camera takes to get there. */
+  cameraFlyDuration?: string;
+  /** Custom uniform color for the faces of the NavCube. */
+  color?: string;
+  /** Custom color for the front face of the NavCube. Overrides ````color````. */
+  frontColor?: string;
+  /** Custom color for the back face of the NavCube. Overrides ````color````. */
+  backColor?: string;
+  /** Custom color for the left face of the NavCube. Overrides ````color````. */
+  leftColor?: string;
+  /** Custom color for the right face of the NavCube. Overrides ````color````. */
+  rightColor?: string;
+  /** Custom color for the top face of the NavCube. Overrides ````color````. */
+  topColor?: string;
+  /** Custom color for the bottom face of the NavCube. Overrides ````color````. */
+  bottomColor?: string;
+  /** Custom color for highlighting regions on the NavCube as we hover the pointer over them. */
+  hoverColor?: string;
+  /** Sets whether the axis, corner and edge-aligned views will fit the view to the entire {@link Scene} or just to visible object-{@link Entity}s. Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````. */
+  fitVisible?: boolean;
+  /** Sets whether the NavCube switches between perspective and orthographic projections in synchrony with the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection. */
+  synchProjection?: boolean;
+};
+
+/**
+ * {@link Viewer} plugin that lets us look at the entire {@link Scene} from along a chosen axis or diagonal.
+ *
+ */
+export declare class NavCubePlugin extends Plugin {
+    /**
+     * @constructor
+     * @param {Viewer} viewer The Viewer.
+     * @param {NavCubePluginConfiguration} cfg NavCubePlugin configuration.
+     */
+    constructor(viewer: Viewer, cfg?: NavCubePluginConfiguration);
+
+    /**
+     * Sets if the NavCube is visible.
+     *
+     * @param {Boolean} value Whether or not the NavCube is visible.
+     */
+    setVisible(value?: boolean): void;
+
+    /**
+     * Gets if the NavCube is visible.
+     *
+     * @return {Boolean} True when the NavCube is visible.
+     */
+    getVisible(): boolean;
+
+    /**
+     * Sets whether the axis, corner and edge-aligned views will fit the
+     * view to the entire {@link Scene} or just to visible object-{@link Entity}s.
+     *
+     * Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````.
+     *
+     * @param {Boolean} value Set ````true```` to fit only visible object-Entitys.
+     */
+    setFitVisible(value: boolean): void;
+
+    /**
+     * Gets whether the axis, corner and edge-aligned views will fit the
+     * view to the entire {@link Scene} or just to visible object-{@link Entity}s.
+     *
+     * Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````.
+     *
+     * @return {Boolean} True when fitting only visible object-Entitys.
+     */
+    getFitVisible(): boolean;
+
+    /**
+     * Sets whether the {@link Camera} flies or jumps to each selected axis or diagonal.
+     *
+     * Default is ````true````, to fly.
+     *
+     * @param {Boolean} value Set ````true```` to fly, else ````false```` to jump.
+     */
+    setCameraFly(value: boolean): void;
+
+    /**
+     * Gets whether the {@link Camera} flies or jumps to each selected axis or diagonal.
+     *
+     * Default is ````true````, to fly.
+     *
+     * @returns {Boolean} Returns ````true```` to fly, else ````false```` to jump.
+     */
+    getCameraFly(): boolean;
+
+    /**
+     * Sets how much of the field-of-view, in degrees, that the {@link Scene} should
+     * fill the canvas when flying or jumping the {@link Camera} to each selected axis or diagonal.
+     *
+     * Default value is ````45````.
+     *
+     * @param {Number} value New FOV value.
+     */
+    setCameraFitFOV(value: number): void;
+
+    /**
+     * Gets how much of the field-of-view, in degrees, that the {@link Scene} should
+     * fill the canvas when flying or jumping the {@link Camera} to each selected axis or diagonal.
+     *
+     * Default value is ````45````.
+     *
+     * @returns {Number} Current FOV value.
+     */
+    getCameraFitFOV(): number;
+
+    /**
+     * When flying the {@link Camera} to each new axis or diagonal, sets how long, in seconds, that the Camera takes to get there.
+     *
+     * Default is ````0.5````.
+     *
+     * @param {Boolean} value Camera flight duration in seconds.
+     */
+    setCameraFlyDuration(value: boolean): void;
+
+    /**
+     * When flying the {@link Camera} to each new axis or diagonal, gets how long, in seconds, that the Camera takes to get there.
+     *
+     * Default is ````0.5````.
+     *
+     * @returns {Boolean} Camera flight duration in seconds.
+     */
+    getCameraFlyDuration(): boolean;
+
+    /**
+     * Sets whether the NavCube switches between perspective and orthographic projections in synchrony with
+     * the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection.
+     *
+     * @param {Boolean} value Set ````true```` to keep NavCube projection synchronized with {@link Camera.projection}.
+     */
+    setSynchProjection(value: boolean): void;
+
+    /**
+     * Gets whether the NavCube switches between perspective and orthographic projections in synchrony with
+     * the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection.
+     *
+     * @return {Boolean} True when NavCube projection is synchronized with {@link Camera.projection}.
+     */
+    getSynchProjection(): boolean;
+}

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

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

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 @@
+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 declare 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;
+}