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

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

@@ -31,7 +31,7 @@ export declare class SceneModel extends Component {
      * Returns true to indicate that this Component is a SceneModel.
      * @type {Boolean}
      */
-    readonly isPerformanceModel: boolean;
+    get isPerformanceModel(): boolean;
 
     /**
      * The {@link SceneModelTransform}s in this SceneModel.
@@ -40,7 +40,7 @@ export declare class SceneModel extends Component {
      *
      * @returns {*|{}}
      */
-    readonly transforms: { [key: string]: SceneModelTransform };
+    get transforms(): { [key: string]: SceneModelTransform }
 
     /**
      * The {@link SceneModelTexture}s in this SceneModel.
@@ -50,7 +50,7 @@ export declare class SceneModel extends Component {
      *
      * @returns {*|{}}
      */
-    readonly textures: { [key: string]: SceneModelTexture };
+    get textures(): { [key: string]: SceneModelTexture }
 
     /**
      * The {@link SceneModelTextureSet}s in this SceneModel.
@@ -59,7 +59,7 @@ export declare class SceneModel extends Component {
      *
      * @returns {*|{}}
      */
-    readonly textureSets: { [key: string]: SceneModelTextureSet };
+    get textureSets(): { [key: string]: SceneModelTextureSet }
 
     /**
      * The {@link SceneModelMesh}es in this SceneModel.
@@ -68,16 +68,16 @@ export declare class SceneModel extends Component {
      *
      * @returns {*|{}}
      */
-    readonly meshes: { [key: string]: SceneModelMesh };
+    get meshes(): { [key: string]: SceneModelMesh }
 
     /**
-     * The {@link SceneModelEntity}s in this SceneModel.
+     * Returns the {@link SceneModelEntity}s in this SceneModel.
      * @returns {*|{}}
      */
-    readonly objects: { [key: string]: SceneModelEntity };
+    get objects(): { [key: string]: SceneModelEntity }
 
     /**
-     * The 3D World-space origin for this SceneModel.
+     * Gets the 3D World-space origin for this SceneModel.
      *
      * Each geometry or mesh origin, if supplied, is relative to this origin.
      *
@@ -85,86 +85,140 @@ export declare class SceneModel extends Component {
      *
      * @type {number[]}
      */
-    readonly origin: number[];
+    get origin(): number[];
 
     /**
-     * The SceneModel's local translation.
+     * Sets the SceneModel's local translation.
      *
      * Default value is ````[0,0,0]````.
      *
      * @type {number[]}
      */
-    position: number[];
+    set position(value: number[]);
 
     /**
-     * The SceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     * Gets the SceneModel's local translation.
      *
      * Default value is ````[0,0,0]````.
      *
      * @type {number[]}
      */
-    rotation: number[];
+    get position(): number[];
 
     /**
-     * The SceneModel's local rotation quaternion.
+     * Sets the SceneModel's local 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 SceneModel's local 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 SceneModel's local rotation quaternion.
+     *
+     * Default value is ````[0,0,0,1]````.
+     *
+     * @type {number[]}
+     */
+    set quaternion(value: number[]);
+
+    /**
+     * Gets the VBOSceneModels's local rotation quaternion.
      *
      * Default value is ````[0,0,0,1]````.
      *
      * @type {number[]}
      */
-    quaternion: number[];
+    get quaternion(): number[];
 
     /**
-     * The SceneModel's local scale.
+     * Sets the SceneModel's local scale.
      *
      * Default value is ````[1,1,1]````.
      *
      * @type {number[]}
      * @deprecated
      */
-    scale: number[];
+    set scale(value: number[]);
 
     /**
-     * The SceneModel's local modeling transform matrix.
+     * Gets the SceneModel's local scale.
+     *
+     * Default value is ````[1,1,1]````.
+     *
+     * @type {number[]}
+     */
+    get scale(): number[];
+
+    /**
+     * Sets the SceneModel's local modeling 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[];
+    set matrix(value: number[])
 
     /**
-     * The SceneModel's local modeling rotation transform matrix.
+     * Gets the SceneModel's local modeling transform matrix.
+     *
+     * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
      *
      * @type {number[]}
      */
-    readonly rotationMatrix: number[];
+    get matrix(): number[];
 
     /**
-     * The conjugate of the SceneModel's local modeling rotation transform matrix.
+     * Gets the SceneModel's local modeling rotation transform matrix.
+     *
+     * @type {number[]}
+     */
+    get rotationMatrix(): number[];
+
+    /**
+     * Gets the conjugate of the SceneModel's local modeling rotation transform matrix.
      *
      * This is used for RTC view matrix management in renderers.
      *
      * @type {Number[]}
      */
-    readonly rotationMatrixConjugate: number[];
+    get rotationMatrixConjugate(): number[];
 
     /**
-     * The SceneModel's World matrix.
+     * Gets the SceneModel's World matrix.
      *
      * @type {number[]}
      */
-    readonly worldMatrix: number[];
+    get worldMatrix(): number[];
 
     /**
-     * The SceneModel's World normal matrix.
+     * Gets the SceneModel's World normal matrix.
      *
      * @type {number[]}
      */
-    readonly worldNormalMatrix: number[];
+    get worldNormalMatrix(): number[];
 
     /**
-     * Whether backfaces are rendered for this SceneModel.
+     * Sets if backfaces are rendered for this SceneModel.
+     *
+     * Default is ````false````.
+     *
+     * @type {Boolean}
+     */
+    get backfaces(): boolean;
+
+    /**
+     * Sets if backfaces are rendered for this SceneModel.
      *
      * Default is ````false````.
      *
@@ -179,20 +233,20 @@ export declare class SceneModel extends Component {
      *
      * @type {Boolean}
      */
-    backfaces: boolean;
+    set backfaces(backfaces: boolean);
 
     /**
-     * The list of {@link SceneModelEntity}s within this SceneModel.
+     * Gets the list of {@link SceneModelEntity}s within this SceneModel.
      *
      * @returns {SceneModelEntity[]}
      */
-    readonly entityList: SceneModelEntity[];
+    get entityList(): SceneModelEntity[];
 
     /**
      * Returns true to indicate that SceneModel is an {@link SceneModelEntity}.
      * @type {Boolean}
      */
-    readonly isEntity: boolean;
+    get isEntity(): boolean;
 
     /**
      * Returns ````true```` if this SceneModel represents a model.
@@ -202,119 +256,199 @@ export declare class SceneModel extends Component {
      *
      * @type {Boolean}
      */
-    readonly isModel: boolean;
+    get isModel(): boolean;
 
     /**
      * Returns ````false```` to indicate that SceneModel never represents an object.
      *
      * @type {Boolean}
      */
-    readonly isObject: boolean;
+    get isObject(): boolean;
 
     /**
-     * The SceneModel's World-space 3D axis-aligned bounding box.
+     * Gets the SceneModel's World-space 3D axis-aligned bounding box.
      *
      * Represented by a six-element Float64Array containing the min/max extents of the
      * axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
      *
      * @type {number[]}
      */
-    readonly aabb: number[];
+    get aabb(): number[];
 
     /**
      * The approximate number of triangle primitives in this SceneModel.
      *
      * @type {number}
      */
-    readonly numTriangles: number;
+    get numTriangles(): number;
 
     /**
      * The approximate number of line primitives in this SceneModel.
      *
      * @type {number}
      */
-    readonly numLines: number;
+    get numLines(): number;
 
     /**
      * The approximate number of point primitives in this SceneModel.
      *
      * @type {number}
      */
-    readonly numPoints: number;
+    get numPoints(): number;
 
     /**
-     * Whether this SceneModel is visible.
+     * Gets if any {@link SceneModelEntity}s in this SceneModel are visible.
      *
      * The SceneModel is only rendered when {@link SceneModel.visible} is ````true```` and {@link SceneModel.culled} is ````false````.
      *
      * @type {Boolean}
      */
-    visible: boolean;
+    get visible(): boolean;
+
+    /**
+     * Sets if this SceneModel is visible.
+     *
+     * The SceneModel is only rendered when {@link SceneModel.visible} is ````true```` and {@link SceneModel.culled} is ````false````.
+     **
+     * @type {Boolean}
+     */
+    set visible(visible: boolean);
+
+    /**
+     * Gets if any {@link SceneModelEntity}s in this SceneModel are xrayed.
+     *
+     * @type {Boolean}
+     */
+    get xrayed(): boolean
+
+    /**
+     * Sets if all {@link SceneModelEntity}s in this SceneModel are xrayed.
+     *
+     * @type {Boolean}
+     */
+    set xrayed(xrayed: boolean);
+
+    /**
+     * Gets if any {@link SceneModelEntity}s in this SceneModel are highlighted.
+     *
+     * @type {Boolean}
+     */
+    get highlighted(): boolean;
 
     /**
-     * Whether any {@link SceneModelEntity}s in this SceneModel are xrayed.
+     * Sets if all {@link SceneModelEntity}s in this SceneModel are highlighted.
      *
      * @type {Boolean}
      */
-    xrayed: boolean;
+    set highlighted(highlighted: boolean);
 
     /**
-     * Whether any {@link SceneModelEntity}s in this SceneModel are highlighted.
+     * Gets if any {@link SceneModelEntity}s in this SceneModel are selected.
      *
      * @type {Boolean}
      */
-    highlighted: boolean;
+    get selected(): boolean;
 
     /**
-     * Whether any {@link SceneModelEntity}s in this SceneModel are selected.
+     * Sets if all {@link SceneModelEntity}s in this SceneModel are selected.
      *
      * @type {Boolean}
      */
-    selected: boolean;
+    set selected(selected: boolean);
 
     /**
-     * Whether any {@link SceneModelEntity}s in this SceneModel have edges emphasised.
+     * Gets if any {@link SceneModelEntity}s in this SceneModel have edges emphasised.
+     *
+     * @type {Boolean}
+     */
+    get edges(): boolean;
+
+    /**
+     * Sets if all {@link SceneModelEntity}s in this SceneModel have edges emphasised.
+     *
+     * @type {Boolean}
+     */
+    set edges(edges: boolean);
+
+    /**
+     * Gets if this SceneModel is culled from view.
+     *
+     * The SceneModel is only rendered when {@link SceneModel.visible} is true and {@link SceneModel.culled} is false.
      *
      * @type {Boolean}
      */
-    edges: boolean;
+    get culled(): boolean;
 
     /**
-     * Whether this SceneModel is culled from view.
+     * Sets if this SceneModel is culled from view.
      *
      * The SceneModel is only rendered when {@link SceneModel.visible} is true and {@link SceneModel.culled} is false.
      *
      * @type {Boolean}
      */
-    culled: boolean;
+    set culled(culled: boolean);
+
+    /**
+     * Gets if {@link SceneModelEntity}s in this SceneModel are clippable.
+     *
+     * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
+     *
+     * @type {Boolean}
+     */
+    get clippable(): boolean;
 
     /**
-     * Whether {@link SceneModelEntity}s in this SceneModel are clippable.
+     * Sets if {@link SceneModelEntity}s in this SceneModel are clippable.
      *
      * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
      *
      * @type {Boolean}
      */
-    clippable: boolean;
+    set clippable(clippable: boolean);
 
     /**
-     * Whether {@link SceneModelEntity}s in this SceneModel are collidable.
+     * Gets if this SceneModel is collidable.
      *
      * @type {Boolean}
      */
-    collidable: boolean;
+    get collidable(): boolean;
 
     /**
-     * Whether {@link SceneModelEntity}s in this SceneModel are pickable.
+     * Sets if {@link SceneModelEntity}s in this SceneModel are collidable.
+     *
+     * @type {Boolean}
+     */
+    set collidable(collidable: boolean);
+
+    /**
+     * Gets if this SceneModel is pickable.
      *
      * Picking is done via calls to {@link Scene.pick}.
      *
      * @type {Boolean}
      */
-    pickable: boolean;
+    get pickable(): boolean;
 
     /**
-     * The RGB colorize color for this SceneModel.
+     * Sets if {@link SceneModelEntity}s in this SceneModel are pickable.
+     *
+     * Picking is done via calls to {@link Scene.pick}.
+     *
+     * @type {Boolean}
+     */
+    set pickable(pickable: boolean);
+
+    /**
+     * Gets the RGB colorize color for this SceneModel.
+     *
+     * Each element of the color is in range ````[0..1]````.
+     *
+     * @type {number[]}
+     */
+    get colorize(): number[];
+
+    /**
+     * Sets the RGB colorize color for this SceneModel.
      *
      * Multiplies by rendered fragment colors.
      *
@@ -322,33 +456,56 @@ export declare class SceneModel extends Component {
      *
      * @type {number[]}
      */
-    colorize: number[];
+    set colorize(colorize: number[]);
 
     /**
-     * The opacity factor for this SceneModel.
+     * Gets this SceneModel's opacity factor.
      *
      * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
      *
      * @type {number}
      */
-    opacity: number;
+    get opacity(): number;
+
+    /**
+     * Sets the opacity factor for this SceneModel.
+     *
+     * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+     *
+     * @type {number}
+     */
+    set opacity(opacity: number);
+
+    /**
+     * Gets if this SceneModel casts a shadow.
+     *
+     * @type {Boolean}
+     */
+    get castsShadow(): boolean;
+
+    /**
+     * Sets if this SceneModel casts a shadow.
+     *
+     * @type {Boolean}
+     */
+    set castsShadow(castsShadow: boolean);
 
     /**
-     * Whether this SceneModel casts a shadow.
+     * Sets if this SceneModel can have shadow cast upon it.
      *
      * @type {Boolean}
      */
-    castsShadow: boolean;
+    get receivesShadow(): boolean;
 
     /**
-     * Whether this SceneModel can have shadow cast upon it.
+     * Sets if this SceneModel can have shadow cast upon it.
      *
      * @type {Boolean}
      */
-    receivesShadow: boolean;
+    set receivesShadow(receivesShadow: boolean);
 
     /**
-     * Whether Scalable Ambient Obscurance (SAO) will apply to this SceneModel.
+     * Gets if Scalable Ambient Obscurance (SAO) will apply to this SceneModel.
      *
      * SAO is configured by the Scene's {@link SAO} component.
      *
@@ -356,32 +513,32 @@ export declare class SceneModel extends Component {
      *
      * @type {Boolean}
      */
-    readonly saoEnabled: boolean;
+    get saoEnabled(): boolean;
 
     /**
-     * Whether physically-based rendering (PBR) is enabled for this SceneModel.
+     * Gets if physically-based rendering (PBR) is enabled for this SceneModel.
      *
      * Only works when {@link Scene.pbrEnabled} is also true.
      *
      * @type {Boolean}
      */
-    readonly pbrEnabled: boolean;
+    get pbrEnabled(): boolean;
 
     /**
-     * Whether color textures are enabled for this SceneModel.
+     * Gets if color textures are enabled for this SceneModel.
      *
      * Only works when {@link Scene#colorTextureEnabled} is also true.
      *
      * @type {Boolean}
      */
-    readonly colorTextureEnabled: boolean;
+    get colorTextureEnabled(): boolean;
 
     /**
      * Returns true to indicate that SceneModel is implements {@link Drawable}.
      *
      * @type {Boolean}
      */
-    readonly isDrawable: boolean;
+    get isDrawable(): boolean;
 
     /**
      * Configures the appearance of xrayed {@link SceneModelEntity}s within this SceneModel.
@@ -390,7 +547,7 @@ export declare class SceneModel extends Component {
      *
      * @type {EmphasisMaterial}
      */
-    readonly xrayMaterial: EmphasisMaterial;
+    get xrayMaterial(): EmphasisMaterial;
 
     /**
      * Configures the appearance of highlighted {@link SceneModelEntity}s within this SceneModel.
@@ -399,7 +556,7 @@ export declare class SceneModel extends Component {
      *
      * @type {EmphasisMaterial}
      */
-    readonly highlightMaterial: EmphasisMaterial;
+    get highlightMaterial(): EmphasisMaterial;
 
     /**
      * Configures the appearance of selected {@link SceneModelEntity}s within this SceneModel.
@@ -408,7 +565,7 @@ export declare class SceneModel extends Component {
      *
      * @type {EmphasisMaterial}
      */
-    readonly selectedMaterial: EmphasisMaterial;
+    get selectedMaterial(): EmphasisMaterial;
 
     /**
      * Configures the appearance of edges of {@link SceneModelEntity}s within this SceneModel.
@@ -417,7 +574,7 @@ export declare class SceneModel extends Component {
      *
      * @type {EdgeMaterial}
      */
-    readonly edgeMaterial: EdgeMaterial;
+    get edgeMaterial(): EdgeMaterial;
 
     /**
      *