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

package/types/plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts

@@ -0,0 +1,65 @@
+import { Plugin, Viewer, PerformanceModel } from "../../viewer";
+
+export declare type XML3DLoaderPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer#plugins}. */
+  id?: string;
+  /** Path to the directory that contains the bundled [zip.js](https://gildas-lormeau.github.io/zip.js/) archive */
+  workerScriptsPath: string;
+  /** What type of materials to create while loading */
+  materialType?: "MetallicMaterial" | "SpecularMaterial" | "PhongMaterial";
+  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene#metaModels}. */
+  createMetaModel?: boolean;
+}
+
+export declare type LoadXML3DModel = {
+  /** ID to assign to the model's root {@link Entity}, unique among all components in the Viewer's {@link Scene}. */
+  id: string;
+  /** Path to a 3DXML file. */
+  src: string;
+  /** Whether or not xeokit renders the {@link Entity} with edges emphasized. */
+  edges?: boolean;
+  /** The model's 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 true, allows visible backfaces, wherever specified in the 3DXML. When false, ignores backfaces. */
+  backfaces?: 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. */
+  edgeThreshold?: number;
+  /** What type of materials to create while loading: "MetallicMaterial" to create {@link MetallicMaterial}s, "SpecularMaterial" to create {@link SpecularMaterial}s or "PhongMaterial" to create {@link PhongMaterial}s. As it loads XML3D's Phong materials, the XMLLoaderPlugin will do its best approximate conversion of those to the specified workflow. */
+  materialType?: "MetallicMaterial" | "SpecularMaterial" | "PhongMaterial";
+  /** When true, will create a {@link MetaModel} for the model in {@link MetaScene#metaModels}. */
+  createMetaModel?: boolean;
+};
+
+/**
+ * {@link Viewer} plugin that loads models from [3DXML](https://en.wikipedia.org/wiki/3DXML) files.
+ */
+export declare class XML3DLoaderPlugin extends Plugin {
+  /**
+   * @constructor
+   * @param {Viewer} viewer The Viewer.
+   * @param {XML3DLoaderPluginConfiguration} cfg  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?:XML3DLoaderPluginConfiguration );
+
+  /**
+   * Supported 3DXML schema versions
+   * @type {string[]}
+   */
+  supportedSchemas: string[];
+
+  /**
+   * Loads a 3DXML model from a file into this XML3DLoaderPlugin's {@link Viewer}.
+   *
+   * Creates a tree of {@link Entity}s within the Viewer's {@link Scene} that represents the model.
+   *
+   * @param {LoadXML3DModel} params  Loading parameters.
+   * @returns {Entity} 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: LoadXML3DModel): PerformanceModel;
+}

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

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

package/types/plugins/index.d.ts

@@ -0,0 +1,34 @@
+export * from "./AngleMeasurementsPlugin";
+export * from "./AnnotationsPlugin";
+export * from "./AxisGizmoPlugin";
+export * from "./BCFViewpointsPlugin";
+export * from "./CityJSONLoaderPlugin";
+export * from "./DistanceMeasurementsPlugin";
+export * from "./FastNavPlugin";
+export * from "./GLTFLoaderPlugin";
+export * from "./LASLoaderPlugin";
+export * from "./NavCubePlugin";
+export * from "./OBJLoaderPlugin";
+export * from "./SectionPlanesPlugin";
+export * from "./SkyboxesPlugin";
+export * from "./STLLoaderPlugin";
+export * from "./StoreyViewsPlugin";
+export * from "./TreeViewPlugin";
+export * from "./ViewCullPlugin";
+export * from "./XKTLoaderPlugin";
+export * from "./WebIFCLoaderPlugin";
+export * from "./XML3DLoaderPlugin";
+
+export declare type ModelStats = {
+  sourceFormat: string;
+  schemaVersion: string;
+  title: string;
+  author: string;
+  created: string;
+  numMetaObjects: number;
+  numPropertySets: number;
+  numObjects: number;
+  numGeometries: number;
+  numTriangles: number;
+  numVertices: number;
+};

package/types/viewer/Configs.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Manages global configurations for all {@link Viewer}s.
+ */
+export declare abstract class Configs {
+  /**
+   * Sets whether double precision mode is enabled for Viewers.
+   *
+   * When double precision mode is enabled (default), Viewers will accurately render models that contain
+   * double-precision coordinates, without jittering.
+   *
+   */
+  set doublePrecisionEnabled(doublePrecision: boolean);
+
+  /**
+   * Gets whether double precision mode is enabled for all Viewers.
+   *
+   * @returns {boolean}
+   */
+  get doublePrecisionEnabled(): boolean;
+}

package/types/viewer/Plugin.d.ts

@@ -0,0 +1,69 @@
+import { Viewer } from "./Viewer";
+
+/**
+ @desc Base class for {@link Viewer} plugin classes.
+ */
+export declare abstract class Plugin {
+    /**
+     * Creates this Plugin and installs it into the given {@link Viewer}.
+     *
+     * @param {string} id ID for this plugin, unique among all plugins in the viewer.
+     * @param {Viewer} viewer The viewer.
+     * @param {Object} [cfg] Options
+     */
+    constructor(id: string, viewer: Viewer, cfg?: {});
+
+    /**
+     * ID for this Plugin, unique within its {@link Viewer}.
+     *
+     * @type {string}
+     */
+    id: string;
+
+    /**
+     * The Viewer that contains this Plugin.
+     *
+     * @type {Viewer}
+     */
+    viewer: Viewer;
+
+    /**
+     Subscribes to an event fired at this Plugin.
+     @param {String} event The event
+     @param {Function} callback Callback fired on the event
+     */
+    on(event: string, callback: ()=> void): void;
+
+    /**
+     Fires an event at this Plugin.
+     @param {String} event The event type name
+     @param {Object} value The event parameters
+     */
+    fire(event: string, value: any): void;
+
+    /**
+     * Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
+     *
+     * @param {String} msg The error message
+     */
+    log(msg: string): void;
+
+    /**
+     * Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
+     *
+     * @param {String} msg The error message
+     */
+    warn(msg: string): void;
+
+    /**
+     * Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
+     *
+     * @param {String} msg The error message
+     */
+    error(msg: string): void;
+
+    /**
+     * Destroys this Plugin and removes it from its {@link Viewer}.
+     */
+    destroy(): void;
+}

package/types/viewer/Viewer.d.ts

@@ -0,0 +1,212 @@
+import { LocaleService } from "./localization/LocaleService";
+import { Scene } from "./scene/scene/Scene";
+import { MetaScene } from "./metadata/MetaScene";
+import { Camera } from "./scene/Camera";
+import { CameraFlightAnimation } from "./scene/Camera/CameraFlightAnimation";
+import { CameraControl } from "./scene/CameraControl/CameraControl";
+import { Plugin } from "./Plugin";
+
+export declare type ViewerConfiguration = {
+  /** Optional ID for this Viewer, defaults to the ID of {@link Viewer#scene}, which xeokit automatically generates. */
+  id?: string;
+  /** ID of an existing HTML canvas for the {@link Viewer#scene} - 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 for the {@link Viewer#scene} - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID. */
+  canvasElement?: HTMLCanvasElement;
+  /** Optional reference to HTML element on which key events should be handled. Defaults to the HTML Document. */
+  keyboardEventsElement?: HTMLElement;
+  /** ID of existing HTML element to show the {@link Spinner} - internally creates a default element automatically if this is omitted. */
+  spinnerElementId?: string;
+  /** The number of times the {@link Viewer#scene} renders per frame. */
+  passes?: number;
+  /** When doing multiple passes per frame, specifies if to clear the canvas before each pass (true) or just before the first pass (false). */
+  clearEachPass?: boolean;
+  /** Whether or not to preserve the WebGL drawing buffer. This needs to be ````true```` for {@link Viewer#getSnapshot} to work.*/
+  preserveDrawingBuffer?: boolean;
+  /** Whether or not the canvas is transparent. */
+  transparent?: boolean;
+  /** Whether or not you want alpha composition with premultiplied alpha. Highlighting and selection works best when this is ````false````. */
+  premultipliedAlpha?: boolean;
+  /** When true, expects that all textures and colors are premultiplied gamma. */
+  gammaInput?: boolean;
+  /** Whether or not to render with pre-multiplied gama. */
+  gammaOutput?: boolean;
+  /** The gamma factor to use when rendering with pre-multiplied gamma. */
+  gammaFactor?: number;
+  /** Sets the canvas background color to use when ````transparent```` is false. */
+  backgroundColor?: number[];
+  /**When ````transparent```` is false, set this ````true```` to derive the canvas background color from {@link AmbientLight#color}, or ````false```` to set the canvas background to ````backgroundColor````. */
+  backgroundColorFromAmbientLight?: boolean;
+  /** The measurement unit type. */
+  units?: "meters" | "centimeters" | "millimeters" | "yards" | "feet" | "inches" ;
+  /** The number of Real-space units in each World-space coordinate system unit. */
+  scale?: number;
+  /** The Real-space 3D origin, in current measurement units, at which the World-space coordinate origin ````[0,0,0]```` sits. */
+  origin?: number[];
+  /** Whether to enable Scalable Ambient Obscurance (SAO) effect. See {@link SAO} for more info. */
+  saoEnabled?: boolean;
+  /** Whether to enable anti-aliasing. */
+  antialias?: boolean;
+  /** Whether writing into the depth buffer is enabled or disabled when rendering transparent objects. */
+  alphaDepthMask?: boolean;
+  /** Whether to enable {@link Entity#offset}. For best performance, only set this ````true```` when you need to use {@link Entity#offset}. */
+  entityOffsetsEnabled?: boolean;
+  /** Whether to enable full-precision accuracy when surface picking with {@link Scene#pick}. */
+  pickSurfacePrecisionEnabled?: boolean;
+  /** Whether to enable logarithmic depth buffer. */
+  logarithmicDepthBufferEnabled?: boolean;
+  /** Whether to enable physically-based rendering. */
+  pbrEnabled?: boolean;
+  /** Optional locale-based translation service. */
+  localeService?: LocaleService;
+};
+
+/**
+ * The 3D Viewer at the heart of the xeokit SDK.
+ */
+export declare class Viewer {
+  /**
+   * @constructor
+   * @param {ViewerConfiguration} cfg Viewer configuration.
+   */
+  constructor(cfg: ViewerConfiguration);
+
+  /**
+   * The viewer's locale service.
+   *
+   * This is configured via the Viewer's constructor.
+   *
+   * By default, this service will be an instance of {@link LocaleService}, which will just return
+   * null translations for all given strings and phrases.
+   *
+   * @property localeService
+   * @type {LocaleService}
+   * @since 2.0
+   */
+  localeService: LocaleService;
+
+  /**
+   * The Viewer's {@link Scene}.
+   * @property scene
+   * @type {Scene}
+   */
+  scene: Scene;
+
+  /**
+   * Metadata about the {@link Scene} and the models and objects within it.
+   * @property metaScene
+   * @type {MetaScene}
+   * @readonly
+   */
+  readonly metaScene: MetaScene;
+
+  /**
+   * The Viewer's ID.
+   * @property id
+   *
+   * @type {String|Number}
+   */
+  id: string | number;
+
+  /**
+   * The Viewer's {@link Camera}. This is also found on {@link Scene#camera}.
+   * @property camera
+   * @type {Camera}
+   */
+  camera: Camera;
+
+  /**
+   * The Viewer's {@link CameraFlightAnimation}, which
+   * is used to fly the {@link Scene}'s {@link Camera} to given targets.
+   * @property cameraFlight
+   * @type {CameraFlightAnimation}
+   */
+  cameraFlight: CameraFlightAnimation;
+
+  /**
+   * The Viewer's {@link CameraControl}, which
+   * controls the {@link Scene}'s {@link Camera} with mouse,  touch and keyboard input.
+   * @property cameraControl
+   * @type {CameraControl}
+   */
+  cameraControl: CameraControl;
+
+  /**
+   * Subscribes to an event fired at this Viewer.
+   *
+   * @param {String} event The event
+   * @param {Function} callback Callback fired on the event
+   */
+  on(event: string, callback: Function): void;
+
+  /**
+   * Fires an event at this Viewer.
+   *
+   * @param {String} event Event name
+   * @param {Object} value Event parameters
+   */
+  fire(event: string, value: any): void;
+
+  /**
+   * Logs a message to the JavaScript developer console, prefixed with the ID of this Viewer.
+   *
+   * @param {String} msg The message
+   */
+  log(msg: string): void;
+
+  /**
+   * Logs an error message to the JavaScript developer console, prefixed with the ID of this Viewer.
+   *
+   * @param {String} msg The error message
+   */
+  error(msg: string): void;
+
+  /**
+   * Installs a Plugin.
+   *
+   * @private
+   */
+  addPlugin(plugin: Plugin);
+
+  /**
+   * Enter snapshot mode.
+   *
+   * Switches rendering to a hidden snapshot canvas.
+   *
+   * Exit snapshot mode using {@link Viewer#endSnapshot}.
+   */
+  beginSnapshot(): void;
+
+  /**
+   * Gets a snapshot of this Viewer's {@link Scene} as a Base64-encoded image.
+   *
+   * #### Usage:
+   *
+   * ````javascript
+   * const imageData = viewer.getSnapshot({
+   *    width: 500,
+   *    height: 500,
+   *    format: "png"
+   * });
+   * ````
+   * @param {*} [params] Capture options.
+   * @param {Number} [params.width] Desired width of result in pixels - defaults to width of canvas.
+   * @param {Number} [params.height] Desired height of result in pixels - defaults to height of canvas.
+   * @param {String} [params.format="jpeg"] Desired format; "jpeg", "png" or "bmp".
+   * @param {Boolean} [params.includeGizmos=false] When true, will include gizmos like {@link SectionPlane} in the snapshot.
+   * @returns {String} String-encoded image data URI.
+   */
+  getSnapshot(params?: any): string;
+
+  /**
+   * Exits snapshot mode.
+   *
+   * Switches rendering back to the main canvas.
+   *
+   */
+  endSnapshot(): void;
+
+  /** Destroys this Viewer.
+   */
+  destroy(): void;
+}

package/types/viewer/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./localization/LocaleService";
+export * from "./scene";
+export * from "./Plugin";
+export * from "./Viewer";
+export * from "./Configs";
+export * from "./metadata";

package/types/viewer/localization/LocaleService.d.ts

@@ -0,0 +1,176 @@
+export declare type LocaleServiceConfiguration = {
+  messages: any;
+  locale?: string;
+};
+
+/**
+ * Localization service for a {@link Viewer}.
+ */
+export declare class LocaleService {
+    /**
+     * @constructor
+     * @param {LocaleServiceConfiguration} cfg LocaleService configuration
+     */
+    constructor(cfg?: LocaleServiceConfiguration);
+
+    /**
+     * Replaces the current set of locale translations.
+     *
+     * * Fires an "updated" event when done.
+     * * Automatically refreshes any plugins that depend on the translations.
+     * * Does not change the current locale.
+     *
+     * ## Usage
+     *
+     * ````javascript
+     * viewer.localeService.setMessages({
+     *     messages: {
+     *         "en": { // English
+     *             "NavCube": {
+     *                 "front": "Front",
+     *                 "back": "Back",
+     *                 "top": "Top",
+     *                 "bottom": "Bottom",
+     *                 "left": "Left",
+     *                 "right": "Right"
+     *             }
+     *         },
+     *         "mi": { // Māori
+     *             "NavCube": {
+     *                 "front": "Mua",
+     *                 "back": "Tuarā",
+     *                 "top": "Runga",
+     *                 "bottom": "Raro",
+     *                 "left": "Mauī",
+     *                 "right": "Tika"
+     *             }
+     *         }
+     *    }
+     * });
+     * ````
+     *
+     * @param {*} messages The new translations.
+     */
+
+    set messages(arg: any);
+
+    /**
+     * Sets the current locale.
+     *
+     * * Fires an "updated" event when done.
+     * * The given locale does not need to be in the list of available locales returned by {@link LocaleService#locales}, since
+     * this method assumes that you may want to load the locales at a later point.
+     * * Automatically refreshes any plugins that depend on the translations.
+     * * We can then get translations for the locale, if translations have been loaded for it, via {@link LocaleService#translate} and {@link LocaleService#translatePlurals}.
+     *
+     * @param {String} locale The new current locale.
+     */
+    set locale(arg: string);
+
+    /**
+     * Gets the current locale.
+     *
+     * @returns {String} The current locale.
+     */
+    get locale(): string;
+
+    /**
+     * Loads a new set of locale translations, adding them to the existing translations.
+     *
+     * * Fires an "updated" event when done.
+     * * Automatically refreshes any plugins that depend on the translations.
+     * * Does not change the current locale.
+     *
+     * ## Usage
+     *
+     * ````javascript
+     * viewer.localeService.loadMessages({
+     *     "jp": { // Japanese
+     *         "NavCube": {
+     *             "front": "前部",
+     *             "back": "裏",
+     *             "top": "上",
+     *             "bottom": "底",
+     *             "left": "左",
+     *             "right": "右"
+     *         }
+     *     }
+     * });
+     * ````
+     *
+     * @param {*} messages The new translations.
+     */
+    loadMessages(messages?: any): void;
+
+    /**
+     * Clears all locale translations.
+     *
+     * * Fires an "updated" event when done.
+     * * Does not change the current locale.
+     * * Automatically refreshes any plugins that depend on the translations, which will cause those
+     * plugins to fall back on their internal hard-coded text values, since this method removes all
+     * our translations.
+     */
+    clearMessages(): void;
+
+    /**
+     * Gets the list of available locales.
+     *
+     * These are derived from the currently configured set of translations.
+     *
+     * @returns {String[]} The list of available locales.
+     */
+
+    get locales(): string[];
+    /**
+     * Translates the given string according to the current locale.
+     *
+     * Returns null if no translation can be found.
+     *
+     * @param {String} msg String to translate.
+     * @param {*} [args] Extra parameters.
+     * @returns {String|null} Translated string if found, else null.
+     */
+
+    translate(msg: string, args?: any): string | null;
+
+    /**
+     * Translates the given phrase according to the current locale.
+     *
+     * Returns null if no translation can be found.
+     *
+     * @param {String} msg Phrase to translate.
+     * @param {Number} count The plural number.
+     * @param {*} [args] Extra parameters.
+     * @returns {String|null} Translated string if found, else null.
+     */
+    translatePlurals(msg: string, count: number, args?: any): string | null;
+
+    /**
+     * Fires an event on this LocaleService.
+     *
+     * Notifies existing subscribers to the event, optionally retains the event to give to
+     * any subsequent notifications on the event as they are made.
+     *
+     * @param {String} event The event type name.
+     * @param {Object} value The event parameters.
+     * @param {Boolean} [forget=false] When true, does not retain for subsequent subscribers.
+     */
+    fire(event: string, value: any, forget?: boolean): void;
+
+    /**
+     * Subscribes to an event on this LocaleService.
+     *
+     * @param {String} event The event
+     * @param {Function} callback Callback fired on the event
+     * @return {String} Handle to the subscription, which may be used to unsubscribe with {@link #off}.
+     */
+    on(event: string, callback: Function): string;
+
+    /**
+     * Cancels an event subscription that was previously made with {@link LocaleService#on}.
+     *
+     * @param {String} subId Subscription ID
+     */
+    off(subId: string): void;
+}

package/types/viewer/metadata/IFCObjectDefaults.d.ts

@@ -0,0 +1,9 @@
+
+export declare type IFCObjectDefaults = {
+  [key: string]: {
+    colorize?: number[];
+    pickable?: boolean;
+    visible?: boolean;
+    opacity?: number
+  }
+};

package/types/viewer/metadata/MetaModel.d.ts

@@ -0,0 +1,65 @@
+import { MetaScene } from "./MetaScene";
+import { PropertySet } from "./PropertySet";
+import { MetaObject } from "./MetaObject";
+
+/**
+ * Metadata corresponding to an {@link Entity} that represents a model.
+ */
+export declare class MetaModel {
+  /**
+   * Globally-unique ID.
+   *
+   * MetaModels are registered by ID in {@link MetaScene#metaModels}.
+   *
+   * When this MetaModel corresponds to an {@link Entity} then this ID will match the {@link Entity#id}.
+   *
+   */
+  id: string | number;
+
+  /**
+   * The project ID
+   */
+  projectId: string | number;
+
+  /**
+   * The revision ID, if available.
+   */
+  revisionId?: string | number;
+
+  /**
+   * The model author, if available.
+   */
+  author?: string;
+
+  /**
+   * The date the model was created, if available.
+   */
+  createdAt?: string;
+
+  /**
+   * The application that created the model, if available.
+   */
+  creatingApplication?: string;
+
+  /**
+   * The model schema version, if available.
+   */
+  schema?: string;
+
+  /**
+   * Metadata on the {@link Scene}.
+   */
+  metaScene?: MetaScene;
+
+  /**
+   * The {@link PropertySet}s in this MetaModel.
+   */
+  propertySets: {
+    String: PropertySet;
+  };
+
+  /**
+   * The root {@link MetaObject} in this MetaModel's composition structure hierarchy.
+   */
+  rootMetaObject: MetaObject;
+}