@xeokit/xeokit-sdk 2.6.78-rc2-no-las → 2.6.78

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

@@ -11,7 +11,9 @@ export declare interface ILASDefaultDataSource {
    */
   getLAS(src: string | number, ok: (LAS: ArrayBuffer) => void, error: (e: Error) => void): void;
 
-  cacheBuster: boolean;
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type LASLoaderPluginConfiguration = {
@@ -75,31 +77,58 @@ export declare class LASLoaderPlugin extends Plugin {
   constructor(viewer: Viewer, cfg?: LASLoaderPluginConfiguration);
 
   /**
-   * Custom data source through which the LASLoaderPlugin can load LAS files.
+   * Sets a custom data source through which the LASLoaderPlugin can load LAS files.
+   *
+   * Default value is {@link LASDefaultDataSource}, which loads via HTTP.
+   *
+   * @type {ILASDefaultDataSource}
+   */
+  set dataSource(arg: ILASDefaultDataSource);
+
+  /**
+   * Gets the custom data source through which the LASLoaderPlugin can load LAS files.
    *
    * Default value is {@link LASDefaultDataSource}, which loads via HTTP.
    *
    * @type {ILASDefaultDataSource}
    */
-  dataSource: ILASDefaultDataSource;
+  get dataSource(): ILASDefaultDataSource;
 
   /**
    * Configures LASLoaderPlugin to load every **n** points.
    *
    * Default value is ````1````.
    *
-   * @type {Number}
+   * @param {Number} value The **n**th point that LASLoaderPlugin will read.
+   */
+  set skip(value: number);
+
+  /**
+   * When LASLoaderPlugin is configured to load every **n** points, returns the value of **n**.
+   *
+   * Default value is ````1````.
+   *
+   * @returns {Number} The **n**th point that LASLoaderPlugin will read.
    */
-  skip: number;
+  get skip(): number;
 
   /**
    * Configures if LASLoaderPlugin assumes that LAS positions are stored in 64-bit floats instead of 32-bit.
    *
    * Default value is ````false````.
    *
-   * @type {Boolean}
+   * @param {Boolean} value True if LASLoaderPlugin assumes that positions are stored in 64-bit floats instead of 32-bit.
    */
-  fp64: boolean;
+  set fp64(value: boolean);
+
+  /**
+   * Gets if LASLoaderPlugin assumes that LAS positions are stored in 64-bit floats instead of 32-bit.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} True if LASLoaderPlugin assumes that positions are stored in 64-bit floats instead of 32-bit.
+   */
+  get fp64(): boolean;
 
   /**
    * Configures whether LASLoaderPlugin assumes that LAS colors are encoded using 8 or 16 bits.
@@ -108,9 +137,31 @@ export declare class LASLoaderPlugin extends Plugin {
    *
    * Note: LAS specification recommends 16 bits.
    *
-   * @type {Number|String}
+   * @param {Number|String} value Valid values are 8, 16 and "auto".
+   */
+  set colorDepth(value: 8 | 16 | "auto");
+
+  /**
+   * Gets whether LASLoaderPlugin assumes that LAS colors are encoded using 8 or 16 bits.
+   *
+   * Default value is ````8````.
+   *
+   * Note: LAS specification recommends 16 bits.
+   *
+   * @returns {Number|String} Possible returned values are 8, 16 and "auto".
    */
-  colorDepth: 8 | 16 | "auto";
+  get colorDepth(): 8 | 16 | "auto";
+
+  /**
+   * Gets if LASLoaderPlugin immediately centers LAS positions.
+   *
+   * If this is ````true```` then centering is the first thing that happens to LAS positions as they are loaded.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} True if LASLoaderPlugin immediately centers LAS positions.
+   */
+  get center():number[];
 
   /**
    * Configures if LASLoaderPlugin immediately centers LAS positions.
@@ -119,40 +170,69 @@ export declare class LASLoaderPlugin extends Plugin {
    *
    * Default value is ````false````.
    *
-   * @type {Number[]}
+   * @param {Boolean} value True if LASLoaderPlugin immediately centers LAS positions.
    */
-  center: number[];
+  set center(value:number[]);
 
   /**
-   * Current transformation to apply to LAS positions as they are loaded.
+   * Gets the current transformation to apply to LAS positions as they are loaded.
    *
    * If this is ````true```` then LAS positions will be transformed right after they are centered.
    *
    * Default value is null.
    *
-   * @type {Number[]|null}
+   * @returns {Number[]|null} A 16-element array containing a 4x4 transformation matrix.
+   */
+  get transform(): number[];
+
+  /**
+   * Sets the current transformation to apply to LAS positions as they are loaded.
+   *
+   * Default value is null.
+   *
+   * @param {Number[]|null} transform A 16-element array containing a 4x4 transformation matrix.
    */
-  transform: number[];
+  set transform(transform: number[]);
 
   /**
-   * Current rotations to apply to LAS positions as they are loaded.
+   * Gets the current rotations to apply to LAS positions as they are loaded.
    *
    * Rotations are an array of three Euler angles in degrees, for each of the X, Y and Z axis, applied in that order.
    *
    * Default value is null.
    *
-   * @type {Number[]|null}
+   * @returns {Number[]|null} If defined, an array of three Euler angles in degrees, for each of the X, Y and Z axis. Null if undefined.
+   */
+  get rotate():number[];
+
+  /**
+   * Sets the current rotations to apply to LAS positions as they are loaded.
+   *
+   * Rotations are an array of three Euler angles in degrees, for each of the X, Y and Z axis, applied in that order.
+   *
+   * Default value is null.
+   *
+   * @param {Number[]|null} rotate Array of three Euler angles in degrees, for each of the X, Y and Z axis.
+   */
+  set rotate(rotate:number[]) ;
+
+  /**
+   * Gets if LAS positions are rotated 90 degrees about X as they are loaded.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {*}
    */
-  rotate: number[];
+  get rotateX() :boolean;
 
   /**
-   * Configures if LAS positions are rotated 90 degrees about X as they are loaded.
+   * Sets if LAS positions are rotated 90 degrees about X as they are loaded.
    *
    * Default value is ````false````.
    *
-   * @type {Boolean}
+   * @param rotateX
    */
-  rotateX: boolean;
+  set rotateX(rotateX:boolean);
 
   /**
    * Loads an ````LAS```` model into this LASLoaderPlugin's {@link Viewer}.

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

@@ -10,7 +10,9 @@ export declare interface ISTLDefaultDataSource {
    */
   getSTL(src: string | number, ok: Function, error: Function): void;
 
-  cacheBuster: boolean;
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type STLLoaderPluginCOnfiguration = {
@@ -63,13 +65,22 @@ export declare class STLLoaderPlugin extends Plugin {
   constructor(viewer: Viewer, cfg?: STLLoaderPluginCOnfiguration);
 
   /**
-   * Custom data source through which the STLLoaderPlugin can load STL files.
+   * 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}
    */
-  dataSource: ISTLDefaultDataSource;
+  get dataSource(): ISTLDefaultDataSource;
 
   /**
    * Loads an STL model from a file into this STLLoaderPlugin's {@link Viewer}.

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

@@ -14,7 +14,9 @@ import { ModelStats } from "../index";
    */
   getIFC(src: string | number, ok: (buffer: ArrayBuffer)=> void, error: (e: Error)=> void): void;
   
-  cacheBuster: boolean;
+  get cacheBuster(): boolean;
+
+  set cacheBuster(value: boolean);
 }
 
 export declare type WebIFCLoaderPluginConfiguration = {
@@ -82,25 +84,43 @@ export declare class WebIFCLoaderPlugin extends Plugin {
   constructor(viewer: Viewer, cfg?: WebIFCLoaderPluginConfiguration);
 
   /**
-   * Custom data source through which the WebIFCLoaderPlugin can load IFC files.
+   * Sets a custom data source through which the WebIFCLoaderPlugin can load IFC files.
    *
    * Default value is {@link WebIFCDefaultDataSource}, which loads via HTTP.
    *
    * @type {Object}
    */
-  dataSource: IWebIFCDefaultDataSource;
+  set dataSource(arg: IWebIFCDefaultDataSource);
+
+  /**
+   * Gets the custom data source through which the WebIFCLoaderPlugin can load IFC files.
+   *
+   * Default value is {@link WebIFCDefaultDataSource}, which loads via HTTP.
+   *
+   * @type {Object}
+   */
+  get dataSource(): IWebIFCDefaultDataSource;
+
+  /**
+   * Sets map of initial default states for each loaded {@link Entity} that represents an object.
+   *
+   * Default value is {@link IFCObjectDefaults}.
+   *
+   * @type {IFCObjectDefaults}
+   */
+  set objectDefaults(arg: IFCObjectDefaults);
 
   /**
-   * Map of initial default states for each loaded {@link Entity} that represents an object.
+   * Gets map of initial default states for each loaded {@link Entity} that represents an object.
    *
    * Default value is {@link IFCObjectDefaults}.
    *
    * @type {IFCObjectDefaults}
    */
-  objectDefaults: IFCObjectDefaults;
+  get objectDefaults(): IFCObjectDefaults;
 
   /**
-   * Whitelist of the IFC types loaded by this WebIFCLoaderPlugin.
+   * Sets the whitelist of the IFC types loaded by this WebIFCLoaderPlugin.
    *
    * When loading IFC models, causes this WebIFCLoaderPlugin to only load objects whose types are in this
    * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
@@ -109,10 +129,34 @@ export declare class WebIFCLoaderPlugin extends Plugin {
    *
    * @type {String[]}
    */
-  includeTypes: string[];
+  set includeTypes(arg: string[]);
 
   /**
-   * Blacklist of IFC types that are never loaded by this WebIFCLoaderPlugin.
+   * Gets the whitelist of the IFC types loaded by this WebIFCLoaderPlugin.
+   *
+   * When loading IFC models, causes this WebIFCLoaderPlugin to only load objects whose types are in this
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
+   *
+   * Default value is ````undefined````.
+   *
+   * @type {String[]}
+   */
+  get includeTypes(): string[];
+
+  /**
+   * Sets the blacklist of IFC types that are never loaded by this WebIFCLoaderPlugin.
+   *
+   * When IFC models, causes this WebIFCLoaderPlugin to **not** load objects whose types are in this
+   * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
+   *
+   * Default value is ````undefined````.
+   *
+   * @type {String[]}
+   */
+  set excludeTypes(arg: string[]);
+
+  /**
+   * Gets the blacklist of IFC types that are never loaded by this WebIFCLoaderPlugin.
    *
    * When loading IFC models, causes this WebIFCLoaderPlugin to **not** load objects whose types are in this
    * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
@@ -121,10 +165,10 @@ export declare class WebIFCLoaderPlugin extends Plugin {
    *
    * @type {String[]}
    */
-  excludeTypes: string[];
+  get excludeTypes(): string[];
 
   /**
-   * Whether to load objects that don't have IFC types.
+   * Sets whether we load objects that don't have IFC types.
    *
    * When loading IFC models and this is ````true````, WebIFCLoaderPlugin will not load objects
    * that don't have IFC types.
@@ -133,21 +177,33 @@ export declare class WebIFCLoaderPlugin extends Plugin {
    *
    * @type {Boolean}
    */
-  excludeUnclassifiedObjects: boolean;
+  set excludeUnclassifiedObjects(arg: boolean);
 
   /**
-   * The ````IFC```` format versions supported by this WebIFCLoaderPlugin.
-   * @type {string[]}
+   * Gets whether we load objects that don't have IFC types.
+   *
+   * When loading IFC models and this is ````true````, WebIFCLoaderPlugin will not load objects
+   * that don't have IFC types.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get excludeUnclassifiedObjects(): boolean;
+
+  /**
+   * Gets the ````IFC```` format versions supported by this WebIFCLoaderPlugin.
+   * @returns {string[]}
    */
-  readonly supportedVersions: string[];
+  get supportedVersions(): string[];
 
   /**
-   * Whether WebIFCLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
+   * Sets whether WebIFCLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
    *
-   * Set this ````true```` when you need to load multiple instances of the same model, to avoid ID clashes
+   * Set  this ````true```` when you need to load multiple instances of the same model, to avoid ID clashes
    * between the objects in the different instances.
    *
-   * When loading a model with this set ````true````, then each {@link Entity.id} and {@link MetaObject.id} will be
+   * When we load a model with this set ````true````, then each {@link Entity.id} and {@link MetaObject.id} will be
    * prefixed by the ID of the model, ie. ````<modelId>.<objectId>````.
    *
    * {@link Entity.originalSystemId} and {@link MetaObject.originalSystemId} will always hold the original, un-prefixed, ID values.
@@ -158,7 +214,16 @@ export declare class WebIFCLoaderPlugin extends Plugin {
    *
    * @type {Boolean}
    */
-  globalizeObjectIds: boolean;
+  set globalizeObjectIds(arg: boolean);
+
+  /**
+   * Gets whether WebIFCLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get globalizeObjectIds(): boolean;
 
   /**
    * Loads an ````IFC```` model into this WebIFCLoaderPlugin's {@link Viewer}.

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

@@ -103,7 +103,9 @@ export declare interface IXKTDefaultDataSource {
      */
     getXKT(src: string | number, ok: (buffer: ArrayBuffer) => void, error: (e: Error) => void): void;
 
-    cacheBuster: boolean;
+    get cacheBuster(): boolean;
+
+    set cacheBuster(value: boolean);
 }
 
 /**
@@ -120,23 +122,51 @@ export declare class XKTLoaderPlugin extends Plugin {
     constructor(viewer: Viewer, cfg?: XKTLoaderPluginConfiguration);
 
     /**
-     * Custom data source through which the XKTLoaderPlugin can load models and metadata.
+     * Sets a custom data source through which the XKTLoaderPlugin can load models and metadata.
      *
      * Default value is {@link XKTDefaultDataSource}, which loads via HTTP.
      *
      * @type {IXKTDefaultDataSource}
      */
-    dataSource: IXKTDefaultDataSource;
+    set dataSource(arg: IXKTDefaultDataSource);
 
     /**
-     * Map of initial default states for each loaded {@link Entity} that represents an object.
+     * Gets the custom data source through which the XKTLoaderPlugin can load models and metadata.
+     *
+     * Default value is {@link XKTDefaultDataSource}, which loads via HTTP.
+     *
+     * @type {IXKTDefaultDataSource}
+     */
+    get dataSource(): IXKTDefaultDataSource;
+
+    /**
+     * Sets map of initial default states for each loaded {@link Entity} that represents an object.
      *
      * @type {IFCObjectDefaults}
      */
-    objectDefaults: 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;
+
+    /**
+     * Sets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
+     *
+     * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this
+     * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
+     *
+     * Default value is ````undefined````.
+     *
+     * @type {String[]}
+     */
+    set includeTypes(arg: string[]);
 
     /**
-     * The whitelist of the IFC types loaded by this XKTLoaderPlugin.
+     * Gets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
      *
      * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this
      * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
@@ -145,10 +175,23 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {String[]}
      */
-    includeTypes: string[];
+
+    get includeTypes(): string[];
+
+    /**
+     * Sets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
+     *
+     * When loading models with metadata, causes this XKTLoaderPlugin to **not** load objects whose types are in this
+     * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
+     *
+     * Default value is ````undefined````.
+     *
+     * @type {String[]}
+     */
+    set excludeTypes(arg: string[]);
 
     /**
-     * The blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
+     * Gets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
      *
      * When loading models with metadata, causes this XKTLoaderPlugin to **not** load objects whose types are in this
      * list. An object's type is indicated by its {@link MetaObject}'s {@link MetaObject.type}.
@@ -157,10 +200,10 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {String[]}
      */
-    excludeTypes: string[];
+    get excludeTypes(): string[];
 
     /**
-     * The whitelist of the specified elements loaded by this XKTLoaderPlugin.
+     * Sets the whitelist of the specified elements by this XKTLoaderPlugin.
      *
      * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose ids are in this
      * list. An object's id is indicated by its {@link MetaObject}'s {@link MetaObject#id}.
@@ -169,10 +212,34 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {String[]}
      */
-    includeIds: string[];
+    set includeIds(arg: string[]);
 
     /**
-     * Whether to exclude objects that don't have IFC types.
+     * Gets the whitelist of the specified elements loaded by this XKTLoaderPlugin.
+     *
+     * When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose ids are in this
+     * list. An object's id is indicated by its {@link MetaObject}'s {@link MetaObject#id}.
+     *
+     * Default value is ````undefined````.
+     *
+     * @type {String[]}
+     */
+    get includeIds(): string[];
+
+    /**
+     * Sets whether we load objects that don't have IFC types.
+     *
+     * When loading models with metadata and this is ````true````, XKTLoaderPlugin will not load objects
+     * that don't have IFC types.
+     *
+     * Default value is ````false````.
+     *
+     * @type {Boolean}
+     */
+    set excludeUnclassifiedObjects(arg: boolean);
+
+    /**
+     * Gets whether we load objects that don't have IFC types.
      *
      * When loading models with metadata and this is ````true````, XKTLoaderPlugin will not load objects
      * that don't have IFC types.
@@ -181,10 +248,10 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {Boolean}
      */
-    excludeUnclassifiedObjects: boolean;
+    get excludeUnclassifiedObjects(): boolean;
 
     /**
-     * Whether XKTLoaderPlugin enables geometry reuse when loading models.
+     * Sets whether XKTLoaderPlugin enables geometry reuse when loading models.
      *
      * Default value is ````true````.
      *
@@ -198,18 +265,27 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {Boolean}
      */
-    reuseGeometries: boolean;
+    set reuseGeometries(arg: boolean);
 
     /**
-     * The ````.xkt```` format versions supported by this XKTLoaderPlugin.
-     * @type {string[]}
+     * Gets whether XKTLoaderPlugin enables geometry reuse when loading models.
+     *
+     * Default value is ````true````.
+     *
+     * @type {Boolean}
      */
-    readonly supportedVersions: string[];
+    get reuseGeometries(): boolean;
 
     /**
-     * Whether XKTLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
+     * Gets the ````.xkt```` format versions supported by this XKTLoaderPlugin/
+     * @returns {string[]}
+     */
+    get supportedVersions(): string[];
+
+    /**
+     * Sets whether XKTLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
      *
-     * Set this ````true```` when you need to load multiple instances of the same model, to avoid ID clashes
+     * Set  this ````true```` when you need to load multiple instances of the same model, to avoid ID clashes
      * between the objects in the different instances.
      *
      * When we load a model with this set ````true````, then each {@link Entity.id} and {@link MetaObject.id} will be
@@ -223,7 +299,16 @@ export declare class XKTLoaderPlugin extends Plugin {
      *
      * @type {Boolean}
      */
-    globalizeObjectIds: boolean;
+    set globalizeObjectIds(arg: boolean);
+
+    /**
+     * Gets whether XKTLoaderPlugin globalizes each {@link Entity.id} and {@link MetaObject.id} as it loads a model.
+     *
+     * Default value is ````false````.
+     *
+     * @type {Boolean}
+     */
+    get globalizeObjectIds(): boolean;
 
 
     /**

package/types/viewer/Configs.d.ts

@@ -3,26 +3,44 @@
  */
 export declare abstract class Configs {
   /**
-   * Whether double precision mode is enabled for Viewers.
+   * 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}
    */
-  static doublePrecisionEnabled: boolean;
+  get doublePrecisionEnabled(): boolean;
 
   /**
-   * The maximum data texture height.
+   * Sets the maximum data texture height.
    *
    * Should be a multiple of 1024. Default is 4096, which is the maximum allowed value.
    */
-  static maxDataTextureHeight: number;
+  set maxDataTextureHeight(value: number);
 
   /**
-   * The maximum batched geometry VBO size.
+   * Gets maximum data texture height.
+   */
+  get maxDataTextureHeight(): number;
+
+  /**
+   * Sets the maximum batched geometry VBO size.
    *
    * Default value is 5000000, which is the maximum size.
    *
    * Minimum size is 100000.
    */
-  static maxGeometryBatchSize: number;
+  set maxGeometryBatchSize(value: number);
+
+  /**
+   * Gets the maximum batched geometry VBO size.
+   */
+  get maxGeometryBatchSize(): number;
 }