@xeokit/xeokit-sdk 2.6.64 → 2.6.66

package/types/plugins/DotBIMLoaderPlugin/DotBIMLoaderPlugin.d.ts

@@ -0,0 +1,121 @@
+import {IFCObjectDefaults, Plugin, VBOSceneModel, Viewer} from "../../viewer";
+
+export declare interface IDotBIMDefaultDataSource {
+  /**
+   * Gets the contents of the given ````.xkt```` file in an arraybuffer.
+   *
+   * @param {String|Number} dotBIMSrc Path or ID of an ````.bim```` file.
+   * @param {Function} ok Callback fired on success, argument is the ````.xkt```` file in an arraybuffer.
+   * @param {Function} error Callback fired on error.
+   */
+  getDotBIM(dotBIMSrc: string | number, ok: (buffer: ArrayBuffer) => void, error: (e: Error) => void): void;
+
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
+}
+
+export declare type DotBIMLoaderPluginConfiguration = {
+  /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
+  id?: string;
+  /** Map of initial default states for each loaded {@link Entity} that represents an object.  Default value is {@link IFCObjectDefaults}.*/
+  objectDefaults?: IFCObjectDefaults;
+  /** A custom data source through which the XKTLoaderPlugin can load model and metadata files. Defaults to an instance of {@link DotBIMDefaultDataSource}, which loads uover HTTP. */
+  dataSource?: IDotBIMDefaultDataSource;
+};
+
+
+/**
+   * @param {Number[]} [params.rotation=[0,0,0]] The model's orientation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+   * @param {Boolean} [params.backfaces=true] When true, always show backfaces, even on objects for which the .BIM material is single-sided. When false, only show backfaces on geometries whenever the .BIM material is double-sided.
+   * @param {Boolean} [params.dtxEnabled=true] When ````true```` (default) use data textures (DTX), where appropriate, to
+   * represent the returned model. Set false to always use vertex buffer objects (VBOs). Note that DTX is only applicable
+   * to non-textured triangle meshes, and that VBOs are always used for meshes that have textures, line segments, or point
+   * primitives. Only works while {@link DTX#enabled} is also ````true````.
+   */
+export declare type LoadDotBIMModel = {
+  /** 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 .BIM file, as an alternative to the ````bim```` parameter. */
+  src?: string;
+  /** .BIM JSON, as an alternative to the ````src```` parameter. */
+  bim?: any;
+  /** Map of initial default states for each loaded {@link Entity} that represents an object. Default value is {@link IFCObjectDefaults}. */
+  objectDefaults?: object;
+  /** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
+  includeTypes?: string[]
+  /** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
+  excludeTypes?: string[];
+  /** The double-precision World-space origin of the model's coordinates. */
+  origin?: number[];
+  /** The single-precision position, relative to ````origin````. */
+  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[];
+   /** When true, always show backfaces, even on objects for which the .BIM material is single-sided. When false, only show backfaces on geometries whenever the .BIM material is double-sided. */
+   backfaces?: boolean;
+   /** When ````true```` (default) use data textures (DTX), where appropriate, to
+    * represent the returned model. Set false to always use vertex buffer objects (VBOs). Note that DTX is only applicable
+    * to non-textured triangle meshes, and that VBOs are always used for meshes that have textures, line segments, or point
+    * primitives. Only works while {@link DTX#enabled} is also ````true````. */
+   dtxEnabled?: boolean;
+};
+
+export declare class DotBIMLoaderPlugin extends Plugin {
+  /**
+   * @constructor
+   *
+   * @param {Viewer} viewer The Viewer.
+   * @param {DotBIMLoaderPluginConfiguration} cfg  Plugin configuration.
+   */
+  constructor(viewer: Viewer, cfg?: DotBIMLoaderPluginConfiguration);
+
+  /**
+   * Sets a custom data source through which the DotBIMLoaderPlugin can .BIM files.
+   *
+   * Default value is {@link DotBIMDefaultDataSource}, which loads via an XMLHttpRequest.
+   *
+   * @type {IXKTDefaultDataSource}
+   */
+  set dataSource(arg: IDotBIMDefaultDataSource);
+
+  /**
+   * Gets the custom data source through which the DotBIMLoaderPlugin can load .BIM files.
+   *
+   * Default value is {@link DotBIMDefaultDataSource}, which loads via an XMLHttpRequest.
+   *
+   * @type {IXKTDefaultDataSource}
+   */
+  get dataSource(): IDotBIMDefaultDataSource;
+
+  /**
+     * Sets map of initial default states for each loaded {@link Entity} that represents an object.
+     *
+     * @type {IFCObjectDefaults}
+     */
+  set objectDefaults(arg: IFCObjectDefaults);
+
+  /**
+   * Gets map of initial default states for each loaded {@link Entity} that represents an object.
+   *
+   * @type {IFCObjectDefaults}
+   */
+  get objectDefaults(): IFCObjectDefaults;
+
+  /**
+   * Loads a .BIM model from a file into this DotBIMLoaderPlugin's {@link Viewer}.
+   *
+   * @param {LoadBIMModel} params Loading parameters.
+   * @returns {VBOSceneModel} Entity representing the model, which will have {@link Entity#isModel} set ````true```` and will be registered by {@link Entity#id} in {@link Scene#models}
+   */
+
+  /**
+   * Loads a .BIM model from a file into this DotBIMLoaderPlugin's {@link Viewer}.
+   *
+   * @param {LoadDotBIMModel} params Loading parameters.
+   * @returns {VBOSceneModel} 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: LoadDotBIMModel): VBOSceneModel;
+}

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

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

package/types/plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts

@@ -31,6 +31,10 @@ export declare interface IGLTFDefaultDataSource {
    * @param {Function} error Fired on error while loading the glTF binary asset.
    */
   getArrayBuffer(glTFSrc: string | number, binarySrc: string | number, ok: Function, error: Function): void;
+
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type GLTFLoaderPluginConfiguration =  {

package/types/plugins/LASLoaderPlugin/LASLoaderPlugin.d.ts

@@ -10,6 +10,10 @@ export declare interface ILASDefaultDataSource {
    * @param {Function} error Callback fired on error.
    */
   getLAS(src: string | number, ok: (LAS: ArrayBuffer) => void, error: (e: Error) => void): void;
+
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type LASLoaderPluginConfiguration = {

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

@@ -9,6 +9,10 @@ export declare interface ISTLDefaultDataSource {
    * @param {Function} error Fired on error while loading the STL file.
    */
   getSTL(src: string | number, ok: Function, error: Function): void;
+
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type STLLoaderPluginCOnfiguration = {

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

@@ -21,6 +21,10 @@ export declare type TreeViewPluginConfiguration = {
   renderService?: ITreeViewRenderService;
   /** When true, will show indeterminate state for checkboxes when some but not all child nodes are checked */
   showIndeterminate?: boolean;
+  /** Optional function to replace the default elevation sort function. The function should take two nodes and return -1, 0 or 1.  */
+  elevationSortFunction?: (node1: TreeViewNode, node2: TreeViewNode) => number;
+  /** Optional function to replace the default sort function. The function should take two nodes and return -1, 0 or 1.  */
+  defaultSortFunction?: (node1: TreeViewNode, node2: TreeViewNode) => number;
 };
 
 /**

package/types/plugins/WebIFCLoaderPlugin/WebIFCLoaderPlugin.d.ts

@@ -13,6 +13,10 @@ import { ModelStats } from "../index";
    * @param {Function} error Callback fired on error.
    */
   getIFC(src: string | number, ok: (buffer: ArrayBuffer)=> void, error: (e: Error)=> void): void;
+  
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type WebIFCLoaderPluginConfiguration = {

package/types/plugins/XKTLoaderPlugin/XKTLoaderPlugin.d.ts

@@ -56,14 +56,28 @@ export declare type LoadXKTModel = {
     saoEnabled?: boolean;
     /** Indicates if physically-based rendering (PBR) will apply to the model. Only works when {@link Scene.pbrEnabled} is also ````true````. */
     pbrEnabled?: boolean;
+    /** Indicates if base color texture rendering is enabled for the model. Overridden by ````pbrEnabled````.  Only works when {@link Scene#colorTextureEnabled} is also ````true````. */
+    colorTextureEnabled?: boolean;
     /** When we set this ````true````, then we force rendering of backfaces for the model. */
     backfaces?: boolean;
     /** When loading metadata and this is ````true````, will only load {@link Entity}s that have {@link MetaObject}s (that are not excluded). */
     excludeUnclassifiedObjects?: boolean;
     /** Indicates whether to globalize each {@link Entity.id} and {@link MetaObject.id}, in case you need to prevent ID clashes with other models. */
     globalizeObjectIds?: boolean;
-    /** Indicates whether to enable geometry reuse */
+    /** Indicates whether to enable geometry reuse (````true```` by default) or whether to expand
+     * all geometry instances into batches (````false````), and not use instancing to render them. Setting this ````false```` can significantly
+     * improve Viewer performance for models that have excessive geometry reuse, but may also increases the amount of
+     * browser and GPU memory used by the model. See [#769](https://github.com/xeokit/xeokit-sdk/issues/769) for more info. */
     reuseGeometries?: boolean;
+    /** When ````true```` (default) use data textures (DTX), where appropriate, to
+     * represent the returned model. Set false to always use vertex buffer objects (VBOs). Note that DTX is only applicable
+     * to non-textured triangle meshes, and that VBOs are always used for meshes that have textures, line segments, or point
+     * primitives. Only works while {@link DTX#enabled} is also ````true````. */
+    dtxEnabled?: boolean;
+    /** Specifies the rendering order for the model. This is used to control the order in which
+     * SceneModels are drawn when they have transparent objects, to give control over the order in which those objects are blended within the transparent
+     * render pass. */
+    renderOrder?: number;
 }
 
 export declare interface IXKTDefaultDataSource {
@@ -84,6 +98,10 @@ export declare interface IXKTDefaultDataSource {
      * @param {Function} error Callback fired on error.
      */
     getXKT(src: string | number, ok: (buffer: ArrayBuffer) => void, error: (e: Error) => void): void;
+
+    get cacheBuster(): boolean;
+
+    set cacheBuster(value: boolean);
 }
 
 /**

package/types/plugins/index.d.ts

@@ -4,6 +4,7 @@ export * from "./AxisGizmoPlugin";
 export * from "./BCFViewpointsPlugin";
 export * from "./CityJSONLoaderPlugin";
 export * from "./DistanceMeasurementsPlugin";
+export * from "./DotBIMLoaderPlugin";
 export * from "./FastNavPlugin";
 export * from "./GLTFLoaderPlugin";
 export * from "./LASLoaderPlugin";
@@ -18,6 +19,7 @@ export * from "./ViewCullPlugin";
 export * from "./XKTLoaderPlugin";
 export * from "./WebIFCLoaderPlugin";
 export * from "./XML3DLoaderPlugin";
+export * from "./lib/ui";
 
 export declare type ModelStats = {
   sourceFormat: string;

package/types/plugins/lib/ui/index.d.ts

@@ -0,0 +1,12 @@
+import { Viewer } from "../../../viewer";
+import { PointerCircle } from "../../../extras/PointerCircle";
+
+type Cleanup = () => void;
+
+type OnCancel = () => void;
+type OnChange = () => void;
+type OnCommit = () => void;
+
+type Ray2WorldPos = (origin: number[], direction: number[]) => boolean | number[];
+
+declare function touchPointSelector(viewer: Viewer, pointerCircle: PointerCircle, ray2WorldPos: Ray2WorldPos): (onCancel: OnCancel, onChange: OnChange, onCommit: OnCommit) => Cleanup;