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

package/types/viewer/scene/models/SceneModelEntity.d.ts

@@ -17,7 +17,7 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {number|string}
      * @abstract
      */
-    readonly id: string;
+    get id(): string;
 
     /**
      * ID of the corresponding object within the originating system, if any.
@@ -29,14 +29,14 @@ export declare abstract class SceneModelEntity implements Entity {
      *
      * @type {string}
      */
-    readonly originalSystemId: string;
+    get originalSystemId(): string;
 
     /**
      * Returns true to indicate that this is an SceneModelEntity.
      *
      * @returns {Boolean}
      */
-    readonly isEntity: boolean;
+    get isEntity(): boolean;
 
     /**
      * Returns ````true```` if this SceneModelEntity represents a model.
@@ -47,7 +47,7 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    readonly isModel: boolean;
+    get isModel(): boolean;
 
     /**
      * Returns ````true```` if this SceneModelEntity represents an object.
@@ -58,18 +58,26 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    readonly isObject: boolean;
+    get isObject(): boolean;
 
     /** Returns the parent SceneModelEntity, if any. */
-    readonly parent: void;
+    get parent(): void;
 
     /**
-     * The 3D World-space origin for this SceneModelEntity.
+     * Sets the 3D World-space origin for this SceneModelEntity.
      *
      * @type {Float64Array}
      * @abstract
      */
-    origin: Float64Array;
+    set origin(arg: Float64Array);
+
+    /**
+     * Gets the 3D World-space origin for this SceneModelEntity.
+     *
+     * @type {Float64Array}
+     * @abstract
+     */
+    get origin(): Float64Array;
 
     /**
      * World-space 3D axis-aligned bounding box (AABB) of this SceneModelEntity.
@@ -80,12 +88,12 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Float64Array}
      * @abstract
      */
-    readonly aabb: number[];
+    get aabb(): number[];
 
     /**
      * The approximate number of primitives in this SceneModelEntity
      */
-    readonly numPrimitives: number;
+    get numPrimitives(): number;
 
     /**
      * The approximate number of triangles in this SceneModelEntity.
@@ -93,10 +101,23 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {number}
      * @abstract
      */
-    readonly numTriangles: number;
+    get numTriangles(): number;
+
+    /**
+     * Sets if this SceneModelEntity is visible.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.visible} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.visibleObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set visible(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is visible.
+     * Gets if this SceneModelEntity is visible.
      *
      * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
      *
@@ -106,10 +127,21 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    visible: boolean;
+    get visible(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is xrayed.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.xrayed} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.xrayedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set xrayed(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is xrayed.
+     * Gets if this SceneModelEntity is xrayed.
      *
      * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.xrayed} are both ````true``` the SceneModelEntity will be
      * registered by {@link SceneModelEntity.id} in {@link Scene.xrayedObjects}.
@@ -117,10 +149,21 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    xrayed: boolean;
+    get xrayed(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is highlighted.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.highlighted} are both ````true```` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.highlightedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set highlighted(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is highlighted.
+     * Gets if this SceneModelEntity is highlighted.
      *
      * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.highlighted} are both ````true```` the SceneModelEntity will be
      * registered by {@link SceneModelEntity.id} in {@link Scene.highlightedObjects}.
@@ -128,10 +171,21 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    highlighted: boolean;
+    get highlighted(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is selected.
+     *
+     * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.selected} are both ````true``` the SceneModelEntity will be
+     * registered by {@link SceneModelEntity.id} in {@link Scene.selectedObjects}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set selected(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is selected.
+     * Gets if this SceneModelEntity is selected.
      *
      * When {@link SceneModelEntity.isObject} and {@link SceneModelEntity.selected} are both ````true``` the SceneModelEntity will be
      * registered by {@link SceneModelEntity.id} in {@link Scene.selectedObjects}.
@@ -139,121 +193,218 @@ export declare abstract class SceneModelEntity implements Entity {
      * @type {Boolean}
      * @abstract
      */
-    selected: boolean;
+    get selected(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity's edges are enhanced.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set edges(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity's edges are enhanced.
+     * Gets if this SceneModelEntity's edges are enhanced.
      *
      * @type {Boolean}
      * @abstract
      */
-    edges: boolean;
+    get edges(): boolean;
+
+    /**
+     * Toggle View Frustum Culling
+     */
+    set culledVFC(arg: boolean);
+
+    /**
+     * Gets View Frustum Culling
+     */
+    get culledVFC(): boolean;
 
     /**
-     * Whether View Frustum Culling is enabled
+     * Toggle Level of Detail Culling
      */
-    culledVFC: boolean;
+    set culledLOD(arg: boolean);
 
     /**
-     * Whether Level of Detail Culling is enabled
+     * Gets level of detail culling
+     */
+    get culledLOD(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is culled.
+     *
+     * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
+     *
+     * @type {Boolean}
+     * @abstract
      */
-    culledLOD: boolean;
+    set culled(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is culled.
+     * Gets if this SceneModelEntity is culled.
      *
      * Only rendered when {@link SceneModelEntity.visible} is ````true```` and {@link SceneModelEntity.culled} is ````false````.
      *
      * @type {Boolean}
      * @abstract
      */
-    culled: boolean;
+    get culled(): boolean;
 
     /**
-     * Whether this SceneModelEntity is clippable.
+     * Sets if this SceneModelEntity is clippable.
      *
      * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
      *
      * @type {Boolean}
      * @abstract
      */
-    clippable: boolean;
+    set clippable(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is included in boundary calculations.
+     * Gets if this SceneModelEntity is clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get clippable(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is included in boundary calculations.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set collidable(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity is included in boundary calculations.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get collidable(): boolean;
+
+    /**
+     * Sets if this SceneModelEntity is pickable.
+     *
+     * Picking is done via calls to {@link Scene.pick}.
      *
      * @type {Boolean}
      * @abstract
      */
-    collidable: boolean;
+    set pickable(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity is pickable.
+     * Gets if this SceneModelEntity is pickable.
      *
      * Picking is done via calls to {@link Scene.pick}.
      *
      * @type {Boolean}
      * @abstract
      */
-    pickable: boolean;
+    get pickable(): boolean;
+
+    /**
+     * Sets the SceneModelEntity's RGB colorize color, multiplies by the SceneModelEntity's rendered fragment colors.
+     *
+     * Each element of the color is in range ````[0..1]````.
+     *
+     * @type {number[]}
+     * @abstract
+     */
+    set colorize(arg: number[]);
 
     /**
-     * The SceneModelEntity's RGB colorize color, multiplies by the SceneModelEntity's rendered fragment colors.
+     * Gets the SceneModelEntity's RGB colorize color, multiplies by the SceneModelEntity's rendered fragment colors.
      *
      * Each element of the color is in range ````[0..1]````.
      *
      * @type {number[]}
      * @abstract
      */
-    colorize: number[];
+    get colorize(): number[];
 
     /**
-     * The SceneModelEntity's opacity factor, multiplies by the SceneModelEntity's rendered fragment alphas.
+     * Sets the SceneModelEntity's opacity factor, multiplies by the SceneModelEntity's rendered fragment alphas.
      *
      * This is a factor in range ````[0..1]````.
      *
      * @type {number}
      * @abstract
      */
-    opacity: number;
+    set opacity(arg: number);
 
     /**
-     * Whether this SceneModelEntity casts shadows.
+     * Gets the SceneModelEntity's opacity factor.
+     *
+     * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+     *
+     * @type {number}
+     * @abstract
+     */
+    get opacity(): number;
+
+    /**
+     * Sets if this SceneModelEntity casts shadows.
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    set castsShadow(arg: boolean);
+
+    /**
+     * Gets if this SceneModelEntity casts shadows.
      *
      * @type {Boolean}
      * @abstract
      */
-    castsShadow: boolean;
+    get castsShadow(): boolean;
 
     /**
-     * Whether this SceneModelEntity can have shadows cast upon it
+     * Sets if to this SceneModelEntity can have shadows cast upon it
      *
      * @type {Boolean}
      * @abstract
      */
-    receivesShadow: boolean;
+    set receivesShadow(arg: boolean);
 
     /**
-     * Whether this SceneModelEntity can have Scalable Ambient Obscurance (SAO) applied to it.
+     * Gets if this SceneModelEntity can have shadows cast upon it
+     *
+     * @type {Boolean}
+     * @abstract
+     */
+    get receivesShadow(): boolean;
+
+    /**
+     * Gets if this SceneModelEntity can have Scalable Ambient Obscurance (SAO) applied to it.
      *
      * SAO is configured by {@link SAO}.
      *
      * @type {Boolean}
      * @abstract
      */
-    readonly saoEnabled: boolean;
+    get saoEnabled(): boolean;
 
     /**
-     * The material for this SceneModelEntity that will be used on the caps 
+     * Sets the material for this SceneModelEntity that will be used on the caps 
      * when the objects of this entity are sliced
      * 
      * If there is no capMaterial attached to a SceneModelEntity then its objects
      * will not be capped when sliced
      */
-    capMaterial: Material;
+    set capMaterial(value: Material);
+
+    /**
+     * Gets the cap material attached to this SceneModelEntity
+     */
+    get capMaterial(): Material;
 
     /**
-     * The SceneModelEntity's 3D World-space offset.
+     * Sets the SceneModelEntity's 3D World-space offset.
      *
      * Since offsetting Entities comes with memory and rendering overhead on some systems, this feature
      * only works when {@link Viewer} is configured with ````entityOffsetsEnabled: true````.
@@ -268,7 +419,17 @@ export declare abstract class SceneModelEntity implements Entity {
      * @abstract
      * @type {number[]}
      */
-    offset: number[];
+    set offset(arg: number[]);
+
+    /**
+     * Gets the SceneModelEntity's 3D World-space offset.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @abstract
+     * @type {number[]}
+     */
+    get offset(): number[];
 
     /**
      * Gets the World, View and Canvas-space positions of each vertex in a callback.
@@ -283,24 +444,29 @@ export declare abstract class SceneModelEntity implements Entity {
     getEachIndex(callback: any): void;
 
     /**
-     * The volume of this SceneModelEntity.
+     * Gets the complete geometry of this entity.
+     */
+    getGeometryData(): {indices: number[],positions:number[]}
+
+    /**
+     * Returns the volume of this SceneModelEntity.
      *
      * Only works when {@link Scene.readableGeometryEnabled | Scene.readableGeometryEnabled} is `true` and the
      * SceneModelEntity contains solid triangle meshes; returns `0` otherwise.
      *
      * @returns {number}
      */
-    readonly volume: number;
+    get volume(): number;
 
     /**
-     * The surface area of this SceneModelEntity.
+     * Returns the surface area of this SceneModelEntity.
      *
      * Only works when {@link Scene.readableGeometryEnabled | Scene.readableGeometryEnabled} is `true` and the
      * SceneModelEntity contains triangle meshes; returns `0` otherwise.
      *
      * @returns {number}
      */
-    readonly surfaceArea: number;
+    get surfaceArea(): number;
 
     /**
      * The {@link SceneModel} to which this SceneModelEntity belongs.

package/types/viewer/scene/models/SceneModelMesh.d.ts

@@ -73,15 +73,15 @@ export declare class SceneModelMesh {
     isSolid(): boolean;
 
     /**
-     * The volume of this SceneModelMesh.
+     * Returns the volume of this SceneModelMesh.
      * @returns {number}
      */
-    readonly volume: number;
+    get volume(): number;
 
     /**
-     * The surface area of this SceneModelMesh.
+     * Returns the surface area of this SceneModelMesh.
      * @returns {number}
      */
-    readonly surfaceArea: number;
+    get surfaceArea(): number;
 
 }

package/types/viewer/scene/models/SceneModelTransform.d.ts

@@ -23,67 +23,112 @@ export declare class SceneModelTransform {
      *
      * @type {SceneModelTransform}
      */
-    readonly parentTransform: SceneModelTransform | null;
+    get parentTransform(): SceneModelTransform | null;
 
     /**
      * The {@link SceneModelMesh}es transformed by this SceneModelTransform.
      *
      * @returns {[]}
      */
-    readonly meshes: SceneModelMesh[];
+    get meshes(): SceneModelMesh[];
 
     /**
-     * The SceneModelTransform's local translation.
+     * Sets the SceneModelTransform's local translation.
      *
      * Default value is ````[0,0,0]````.
      *
      * @type {number[]}
      */
-    position: number[];
+    set position(value: number[]);
 
     /**
-     * The SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     * Gets the SceneModelTransform's translation.
      *
      * Default value is ````[0,0,0]````.
      *
      * @type {number[]}
      */
-    rotation: number[];
+    get position(): number[];
 
     /**
-     * The SceneModelTransform's rotation quaternion.
+     * Sets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @type {number[]}
+     */
+    set rotation(value: number[]);
+
+    /**
+     * Gets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @type {number[]}
+     */
+    get rotation(): number[];
+
+    /**
+     * Sets the SceneModelTransform's rotation quaternion.
      *
      * Default value is ````[0,0,0,1]````.
      *
      * @type {number[]}
      */
-    quaternion: number[];
+    set quaternion(value: number[]);
 
     /**
-     * The SceneModelTransform's scale.
+     * Gets the SceneModelTransform's rotation quaternion.
+     *
+     * Default value is ````[0,0,0,1]````.
+     *
+     * @type {number[]}
+     */
+    get quaternion(): number[];
+
+    /**
+     * Sets the SceneModelTransform's scale.
      *
      * Default value is ````[1,1,1]````.
      *
      * @type {number[]}
      */
-    scale: number[];
+    set scale(value: number[]);
+
+    /**
+     * Gets the SceneModelTransform's scale.
+     *
+     * Default value is ````[1,1,1]````.
+     *
+     * @type {number[]}
+     */
+    get scale(): number[];
+
+    /**
+     * Sets the SceneModelTransform's transform matrix.
+     *
+     * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+     *
+     * @type {number[]}
+     */
+    set matrix(value: number[]);
 
     /**
-     * The SceneModelTransform's transform matrix.
+     * Gets the SceneModelTransform's transform matrix.
      *
      * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
      *
      * @type {number[]}
      */
-    matrix: number[];
+    get matrix(): number[];
 
     /**
-     * The SceneModelTransform's World matrix.
+     * Gets the SceneModelTransform's World matrix.
      *
      * @property worldMatrix
      * @type {number[]}
      */
-    readonly worldMatrix: number[];
+    get worldMatrix(): number[];
 
     /**
      * Rotates the SceneModelTransform about the given axis by the given increment.