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

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

@@ -9,61 +9,135 @@ import { CustomProjection } from "./CustomProjection";
  */
 export declare class Camera extends Component {
   /**
-   * An optional matrix to premultiply into {@link Camera.matrix} matrix.
+   * Sets an optional matrix to premultiply into {@link Camera.matrix} matrix.
    *
    * This is intended to be used for stereo rendering with WebVR etc.
+   *
+   * @param {Number[]} matrix The matrix.
+   */
+  set deviceMatrix(arg: number[]);
+
+  /**
+   * Gets an optional matrix to premultiply into {@link Camera.matrix} matrix.
+   *
+   * @returns {Number[]} The matrix.
    */
-  deviceMatrix: number[];
+  get deviceMatrix(): number[];
 
   /**
-   * The position of the Camera's eye.
+   * Sets the position of the Camera's eye.
    *
    * Default value is ````[0,0,10]````.
    *
    * @emits "eye" event on change, with the value of this property.
+   * @type {Number[]} New eye position.
    */
-  eye: number[];
+  set eye(arg: number[]);
 
   /**
-   * The position of this Camera's point-of-interest.
+   * Gets the position of the Camera's eye.
+   *
+   * Default vale is ````[0,0,10]````.
+   *
+   * @type {Number[]} New eye position.
+   */
+  get eye(): number[];
+
+  /**
+   * Sets the position of this Camera's point-of-interest.
    *
    * Default value is ````[0,0,0]````.
    *
    * @emits "look" event on change, with the value of this property.
+   *
+   * @param {Number[]} look Camera look position.
+   */
+  set look(arg: number[]);
+
+  /**
+   * Gets the position of this Camera's point-of-interest.
+   *
+   * Default value is ````[0,0,0]````.
+   *
+   * @returns {Number[]} Camera look position.
    */
-  look: number[];
+  get look(): number[];
 
   /**
-   * The direction of this Camera's {@link Camera.up} vector.
+   * Sets the direction of this Camera's {@link Camera.up} vector.
    *
    * @emits "up" event on change, with the value of this property.
+   *
+   * @param {Number[]} up Direction of "up".
+   */
+  set up(arg: number[]);
+
+  /**
+   * Gets the direction of this Camera's {@link Camera.up} vector.
+   *
+   * @returns {Number[]} Direction of "up".
    */
-  up: number[];
+  get up(): number[];
 
   /**
-   * The up, right and forward axis of the World coordinate system.
+   * Sets the up, right and forward axis of the World coordinate system.
    *
    * Has format: ````[rightX, rightY, rightZ, upX, upY, upZ, forwardX, forwardY, forwardZ]````
    *
    * Default axis is ````[1, 0, 0, 0, 1, 0, 0, 0, 1]````
+   *
+   * @param {Number[]} axis The new Wworld coordinate axis.
    */
-  worldAxis: number[];
+  set worldAxis(arg: number[]);
 
   /**
-   * Whether to lock yaw rotation to pivot about the World-space "up" axis.
+   * Gets the up, right and forward axis of the World coordinate system.
+   *
+   * Has format: ````[rightX, rightY, rightZ, upX, upY, upZ, forwardX, forwardY, forwardZ]````
+   *
+   * Default axis is ````[1, 0, 0, 0, 1, 0, 0, 0, 1]````
+   *
+   * @returns {Number[]} The current World coordinate axis.
+   */
+  get worldAxis(): number[];
+
+  /**
+   * Sets whether to lock yaw rotation to pivot about the World-space "up" axis.
    *
    * Fires a {@link Camera.gimbalLock:event} event on change.
+   *
+   * @params {Boolean} gimbalLock Set true to lock gimbal.
+   */
+  set gimbalLock(arg: boolean);
+
+  /**
+   * Gets whether to lock yaw rotation to pivot about the World-space "up" axis.
+   *
+   * @returns {Boolean} Returns ````true```` if gimbal is locked.
    */
-  gimbalLock: boolean;
+  get gimbalLock(): boolean;
 
   /**
-   * The active projection type.
+   * Sets the active projection type.
    *
    * Accepted values are ````"perspective"````, ````"ortho"````, ````"frustum"```` and ````"customProjection"````.
    *
    * Default value is ````"perspective"````.
+   *
+   * @param {String} value Identifies the active projection type.
    */
-  projection: "perspective" | "ortho" | "frustum" | "customProjection";
+  set projection(arg: "perspective" | "ortho" | "frustum" | "customProjection");
+
+  /**
+   * Gets the active projection type.
+   *
+   * Possible values are ````"perspective"````, ````"ortho"````, ````"frustum"```` and ````"customProjection"````.
+   *
+   * Default value is ````"perspective"````.
+   *
+   * @returns {String} Identifies the active projection type.
+   */
+  get projection(): "perspective" | "ortho" | "frustum" | "customProjection";
 
   /**
    * Rotates {@link Camera.eye} about {@link Camera.look}, around the {@link Camera.up} vector
@@ -108,137 +182,183 @@ export declare class Camera extends Component {
   zoom(delta: number): void;
 
   /**
-   * The direction of World-space "up".
+   * Gets the direction of World-space "up".
    *
    * This is set by {@link Camera.worldAxis}.
    *
    * Default value is ````[0,1,0]````.
+   *
+   * @returns {Number[]} The "up" vector.
    */
-  readonly worldUp: number[];
+  get worldUp(): number[];
 
   /**
-   * Whether the World-space X-axis is "up".
+   * Gets if the World-space X-axis is "up".
+   * @returns {Boolean}
    */
-  readonly xUp: boolean;
+  get xUp(): boolean;
 
   /**
-   * Whether the World-space Y-axis is "up".
+   * Gets if the World-space Y-axis is "up".
+   * @returns {Boolean}
    */
-  readonly yUp: boolean;
+  get yUp(): boolean;
 
   /**
-   * Whether the World-space Z-axis is "up".
+   * Gets if the World-space Z-axis is "up".
+   * @returns {Boolean}
    */
-  readonly zUp: boolean;
+  get zUp(): boolean;
 
   /**
-   * The direction of World-space "right".
+   * Gets the direction of World-space "right".
    *
    * This is set by {@link Camera.worldAxis}.
    *
    * Default value is ````[1,0,0]````.
+   *
+   * @returns {Number[]} The "up" vector.
    */
-  readonly worldRight: number[];
+  get worldRight(): number[];
 
   /**
-   * The direction of World-space "forwards".
+   * Gets the direction of World-space "forwards".
    *
    * This is set by {@link Camera.worldAxis}.
    *
    * Default value is ````[0,0,1]````.
+   *
+   * @returns {Number[]} The "up" vector.
+   */
+  get worldForward(): number[];
+
+  /**
+   * Gets whether to prevent camera from being pitched upside down.
+   *
+   * The camera is upside down when the angle between {@link Camera.up} and {@link Camera.worldUp} is less than one degree.
+   *
+   * Default value is ````false````.
+   *
+   * @returns {Boolean} ````true```` if pitch rotation is currently constrained.
    */
-  readonly worldForward: number[];
+  get constrainPitch(): boolean;
 
   /**
-   * Whether to prevent camera from being pitched upside down.
+   * Sets whether to prevent camera from being pitched upside down.
    *
    * The camera is upside down when the angle between {@link Camera.up} and {@link Camera.worldUp} is less than one degree.
    *
    * Fires a {@link Camera.constrainPitch:event} event on change.
    *
    * Default value is ````false````.
+   *
+   * @param {Boolean} value Set ````true```` to contrain pitch rotation.
    */
-  constrainPitch: boolean;
+  set constrainPitch(arg: boolean);
 
   /**
-   * Distance from {@link Camera.look} to {@link Camera.eye}.
+   * Gets distance from {@link Camera.look} to {@link Camera.eye}.
+   *
+   * @returns {Number} The distance.
    */
-  readonly eyeLookDist: number;
+  get eyeLookDist(): boolean;
 
   /**
-   * The Camera's viewing transformation matrix.
+   * Gets the Camera's viewing transformation matrix.
    *
    * Fires a {@link Camera.matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing transform matrix.
    */
-  readonly matrix: number[];
+  get matrix(): number[];
 
   /**
-   * The Camera's viewing transformation matrix.
+   * Gets the Camera's viewing transformation matrix.
    *
    * Fires a {@link Camera.matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing transform matrix.
    */
-  readonly viewMatrix: number[];
+  get viewMatrix(): number[];
 
   /**
    * The Camera's viewing normal transformation matrix.
    *
    * Fires a {@link Camera.matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing normal transform matrix.
    */
-  readonly normalMatrix: number[];
+  get normalMatrix(): number[];
 
   /**
    * The Camera's viewing normal transformation matrix.
    *
    * Fires a {@link Camera.matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing normal transform matrix.
    */
-  readonly viewNormalMatrix: number[];
+  get viewNormalMatrix(): number[];
 
   /**
-   * The inverse of the Camera's viewing transform matrix.
+   * Gets the inverse of the Camera's viewing transform matrix.
    *
    * This has the same value as {@link Camera.normalMatrix}.
+   *
+   * @returns {Number[]} The inverse viewing transform matrix.
    */
-  readonly inverseViewMatrix: number[];
+  get inverseViewMatrix(): number[];
 
   /**
-   * The Camera's projection transformation projMatrix.
+   * Gets the Camera's projection transformation projMatrix.
    *
    * Fires a {@link Camera.projMatrix:event} event on change.
+   *
+   * @returns {Number[]} The projection matrix.
    */
-  readonly projMatrix: number[];
+  get projMatrix(): number[];
 
   /**
-   * The Camera's perspective projection.
+   * Gets the Camera's perspective projection.
    *
    * The Camera uses this while {@link Camera.projection} equals ````perspective````.
+   *
+   * @returns {Perspective} The Perspective component.
    */
-  readonly perspective: Perspective;
+  get perspective(): Perspective;
 
   /**
-   * The Camera's orthographic projection.
+   * Gets the Camera's orthographic projection.
    *
    * The Camera uses this while {@link Camera.projection} equals ````ortho````.
+   *
+   * @returns {Ortho} The Ortho component.
    */
-  readonly ortho: Ortho;
+  get ortho(): Ortho;
 
   /**
-   * The Camera's frustum projection.
+   * Gets the Camera's frustum projection.
    *
    * The Camera uses this while {@link Camera.projection} equals ````frustum````.
+   *
+   * @returns {Frustum} The Ortho component.
    */
-  readonly frustum: Frustum;
+  get frustum(): Frustum;
 
   /**
-   * The Camera's custom projection.
+   * Gets the Camera's custom projection.
    *
    * This is used while {@link Camera.projection} equals "customProjection".
+   *
+   * @returns {CustomProjection} The custom projection.
    */
-  readonly customProjection: CustomProjection;
+  get customProjection(): CustomProjection;
 
   /**
-   * The currently active projection for this Camera.
+   * Gets the currently active projection for this Camera.
    *
    * The currently active project is selected with {@link Camera.projection}.
+   *
+   * @returns {Perspective|Ortho|Frustum|CustomProjection} The currently active projection is active.
    */
-  readonly project: Perspective | Ortho | Frustum | CustomProjection;
+  get project(): Perspective | Ortho | Frustum | CustomProjection;
 }

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

@@ -5,39 +5,88 @@ import { Component } from "../Component";
  */
 export declare class CameraFlightAnimation extends Component {
   /**
-   * The flight duration, in seconds, when calling {@link CameraFlightAnimation.flyTo}.
+   * Sets the flight duration, in seconds, when calling {@link CameraFlightAnimation.flyTo}.
    *
    * Stops any flight currently in progress.
    *
    * default value is ````0.5````.
+   *
+   * @param {Number} value New duration value.
    */
-  duration: number;
+  set duration(arg: number);
 
   /**
-   * Whether, when CameraFlightAnimation is flying to a boundary, it will always adjust the distance between the
+   * Gets the flight duration, in seconds, when calling {@link CameraFlightAnimation.flyTo}.
+   *
+   * default value is ````0.5````.
+   *
+   * @returns {Number} New duration value.
+   */
+  get duration(): number;
+
+  /**
+   * Sets if, when CameraFlightAnimation is flying to a boundary, it will always adjust the distance between the
    * {@link Camera.eye} and {@link Camera.look} so as to ensure that the target boundary is always filling the view volume.
    *
    * When false, the eye will remain at its current distance from the look position.
    *
    * Default value is ````true````.
+   *
+   * @param {Boolean} value Set ````true```` to activate this behaviour.
+   */
+  set fit(arg: boolean);
+
+  /**
+   * Gets if, when CameraFlightAnimation is flying to a boundary, it will always adjust the distance between the
+   * {@link Camera.eye} and {@link Camera.look} so as to ensure that the target boundary is always filling the view volume.
+   *
+   * When false, the eye will remain at its current distance from the look position.
+   *
+   * Default value is ````true````.
+   *
+   * @returns {Boolean} value Set ````true```` to activate this behaviour.
    */
-  fit: boolean;
+  get fit(): boolean;
 
   /**
-   * How much of the perspective field-of-view, in degrees, that a target {@link Entity.aabb} should
+   * Sets how much of the perspective field-of-view, in degrees, that a target {@link Entity.aabb} should
    * fill the canvas when calling {@link CameraFlightAnimation.flyTo} or {@link CameraFlightAnimation.jumpTo}.
    *
    * Default value is ````45````.
+   *
+   * @param {Number} value New FOV value.
+   */
+  set fitFOV(arg: number);
+
+  /**
+   * Gets how much of the perspective field-of-view, in degrees, that a target {@link Entity.aabb} should
+   * fill the canvas when calling {@link CameraFlightAnimation.flyTo} or {@link CameraFlightAnimation.jumpTo}.
+   *
+   * Default value is ````45````.
+   *
+   * @returns {Number} Current FOV value.
    */
-  fitFOV: number;
+  get fitFOV(): number;
 
   /**
-   * Whether this CameraFlightAnimation points the {@link Camera}
+   * Sets if this CameraFlightAnimation to point the {@link Camera}
    * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation.flyTo}.
    *
    * Default value is ````true````.
+   *
+   * @param {Boolean} value Set ````true```` to activate trailing behaviour.
+   */
+  set trail(arg: boolean);
+
+  /**
+   * Gets if this CameraFlightAnimation points the {@link Camera}
+   * in the direction that it is travelling when flying to a target after calling {@link CameraFlightAnimation.flyTo}.
+   *
+   * Default value is ````true````.
+   *
+   * @returns {Boolean} True if trailing behaviour is active.
    */
-  trail: boolean;
+  get trail(): boolean;
 
   /**
    * Flies the {@link Camera} to a target.

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

@@ -28,24 +28,29 @@ export declare class CameraPath extends Component {
   constructor(owner?: Component, cfg?: CameraPathConfiguration);
 
   /**
-   * The camera frames in this CameraPath.
+   * Gets the camera frames in this CameraPath.
+   *
+   * @returns {{t:Number, eye:Object, look:Object, up: Object}[]} The frames on this CameraPath.
    */
-  readonly frames: Frame[];
+  get frames(): Frame[];
 
   /**
-   * The {@link SplineCurve} along which {@link Camera#eye} travels.
+   * Gets the {@link SplineCurve} along which {@link Camera#eye} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#eye}.
    */
-  readonly eyeCurve: SplineCurve;
+  get eyeCurve(): SplineCurve;
 
   /**
-   * The {@link SplineCurve} along which {@link Camera#look} travels.
+   * Gets the {@link SplineCurve} along which {@link Camera#look} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#look}.
    */
-  readonly lookCurve: SplineCurve;
+  get lookCurve(): SplineCurve;
 
   /**
-   * The {@link SplineCurve} along which {@link Camera#up} travels.
+   * Gets the {@link SplineCurve} along which {@link Camera#up} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#up}.
    */
-  readonly upCurve: SplineCurve;
+  get upCurve(): SplineCurve;
 
   /**
    * Adds a frame to this CameraPath, given as the current position of the {@link Camera}.

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

@@ -19,14 +19,32 @@ export declare class CameraPathAnimation extends Component {
     constructor(owner?: Component, cfg?: CameraPathAnimationConfiguration);
 
     /**
-     * The {@link CameraPath} animated by this CameraPathAnimation.
+     * Sets the {@link CameraPath} animated by this CameraPathAnimation.
+     *
+     @param {CameraPath} value The new CameraPath.
+     */
+    set cameraPath(arg: CameraPath);
+
+    /**
+     * Gets the {@link CameraPath} animated by this CameraPathAnimation.
+     *
+     @returns {CameraPath} The CameraPath.
      */
-    cameraPath: CameraPath;
+    get cameraPath(): CameraPath;
 
     /**
-     * The rate at which the CameraPathAnimation animates the {@link Camera} along the {@link CameraPath}.
+     * Sets the rate at which the CameraPathAnimation animates the {@link Camera} along the {@link CameraPath}.
+     *
+     *  @param {Number} value The amount of progress per second.
+     */
+    set rate(arg: number);
+
+    /**
+     * Gets the rate at which the CameraPathAnimation animates the {@link Camera} along the {@link CameraPath}.
+     *
+     * @returns {*|number} The current playing rate.
      */
-    rate: number;
+    get rate(): number;
 
     /**
      * Begins animating the {@link Camera} along CameraPathAnimation's {@link CameraPath} from the beginning.

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

@@ -11,23 +11,38 @@ export declare class CustomProjection extends Component {
   camera: Camera;
 
   /**
-   * The CustomProjection's projection transform matrix.
+   * Sets the CustomProjection'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]````.
+    *
+    * @param {Number[]} matrix New value for the CustomProjection's matrix.
+    */
+  set matrix(arg: number[]);
+
+  /**
+   * Gets the CustomProjection's projection transform matrix.
    *
    * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+   *
+   * @return {Number[]} New value for the CustomProjection's matrix.
    */
-  matrix: number[];
+  get matrix(): number[];
 
   /**
-   * The inverse of {@link CustomProjection.matrix}.
+   * Gets the inverse of {@link CustomProjection.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link CustomProjection.matrix}.
    */
-  readonly inverseMatrix: number[];
+  get inverseMatrix(): number[];
 
   /**
-   * The transpose of {@link CustomProjection.matrix}.
+   * Gets the transpose of {@link CustomProjection.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link CustomProjection.matrix}.
    */
-  readonly transposedMatrix: number[];
+  get transposedMatrix(): number[];
 
   /**
    * Un-projects the given Canvas-space coordinates, using this CustomProjection.