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

package/types/viewer/scene/camera/Frustum.d.ts

@@ -15,71 +15,143 @@ export declare class Frustum extends Component {
   camera: Camera;
 
   /**
-   * The position of the Frustum's left plane on the View-space X-axis.
+   * Sets the position of the Frustum's left plane on the View-space X-axis.
    *
    * Fires a {@link Frustum.left:emits} emits on change.
+   *
+   * @param {Number} value New left frustum plane position.
+   */
+  set left(arg: number);
+
+  /**
+   * Gets the position of the Frustum's left plane on the View-space X-axis.
+   *
+   * @return {Number} Left frustum plane position.
+   */
+  get left(): number;
+
+  /**
+   * Sets the position of the Frustum's right plane on the View-space X-axis.
+   *
+   * Fires a {@link Frustum.right:emits} emits on change.
+   *
+   * @param {Number} value New right frustum plane position.
    */
-  left: number;
+  set right(arg: number);
 
   /**
-   * The position of the Frustum's right plane on the View-space X-axis.
+   * Gets the position of the Frustum's right plane on the View-space X-axis.
    *
    * Fires a {@link Frustum.right:emits} emits on change.
+   *
+   * @return {Number} Right frustum plane position.
    */
-  right: number;
+  get right(): number;
 
   /**
-   * The position of the Frustum's bottom plane on the View-space Y-axis.
+   * Sets the position of the Frustum's bottom plane on the View-space Y-axis.
    *
    * Fires a {@link Frustum.bottom:emits} emits on change.
    *
    * @emits {"bottom"} event with the value of this property whenever it changes.
+   *
+   * @param {Number} value New bottom frustum plane position.
    */
-  bottom: number;
+  set bottom(arg: number);
 
   /**
-   * The position of the Frustum's top plane on the View-space Y-axis.
+   * Gets the position of the Frustum's bottom plane on the View-space Y-axis.
+   *
+   * Fires a {@link Frustum.bottom:emits} emits on change.
+   *
+   * @return {Number} Bottom frustum plane position.
+   */
+  get bottom(): number;
+
+  /**
+   * Sets the position of the Frustum's top plane on the View-space Y-axis.
    *
    * Fires a {@link Frustum.top:emits} emits on change.
+   *
+   * @param {Number} value New top frustum plane position.
    */
-  top: number;
+  set top(arg: number);
 
   /**
-   * The position of the Frustum's near plane on the positive View-space Z-axis.
+   * Gets the position of the Frustum's top plane on the View-space Y-axis.
+   *
+   * Fires a {@link Frustum.top:emits} emits on change.
+   *
+   * @return {Number} Top frustum plane position.
+   */
+  get top(): number;
+
+  /**
+   * Sets the position of the Frustum's near plane on the positive View-space Z-axis.
+   *
+   * Fires a {@link Frustum.near:emits} emits on change.
+   *
+   * Default value is ````0.1````.
+   *
+   * @param {Number} value New Frustum near plane position.
+   */
+  set near(arg: number);
+
+  /**
+   * Gets the position of the Frustum's near plane on the positive View-space Z-axis.
    *
    * Fires a {@link Frustum.near:emits} emits on change.
    *
    * Default value is ````0.1````.
+   *
+   * @return {Number} Near frustum plane position.
    */
-  near: number;
+  get near(): number;
 
   /**
-   * The position of the Frustum's far plane on the positive View-space Z-axis.
+   * Sets the position of the Frustum's far plane on the positive View-space Z-axis.
    *
    * Fires a {@link Frustum.far:emits} emits on change.
    *
    * Default value is ````10000.0````.
+   *
+   * @param {Number} value New far frustum plane position.
    */
-  far: number;
+  set far(arg: number);
 
   /**
-   * The Frustum's projection transform matrix.
+   * Gets the position of the Frustum's far plane on the positive View-space Z-axis.
+   *
+   * Default value is ````10000.0````.
+   *
+   * @return {Number} Far frustum plane position.
+   */
+  get far(): number;
+
+  /**
+   * Gets the Frustum's projection transform matrix.
    *
    * Fires a {@link Frustum.matrix:emits} emits on change.
    *
    * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+   *
+   * @returns {Number[]} The Frustum's projection matrix matrix.
    */
-  readonly matrix: number[];
+  get matrix(): number[];
 
   /**
-   * The inverse of {@link Frustum.matrix}.
+   * Gets the inverse of {@link Frustum.matrix}.
+   *
+   * @returns {Number[]} The inverse orthographic projection matrix.
    */
-  readonly inverseMatrix: number[];
+  get inverseMatrix(): number[];
 
   /**
-   * The transpose of {@link Frustum.matrix}.
+   * Gets the transpose of {@link Frustum.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Frustum.matrix}.
    */
-  readonly transposedMatrix: number[];
+  get transposedMatrix(): number[];
 
   /**
    * Un-projects the given Canvas-space coordinates, using this Frustum projection.

package/types/viewer/scene/camera/Ortho.d.ts

@@ -15,52 +15,92 @@ export declare class Ortho extends Component {
   camera: Camera;
 
   /**
-   * Scale factor for this Ortho's extents on X and Y axis.
+   * Sets scale factor for this Ortho's extents on X and Y axis.
    *
-   * Clamps to minimum value of ````0.01````.
+   * Clamps to minimum value of ````0.01```.
    *
    * Fires a "scale" event on change.
    *
    * Default value is ````1.0````
+   * @param {Number} value New scale value.
    */
-  scale: number;
+  set scale(arg: number);
 
   /**
-   * The position of the Ortho's near plane on the positive View-space Z-axis.
+   * Gets scale factor for this Ortho's extents on X and Y axis.
+   *
+   * Clamps to minimum value of ````0.01```.
+   *
+   * Default value is ````1.0````
+   *
+   * @returns {Number} New Ortho scale value.
+   */
+  get scale(): number;
+
+  /**
+   * Sets the position of the Ortho's near plane on the positive View-space Z-axis.
    *
    * Fires a "near" emits on change.
    *
    * Default value is ````0.1````.
+   *
+   * @param {Number} value New Ortho near plane position.
    */
-  near: number;
+  set near(arg: number);
 
   /**
-   * The position of the Ortho's far plane on the positive View-space Z-axis.
+   * Gets the position of the Ortho's near plane on the positive View-space Z-axis.
+   *
+   * Default value is ````0.1````.
+   *
+   * @returns {Number} New Ortho near plane position.
+   */
+  get near(): number;
+
+  /**
+   * Sets the position of the Ortho's far plane on the positive View-space Z-axis.
    *
    * Fires a "far" event on change.
    *
    * Default value is ````2000.0````.
+   *
+   * @param {Number} value New far ortho plane position.
    */
-  far: number;
+  set far(arg: number);
 
   /**
-   * The Ortho's projection transform matrix.
+   * Gets the position of the Ortho's far plane on the positive View-space Z-axis.
+   *
+   * Default value is ````10000.0````.
+   *
+   * @returns {Number} New far ortho plane position.
+   */
+  get far(): number;
+
+  /**
+   * Gets the Ortho's projection transform matrix.
    *
    * Fires a "matrix" event on change.
    *
    * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+   *
+   * @returns {Number[]} The Ortho's projection matrix.
    */
-  readonly matrix: number[];
+  get matrix(): number[];
 
   /**
-   * The inverse of {@link Ortho.matrix}.
+   * Gets the inverse of {@link Ortho.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link Ortho.matrix}.
    */
-  readonly inverseMatrix: number[];
+  get inverseMatrix(): number[];
 
   /**
-   * The transpose of {@link Ortho.matrix}.
+   * Gets the transpose of {@link Ortho.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Ortho.matrix}.
    */
-  readonly transposedMatrix: number[];
+  get transposedMatrix(): number[];
 
   /**
    * Un-projects the given Canvas-space coordinates, using this Ortho projection.
@@ -72,4 +112,4 @@ export declare class Ortho extends Component {
    * @param {Number[]} worldPos Outputs un-projected 3D World-space coordinates.
    */
   unproject(canvasPos: number[], screenZ: number, screenPos: number[], viewPos: number[], worldPos: number[]): number[];
-}
+}

package/types/viewer/scene/camera/Perspective.d.ts

@@ -15,59 +15,113 @@ export declare class Perspective extends Component {
   camera: Camera;
 
   /**
-   * The Perspective's field-of-view angle (FOV).
+   * Sets the Perspective's field-of-view angle (FOV).
    *
    * Fires an "fov" event on change.
+
+    * Default value is ````60.0````.
+    *
+    * @param {Number} value New field-of-view.
+    */
+  set fov(arg: number);
+
+  /**
+   * Gets the Perspective's field-of-view angle (FOV).
    *
    * Default value is ````60.0````.
+   *
+   * @returns {Number} Current field-of-view.
    */
-  fov: number;
+  get fov(): number;
 
   /**
-   * The Perspective's FOV axis.
+   * Sets the Perspective's FOV axis.
    *
    * Options are ````"x"````, ````"y"```` or ````"min"````, to use the minimum axis.
    *
    * Fires an "fovAxis" event on change.
+
+    * Default value ````"min"````.
+    *
+    * @param {String} value New FOV axis value.
+    */
+  set fovAxis(arg: string);
+
+  /**
+   * Gets the Perspective's FOV axis.
    *
-   * Default value is ````"min"````.
-   */
-  fovAxis: string;
+   * Options are ````"x"````, ````"y"```` or ````"min"````, to use the minimum axis.
+   *
+   * Fires an "fovAxis" event on change.
+
+    * Default value is ````"min"````.
+    *
+    * @returns {String} The current FOV axis value.
+    */
+  get fovAxis(): string;
 
   /**
-   * The position of the Perspective's near plane on the positive View-space Z-axis.
+   * Sets the position of the Perspective's near plane on the positive View-space Z-axis.
    *
    * Fires a "near" event on change.
    *
    * Default value is ````0.1````.
+   *
+   * @param {Number} value New Perspective near plane position.
+   */
+  set near(arg: number);
+
+  /**
+   * Gets the position of the Perspective's near plane on the positive View-space Z-axis.
+   *
+   * Fires an "emits" emits on change.
+   *
+   * Default value is ````0.1````.
+   *
+   * @returns The Perspective's near plane position.
    */
-  near: number;
+  get near(): number;
 
   /**
-   * The position of this Perspective's far plane on the positive View-space Z-axis.
+   * Sets the position of this Perspective's far plane on the positive View-space Z-axis.
    *
    * Fires a "far" event on change.
+   *
+   * @param {Number} value New Perspective far plane position.
    */
-  far: number;
+  set far(arg: number);
 
   /**
-   * The Perspective's projection transform matrix.
+   * Gets the position of this Perspective's far plane on the positive View-space Z-axis.
+   *
+   * @return {Number} The Perspective's far plane position.
+   */
+  get far(): number;
+
+  /**
+   * Gets the Perspective's projection transform matrix.
    *
    * Fires a "matrix" event on change.
    *
    * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+   *
+   * @returns {Number[]} The Perspective's projection matrix.
    */
-  readonly matrix: number[];
+  get matrix(): number[];
 
   /**
-   * The inverse of {@link Perspective.matrix}.
+   * Gets the inverse of {@link Perspective.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link Perspective.matrix}.
    */
-  readonly inverseMatrix: number[];
+  get inverseMatrix(): number[];
 
   /**
-   * The transpose of {@link Perspective.matrix}.
+   * Gets the transpose of {@link Perspective.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Perspective.matrix}.
    */
-  readonly transposedMatrix: number[];
+  get transposedMatrix(): number[];
 
   /**
    * Un-projects the given Canvas-space coordinates and Screen-space depth, using this Perspective projection.

package/types/viewer/scene/geometry/ReadableGeometry.d.ts

@@ -40,66 +40,70 @@ export declare class ReadableGeometry extends Geometry {
   constructor(owner: Component, cfg?: ReadableGeometryConfiguration);
 
   /**
-   * Geometry's primitive type.
+   * Gets the Geometry"s primitive type.
    */
-  readonly primitive: "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+  get primitive(): "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
 
   /**
-   * Whether this Geometry is quantized.
+   * Indicates if this Geometry is quantized.
    */
-  readonly compressGeometry: boolean;
+  get compressGeometry(): boolean;
 
   /**
-   * Geometry's vertex positions.
+   * The Geometry's vertex positions.
    */
-  positions: number[];
+  get positions(): number[];
+  set positions(arg: number[]);
 
   /**
-   * Geometry's vertex normals.
+   * The Geometry's vertex normals.
    */
-  normals: number[];
+  get normals(): number[];
+  set normals(arg: number[]);
 
   /**
-   * Geometry's UV coordinates.
+   The Geometry's UV coordinates.
    */
-  uv: number[];
+  get uv(): number[];
+  set uv(arg: number[]);
 
   /**
-   * Geometry's vertex colors.
+   * The Geometry's vertex colors.
    */
-  colors: number[];
+  get colors(): number[];
+  set colors(arg: number[]);
 
   /**
-   * Geometry's indices.
+   * The Geometry's indices.
    */
-  readonly indices: Uint16Array | Uint32Array;
+  get indices(): Uint16Array | Uint32Array;
 
   /**
    * Local-space axis-aligned 3D boundary (AABB) of this geometry.
    */
-  readonly aabb: number[];
+  get aabb(): number[];
 
   /**
    * Local-space oriented 3D boundary (OBB) of this geometry.
    */
-  readonly obb: number[];
+  get obb(): number[];
 
   /**
-   * Surface area of this Mesh.
+   * Returns the surface area of this Mesh.
    * @returns {number}
    */
-  readonly surfaceArea: number;
+  get surfaceArea(): number;
 
   /**
-   * Centroid of this Mesh.
+   * Returns the centroid of this Mesh.
    * @returns {number}
    */
-  readonly centroid: number;
+  get centroid(): number;
 
   /**
    * Approximate number of triangles in this ReadableGeometry.
    */
-  readonly numTriangles: number;
+  get numTriangles(): number;
 
   destroy(): void;
 }

package/types/viewer/scene/geometry/VBOGeometry.d.ts

@@ -36,30 +36,30 @@ export declare class VBOGeometry extends Geometry {
   constructor(owner: Component, cfg?: VBOGeometryConfiguration);
 
   /**
-   * Primitive type.
+   * Gets the primitive type.
    */
-  readonly primitive: "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+  get primitive(): "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
 
   /**
-   * Local-space axis-aligned 3D boundary (AABB).
+   * Gets the local-space axis-aligned 3D boundary (AABB).
    *
    * 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]````.
    */
-  readonly aabb: Number[];
+  get aabb(): Number[];
 
   /**
-   * Local-space oriented 3D boundary (OBB).
+   * Gets the local-space oriented 3D boundary (OBB).
    *
    * The OBB is represented by a 32-element Float64Array containing the eight vertices of the box, where each vertex is a homogeneous coordinate having [x,y,z,w] elements.
    */
-  readonly obb: Number[];
+  get obb(): Number[];
 
   /**
    * Approximate number of triangles in this VBOGeometry.
    *
    * Will be zero if {@link VBOGeometry#primitive} is not 'triangles', 'triangle-strip' or 'triangle-fan'.
    */
-  readonly numTriangles: Number;
+  get numTriangles(): Number;
 
   destroy(): void;
 }

package/types/viewer/scene/lights/AmbientLight.d.ts

@@ -18,18 +18,40 @@ export declare class AmbientLight extends Light {
   constructor(owner: Component, cfg: AmbientLightConfiguration);
 
   /**
-   * The RGB color of this AmbientLight.
+   * Sets the RGB color of this AmbientLight.
    *
    * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @param {Number[]} color The AmbientLight's RGB color.
+   */
+  set color(color: number[]);
+
+  /**
+   * Gets the RGB color of this AmbientLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @returns {Number[]} The AmbientLight's RGB color.
    */
-  color: number[];
+  get color(): number;
 
   /**
-   * The intensity of this AmbientLight.
+   * Sets the intensity of this AmbientLight.
    *
    * Default value is ````1.0```` for maximum intensity.
+   *
+   * @param {Number} intensity The AmbientLight's intensity.
+   */
+  set intensity(intensity: number);
+
+  /**
+   * Gets the intensity of this AmbientLight.
+   *
+   * Default value is ````1.0```` for maximum intensity.
+   *
+   * @returns {Number} The AmbientLight's intensity.
    */
-  intensity: number;
+  get intensity(): number;
 
   /**
    * Destroys this AmbientLight.

package/types/viewer/scene/lights/DirLight.d.ts

@@ -24,32 +24,76 @@ export declare class DirLight extends Light {
   constructor(owner: Component, cfg: DirLightConfiguration);
 
   /**
-   * The direction in which the DirLight is shining.
+   * Sets the direction in which the DirLight is shining.
    *
    * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @param {Number[]} value The direction vector.
+   */
+  set dir(value: number);
+
+  /**
+   * Gets the direction in which the DirLight is shining.
+   *
+   * Default value is ````[1.0, 1.0, 1.0]````.
+   *
+   * @returns {Number[]} The direction vector.
    */
-  dir: number[];
+  get dir(): number;
 
   /**
-   * The RGB color of this DirLight.
+   * Sets the RGB color of this DirLight.
    *
    * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @param {Number[]} color The DirLight's RGB color.
+   */
+  set color(color: number[]);
+
+  /**
+   * Gets the RGB color of this DirLight.
+   *
+   * Default value is ````[0.7, 0.7, 0.8]````.
+   *
+   * @returns {Number[]} The DirLight's RGB color.
    */
-  color: number[];
+  get color(): number[];
 
   /**
-   * The intensity of this DirLight.
+   * Sets the intensity of this DirLight.
+   *
+   * Default intensity is ````1.0```` for maximum intensity.
+   *
+   * @param {Number} intensity The DirLight's intensity
+   */
+  set intensity(intensity: number);
+
+  /**
+   * Gets the intensity of this DirLight.
    *
    * Default value is ````1.0```` for maximum intensity.
+   *
+   * @returns {Number} The DirLight's intensity.
    */
-  intensity: number;
+  get intensity(): number;
 
   /**
-   * Whether this DirLight casts a shadow.
+   * Sets if this DirLight casts a shadow.
    *
    * Default value is ````false````.
+   *
+   * @param {Boolean} castsShadow Set ````true```` to cast shadows.
+   */
+  set castsShadow(castsShadow: boolean);
+
+  /**
+   * Gets if this DirLight casts a shadow.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} ````true```` if this DirLight casts shadows.
    */
-  castsShadow: boolean;
+  get castsShadow(): boolean;
   
   /**
    * Destroys this DirLight.