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

package/types/viewer/scene/scene/Scene.d.ts

@@ -92,7 +92,7 @@ export declare class Scene extends Component {
   /**
    * The epoch time (in milliseconds since 1970) when this Scene was instantiated.
    */
-  readonly startTime: Date;
+  get startTime(): Date;
 
   /**
    * Map of {@link Entity}s that represent models.
@@ -100,7 +100,7 @@ export declare class Scene extends Component {
    * Each {@link Entity} is mapped here by {@link Entity.id} when {@link Entity.isModel} is ````true````.
    * @type {{String:Entity}}
    */
-  readonly models: {[key: string]: Entity};
+  get models(): {[key: string]: Entity};
 
   /**
    * Map of {@link Entity}s that represents objects.
@@ -109,7 +109,7 @@ export declare class Scene extends Component {
    * @final
    * @type {{String:Entity}}
    */
-  readonly objects: {[key: string]: Entity};
+  get objects(): {[key: string]: Entity};
 
   /**
    * Map of {@link SectionPlane}s that represent sliced section planes.
@@ -117,7 +117,7 @@ export declare class Scene extends Component {
    * Each {@link SectionPlane} is mapped here by {@link SectionPlane.id}.
    * @type {{String:SectionPlane}}
    */
-  readonly sectionPlanes: { [key: string]: SectionPlane };
+  get sectionPlanes(): { [key: string]: SectionPlane };
 
   /**
    * Map of currently visible {@link Entity}s that represent objects.
@@ -125,7 +125,7 @@ export declare class Scene extends Component {
    * An Entity represents an object if {@link Entity.isObject} is ````true````, and is visible when {@link Entity.visible} is true.
    * @type {{String:Object}}
    */
-  readonly visibleObjects: {[key: string]: Entity};
+  get visibleObjects(): {[key: string]: Entity};
 
   /**
    * Map of currently xrayed {@link Entity}s that represent objects.
@@ -136,7 +136,7 @@ export declare class Scene extends Component {
    *
    * @type {{String:Object}}
    */
-  readonly xrayedObjects: {[key: string]: Entity};
+  get xrayedObjects(): {[key: string]: Entity};
 
   /**
    * Map of currently highlighted {@link Entity}s that represent objects.
@@ -147,7 +147,7 @@ export declare class Scene extends Component {
    *
    * @type {{String:Object}}
    */
-  readonly highlightedObjects: {[key: string]: Entity};
+  get highlightedObjects(): {[key: string]: Entity};
 
   /**
    * Map of currently selected {@link Entity}s that represent objects.
@@ -158,7 +158,7 @@ export declare class Scene extends Component {
    *
    * @type {{String:Object}}
    */
-  readonly selectedObjects: {[key: string]: Entity};
+  get selectedObjects(): {[key: string]: Entity};
 
   /**
    * Map of currently colorized {@link Entity}s that represent objects.
@@ -169,7 +169,7 @@ export declare class Scene extends Component {
    *
    * @type {{String:Object}}
    */
-  readonly colorizedObjects: {[key: string]: Entity};
+  get colorizedObjects(): {[key: string]: Entity};
 
   /**
    * Map of {@link Entity}s that represent objects whose opacity was updated.
@@ -180,7 +180,7 @@ export declare class Scene extends Component {
    *
    * @type {{String:Object}}
    */
-  readonly opacityObjects: {[key: string]: Entity};
+  get opacityObjects(): {[key: string]: Entity};
 
   /**
    * Map of {@link Entity}s that represent objects whose {@link Entity.offset}s were updated.
@@ -193,7 +193,7 @@ export declare class Scene extends Component {
    * @final
    * @type {{String:Object}}
    */
-  readonly offsetObjects: {[key: string]: Entity};
+  get offsetObjects(): {[key: string]: Entity};
 
   /**
    * Whether {@link Entity.offset} is enabled.
@@ -202,7 +202,7 @@ export declare class Scene extends Component {
    *
    * @returns {Boolean} True if {@link Entity.offset} is enabled.
    */
-  readonly entityOffsetsEnabled: boolean;
+  get entityOffsetsEnabled(): boolean;
 
   /**
    * Whether geometry is readable.
@@ -215,7 +215,7 @@ export declare class Scene extends Component {
    *
    * @returns {Boolean} True if geometry is readable.
    */
-  readonly readableGeometryEnabled: boolean;
+  get readableGeometryEnabled(): boolean;
 
   /**
    * Whether precision surface picking is enabled.
@@ -228,7 +228,7 @@ export declare class Scene extends Component {
    *
    * @returns {Boolean} True if precision picking is enabled.
    */
-  readonly pickSurfacePrecisionEnabled: boolean;
+  get pickSurfacePrecisionEnabled(): boolean;
 
   /**
    * Whether logarithmic depth buffer is enabled.
@@ -237,10 +237,10 @@ export declare class Scene extends Component {
    *
    * @returns {Boolean} True if logarithmic depth buffer is enabled.
    */
-  readonly logarithmicDepthBufferEnabled: boolean;
+  get logarithmicDepthBufferEnabled(): boolean;
 
   /**
-   * The number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   * Sets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
    *
    * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
    * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
@@ -250,19 +250,40 @@ export declare class Scene extends Component {
    *
    * Default is ````0````.
    */
-  numCachedSectionPlanes: number;
+  set numCachedSectionPlanes(numCachedSectionPlanes: number);
 
   /**
-   * Whether physically-based rendering is enabled.
+   * Gets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   *
+   * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
+   * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
+   * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
+   * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
+   * your expected usage.
+   *
+   * Default is ````0````.
+   *
+   * @returns {number} The number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   */
+  get numCachedSectionPlanes(): number;
+
+  /**
+   * Sets whether physically-based rendering is enabled.
+   *
+   */
+  set pbrEnabled(value: boolean);
+
+  /**
+   * Gets whether quality rendering is enabled.
    *
    * Default is ````false````.
    *
    * @returns {Boolean} True if quality rendering is enabled.
    */
-  pbrEnabled: boolean;
+  get pbrEnabled(): boolean
 
   /**
-   * Whether data texture scene representation (DTX) is enabled for the {@link Scene}.
+   * Sets whether data texture scene representation (DTX) is enabled for the {@link Scene}.
    *
    * Even when enabled, DTX will only work if supported.
    *
@@ -270,19 +291,37 @@ export declare class Scene extends Component {
    *
    * @type {Boolean}
    */
-  dtxEnabled: boolean;
+  set dtxEnabled(value: boolean);
 
   /**
-   * Whether basic color texture rendering is enabled.
+   * Gets whether data texture-based scene representation (DTX) is enabled for the {@link Scene}.
+   *
+   * Even when enabled, DTX will only apply if supported.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get dtxEnabled(): boolean;
+
+  /**
+   * Sets whether basic color texture rendering is enabled.
+   *
+   * Default is ````true````.
+   */
+  set colorTextureEnabled(colorTextureEnabled: boolean);
+
+  /**
+   * Gets whether basic color texture rendering is enabled.
    *
    * Default is ````true````.
    *
    * @returns {Boolean} True if basic color texture rendering is enabled.
    */
-  colorTextureEnabled: boolean;
+  get colorTextureEnabled(): boolean;
 
   /**
-   * The Z value of offset for Marker's OcclusionTester.
+   * Gets the Z value of offset for Marker's OcclusionTester.
    * The closest the value is to 0.000 the more precise OcclusionTester will be, but at the same time the less
    * precise it will behave for Markers that are located exactly on the Surface.
    *
@@ -290,139 +329,175 @@ export declare class Scene extends Component {
    *
    * @returns {Number} Z offset for Marker
    */
-  readonly markerZOffset: number;
+  get markerZOffset(): number
 
   /**
-   * The IDs of the {@link Entity}s in {@link Scene.models}.
+   * Gets the IDs of the {@link Entity}s in {@link Scene.models}.
    *
    * @type {String[]}
    */
-  readonly modelIds: string[];
+  get modelIds(): string[];
 
   /**
-   * The number of {@link Entity}s in {@link Scene.objects}.
+   * Gets the number of {@link Entity}s in {@link Scene.objects}.
    *
    * @type {Number}
    */
-  readonly numObjects: number;
+  get numObjects(): number;
 
   /**
-   * The IDs of the {@link Entity}s in {@link Scene.objects}.
+   * Gets the IDs of the {@link Entity}s in {@link Scene.objects}.
    *
    * @type {String[]}
    */
-  readonly objectIds: string[];
+  get objectIds(): string[];
 
   /**
-  * The number of {@link Entity}s in {@link Scene.visibleObjects}.
+  * Gets the number of {@link Entity}s in {@link Scene.visibleObjects}.
   *
   * @type {Number}
   */
-  readonly numVisibleObjects: number;
+  get numVisibleObjects(): number;
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.visibleObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.visibleObjects}.
   *
   * @type {String[]}
   */
-  readonly visibleObjectIds: string[];
+  get visibleObjectIds(): string[];
 
   /**
-  * The number of {@link Entity}s in {@link Scene.xrayedObjects}.
+  * Gets the number of {@link Entity}s in {@link Scene.xrayedObjects}.
   *
   * @type {Number}
   */
-  readonly numXRayedObjects: number;
+  get numXRayedObjects(): number;
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.xrayedObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.xrayedObjects}.
   *
   * @type {String[]}
   */
-  readonly xrayedObjectIds: string[];
+  get xrayedObjectIds(): string[];
 
   /**
-  * The number of {@link Entity}s in {@link Scene.highlightedObjects}.
+  * Gets the number of {@link Entity}s in {@link Scene.highlightedObjects}.
   *
   * @type {Number}
   */
-  readonly numHighlightedObjects: number;
+  get numHighlightedObjects(): number;
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.highlightedObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.highlightedObjects}.
   *
   * @type {String[]}
   */
-  readonly highlightedObjectIds: string[];
+  get highlightedObjectIds(): string[];
 
   /**
-  * The number of {@link Entity}s in {@link Scene.selectedObjects}.
+  * Gets the number of {@link Entity}s in {@link Scene.selectedObjects}.
   *
   * @type {Number}
   */
-  readonly numSelectedObjects: number;
+  get numSelectedObjects(): number;
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.selectedObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.selectedObjects}.
   *
   * @type {String[]}
   */
-  readonly selectedObjectIds: string[];
+  get selectedObjectIds(): string[];
 
   /**
-  * The number of {@link Entity}s in {@link Scene.colorizedObjects}.
+  * Gets the number of {@link Entity}s in {@link Scene.colorizedObjects}.
   *
   * @type {Number}
   */
-  readonly numColorizedObjects: number;
+  get numColorizedObjects(): number;
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.colorizedObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.colorizedObjects}.
   *
   * @type {String[]}
   */
-  readonly colorizedObjectIds: string[];
+  get colorizedObjectIds(): string[];
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.opacityObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.opacityObjects}.
   *
   * @type {String[]}
   */
-  readonly opacityObjectIds: string[];
+  get opacityObjectIds(): string[];
 
   /**
-  * The IDs of the {@link Entity}s in {@link Scene.offsetObjects}.
+  * Gets the IDs of the {@link Entity}s in {@link Scene.offsetObjects}.
   *
   * @type {String[]}
   */
-  readonly offsetObjectIds: string[];
+  get offsetObjectIds(): string[];
 
   /**
-  * The number of "ticks" that happen between each render or this Scene.
+  * Sets the number of "ticks" that happen between each render or this Scene.
   *
   * Default value is ````1````.
   *
   * @type {Number}
   */
-  ticksPerRender: number;
+  set ticksPerRender(value: number);
 
   /**
-  * The number of "ticks" that happen between occlusion testing for {@link Marker}s.
+  * Gets the number of "ticks" that happen between each render or this Scene.
+  *
+  * Default value is ````1````.
+  *
+  * @type {Number}
+  */
+  get ticksPerRender(): number;
+
+  /**
+  * Sets the number of "ticks" that happen between occlusion testing for {@link Marker}s.
   *
   * Default value is ````20````.
   *
   * @type {Number}
   */
-  ticksPerOcclusionTest: number;
+  set ticksPerOcclusionTest(value: number);
+
+  /**
+  * Gets the number of "ticks" that happen between each render of this Scene.
+  *
+  * Default value is ````1````.
+  *
+  * @type {Number}
+  */
+  get ticksPerOcclusionTest(): number;
+
+  /**
+  * Sets the number of times this Scene renders per frame.
+  *
+  * Default value is ````1````.
+  *
+  * @type {Number}
+  */
+  set passes(value: number)
 
   /**
-  * The number of times this Scene renders per frame.
+  * Gets the number of times this Scene renders per frame.
   *
   * Default value is ````1````.
   *
   * @type {Number}
   */
-  passes: number;
+  get passes(): number;
+
+  /**
+  * When {@link Scene.passes} is greater than ````1````, indicates whether or not to clear the canvas before each pass (````true````) or just before the first pass (````false````).
+  *
+  * Default value is ````false````.
+  *
+  * @type {Boolean}
+  */
+  set clearEachPass(value: boolean);
 
   /**
   * When {@link Scene.passes} is greater than ````1````, indicates whether or not to clear the canvas before each pass (````true````) or just before the first pass (````false````).
@@ -431,37 +506,64 @@ export declare class Scene extends Component {
   *
   * @type {Boolean}
   */
-  clearEachPass: boolean;
+  get clearEachPass(): boolean;
 
   /**
-  * Whether or not {@link Scene} should expect all {@link Texture}s and colors to have pre-multiplied gamma.
+  * Sets whether or not {@link Scene} should expect all {@link Texture}s and colors to have pre-multiplied gamma.
   *
   * Default value is ````false````.
   *
   * @type {Boolean}
   */
-  gammaInput: boolean;
+  set gammaInput(value: boolean);
 
   /**
-  * Whether or not to render pixels with pre-multiplied gama.
+  * Gets whether or not {@link Scene} should expect all {@link Texture}s and colors to have pre-multiplied gamma.
   *
   * Default value is ````false````.
   *
   * @type {Boolean}
   */
-  gammaOutput: boolean;
+  get gammaInput(): boolean;
+
+  /**
+  * Sets whether or not to render pixels with pre-multiplied gama.
+  *
+  * Default value is ````false````.
+  *
+  * @type {Boolean}
+  */
+  set gammaOutput(value: boolean);
+
+  /**
+  * Gets whether or not to render pixels with pre-multiplied gama.
+  *
+  * Default value is ````true````.
+  *
+  * @type {Boolean}
+  */
+  get gammaOutput(): boolean;
+
+  /**
+  * Sets the gamma factor to use when {@link Scene.gammaOutput} is set true.
+  *
+  * Default value is ````2.2````.
+  *
+  * @type {Number}
+  */
+  set gammaFactor(value: number);
 
   /**
-  * The gamma factor to use when {@link Scene.gammaOutput} is set true.
+  * Gets the gamma factor to use when {@link Scene.gammaOutput} is set true.
   *
   * Default value is ````2.2````.
   *
   * @type {Number}
   */
-  gammaFactor: number;
+  get gammaFactor(): number;
 
   /**
-  * The default {@link Geometry} for this Scene, which is a {@link ReadableGeometry} with a unit-sized box shape.
+  * Gets the default {@link Geometry} for this Scene, which is a {@link ReadableGeometry} with a unit-sized box shape.
   *
   * Has {@link ReadableGeometry.id} set to "default.geometry".
   *
@@ -469,10 +571,10 @@ export declare class Scene extends Component {
   *
   * @type {ReadableGeometry}
   */
-  readonly geometry: ReadableGeometry;
+  get geometry(): ReadableGeometry;
 
   /**
-  * The default {@link Material} for this Scene, which is a {@link PhongMaterial}.
+  * Gets the default {@link Material} for this Scene, which is a {@link PhongMaterial}.
   *
   * Has {@link PhongMaterial.id} set to "default.material".
   *
@@ -480,10 +582,10 @@ export declare class Scene extends Component {
   *
   * @type {PhongMaterial}
   */
-  readonly material: PhongMaterial;
+  get material(): PhongMaterial;
 
   /**
-  * The default xraying {@link EmphasisMaterial} for this Scene.
+  * Gets the default xraying {@link EmphasisMaterial} for this Scene.
   *
   * Has {@link EmphasisMaterial.id} set to "default.xrayMaterial".
   *
@@ -493,10 +595,10 @@ export declare class Scene extends Component {
   *
   * @type {EmphasisMaterial}
   */
-  readonly xrayMaterial: EmphasisMaterial;
+  get xrayMaterial(): EmphasisMaterial;
 
   /**
-  * The default highlight {@link EmphasisMaterial} for this Scene.
+  * Gets the default highlight {@link EmphasisMaterial} for this Scene.
   *
   * Has {@link EmphasisMaterial.id} set to "default.highlightMaterial".
   *
@@ -506,10 +608,10 @@ export declare class Scene extends Component {
   *
   * @type {EmphasisMaterial}
   */
-  readonly highlightMaterial: EmphasisMaterial;
+  get highlightMaterial(): EmphasisMaterial;
 
   /**
-  * The default selection {@link EmphasisMaterial} for this Scene.
+  * Gets the default selection {@link EmphasisMaterial} for this Scene.
   *
   * Has {@link EmphasisMaterial.id} set to "default.selectedMaterial".
   *
@@ -519,10 +621,10 @@ export declare class Scene extends Component {
   *
   * @type {EmphasisMaterial}
   */
-  readonly selectedMaterial: EmphasisMaterial;
+  get selectedMaterial(): EmphasisMaterial;
 
   /**
-  * The default {@link EdgeMaterial} for this Scene.
+  * Gets the default {@link EdgeMaterial} for this Scene.
   *
   * Has {@link EdgeMaterial.id} set to "default.edgeMaterial".
   *
@@ -532,45 +634,45 @@ export declare class Scene extends Component {
   *
   * @type {EdgeMaterial}
   */
-  readonly edgeMaterial: EdgeMaterial;
+  get edgeMaterial(): EdgeMaterial;
 
   /**
-  * The {@link PointsMaterial} for this Scene.
+  * Gets the {@link PointsMaterial} for this Scene.
   *
   * @type {PointsMaterial}
   */
-  readonly pointsMaterial: PointsMaterial;
+  get pointsMaterial(): PointsMaterial
 
   /**
-  * The {@link LinesMaterial} for this Scene.
+  * Gets the {@link LinesMaterial} for this Scene.
   *
   * @type {LinesMaterial}
   */
-  readonly linesMaterial: LinesMaterial;
+  get linesMaterial(): LinesMaterial
 
   /**
-  * The {@link Viewport} for this Scene.
+  * Gets the {@link Viewport} for this Scene.
   *
   * @type Viewport
   */
-  readonly viewport: Viewport;
+  get viewport(): Viewport
 
   /**
-  * The {@link Camera} for this Scene.
+  * Gets the {@link Camera} for this Scene.
   *
   * @type {Camera}
   */
-  readonly camera: Camera;
+  get camera(): Camera;
 
   /**
-  * The World-space 3D center of this Scene.
+  * Gets the World-space 3D center of this Scene.
   *
   *@type {Number[]}
   */
-  readonly center: number[];
+  get center(): number[];
 
   /**
-  * The World-space axis-aligned 3D boundary (AABB) of this Scene.
+  * Gets the World-space axis-aligned 3D boundary (AABB) of this Scene.
   *
   * The AABB is represented by a six-element Float64Array containing the min/max extents of the axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
   *
@@ -578,11 +680,11 @@ export declare class Scene extends Component {
   *
   * @type {Number[]}
   */
-  readonly aabb: number[];
+  get aabb(): number[];
 
-  readonly sao: SAO;
+  get sao(): SAO;
 
-  readonly input: Input;
+  get input(): Input;
 
   /**
    * Performs an occlusion test on all {@link Marker}s in this {@link Scene}.