@xeokit/xeokit-sdk 2.2.4 → 2.2.5-beta-2

package/types/viewer/scene/PerformanceModel/PerformanceNode.d.ts

@@ -0,0 +1,302 @@
+export declare class PerformanceNode {
+/**
+     * Returns true to indicate that PerformanceNode is an {@link Entity}.
+     * @type {Boolean}
+     */
+  get isEntity(): boolean;
+
+  /**
+   * Always returns ````false```` because a PerformanceNode can never represent a model.
+   *
+   * @type {Boolean}
+   */
+  get isModel(): boolean;
+
+  /**
+   * Returns ````true```` if this PerformanceNode represents an object.
+   *
+   * When ````true```` the PerformanceNode will be registered by {@link PerformanceNode#id} in
+   * {@link Scene#objects} and may also have a {@link MetaObject} with matching {@link MetaObject#id}.
+   *
+   * @type {Boolean}
+   */
+  get isObject(): boolean;
+
+  /**
+   * World-space 3D axis-aligned bounding box (AABB) of this PerformanceNode.
+   *
+   * Represented by a six-element Float64Array containing the min/max extents of the
+   * axis-aligned volume, ie. ````[xmin, ymin,zmin,xmax,ymax, zmax]````.
+   *
+   * @type {Float64Array}
+   */
+  get aabb(): number[];
+
+  /**
+   * The approximate number of triangles in this PerformanceNode.
+   *
+   * @type {Number}
+   */
+  get numTriangles(): number;
+
+  /**
+   * Gets if this PerformanceNode is visible.
+   *
+   * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#visible} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#visibleObjects}.
+   *
+   * @type {Boolean}
+   */
+  get visible(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is visible.
+   *
+   * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#visible} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#visibleObjects}.
+   *
+   * @type {Boolean}
+   */
+  set visible(visible: boolean);
+
+  /**
+   * Gets if this PerformanceNode is highlighted.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#highlighted} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#highlightedObjects}.
+   *
+   * @type {Boolean}
+   */
+  get highlighted(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is highlighted.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#highlighted} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#highlightedObjects}.
+   *
+   * @type {Boolean}
+   */
+  set highlighted(highlighted: boolean);
+
+  /**
+   * Gets if this PerformanceNode is xrayed.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#xrayed} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#xrayedObjects}.
+   *
+   * @type {Boolean}
+   */
+  get xrayed(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is xrayed.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#xrayed} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#xrayedObjects}.
+   *
+   * @type {Boolean}
+   */
+  set xrayed(xrayed: boolean);
+
+  /**
+   * Sets if this PerformanceNode is selected.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#selected} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#selectedObjects}.
+   *
+   * @type {Boolean}
+   */
+  get selected(): boolean;
+
+  /**
+   * Gets if this PerformanceNode is selected.
+   *
+   * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#selected} are ````true```` the PerformanceNode will be
+   * registered by {@link PerformanceNode#id} in {@link Scene#selectedObjects}.
+   *
+   * @type {Boolean}
+   */
+  set selected(selected: boolean);
+
+  /**
+   * Gets if this PerformanceNode's edges are enhanced.
+   *
+   * @type {Boolean}
+   */
+  get edges(): boolean;
+
+  /**
+   * Sets if this PerformanceNode's edges are enhanced.
+   *
+   * @type {Boolean}
+   */
+  set edges(edges: boolean);
+
+  /**
+   * Gets if this PerformanceNode is culled.
+   *
+   * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get culled(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is culled.
+   *
+   * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
+   *
+   * @type {Boolean}
+   */
+  set culled(culled: boolean);
+
+  /**
+   * Gets if this PerformanceNode is clippable.
+   *
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   *
+   * @type {Boolean}
+   */
+  get clippable(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is clippable.
+   *
+   * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
+   *
+   * @type {Boolean}
+   */
+  set clippable(clippable: boolean);
+
+  /**
+   * Gets if this PerformanceNode is included in boundary calculations.
+   *
+   * @type {Boolean}
+   */
+  get collidable(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is included in boundary calculations.
+   *
+   * @type {Boolean}
+   */
+  set collidable(collidable: boolean);
+
+  /**
+   * Gets if this PerformanceNode is pickable.
+   *
+   * Picking is done via calls to {@link Scene#pick}.
+   *
+   * @type {Boolean}
+   */
+  get pickable(): boolean;
+
+  /**
+   * Sets if this PerformanceNode is pickable.
+   *
+   * Picking is done via calls to {@link Scene#pick}.
+   *
+   * @type {Boolean}
+   */
+  set pickable(pickable: boolean);
+
+  /**
+   * Gets the PerformanceNode's RGB colorize color.
+   *
+   * Each element of the color is in range ````[0..1]````.
+   *
+   * @type {Number[]}
+   */
+  get colorize(): number[];
+
+  /**
+   * Sets the PerformanceNode's RGB colorize color.
+   *
+   * Each element of the color is in range ````[0..1]````.
+   *
+   * @type {Number[]}
+   */
+  set colorize(color: number[]);
+
+  /**
+   * Gets the PerformanceNode's opacity factor.
+   *
+   * This is a factor in range ````[0..1]```` which multiplies by the rendered fragment alphas.
+   *
+   * @type {Number}
+   */
+  get opacity(): number;
+
+  /**
+   * Sets the PerformanceNode's opacity factor, multiplies by the PerformanceNode's rendered fragment alphas.
+   *
+   * This is a factor in range ````[0..1]````.
+   *
+   * @type {Number}
+   */
+  set opacity(opacity: number);
+
+  /**
+   * Gets the PerformanceNode's 3D World-space offset.
+   *
+   * Default value is ````[0,0,0]````.
+   *
+   * @type {Number[]}
+   */
+  get offset(): number;
+
+  /**
+   * Sets the PerformanceNode's 3D World-space offset.
+   *
+   * The offset dynamically translates the PerformanceNode in World-space.
+   *
+   * Default value is ````[0, 0, 0]````.
+   *
+   * Provide a null or undefined value to reset to the default value.
+   *
+   * @type {Number[]}
+   */
+  set offset(offset: number);
+
+  /**
+   * Gets if this PerformanceNode casts shadows.
+   *
+   * @type {Boolean}
+   */
+  get castsShadow(): boolean;
+
+  /**
+   * Sets if to this PerformanceNode casts shadows.
+   *
+   * @type {Boolean}
+   */
+  set castsShadow(pickable: boolean);
+
+  /**
+   * Whether or not this PerformanceNode can have shadows cast upon it
+   *
+   * @type {Boolean}
+   */
+  get receivesShadow(): boolean;
+
+  /**
+   * Whether or not this PerformanceNode can have shadows cast upon it
+   *
+   * @type {Boolean}
+   */
+  set receivesShadow(pickable: boolean);
+
+  /**
+   * Gets if Scalable Ambient Obscurance (SAO) will apply to this PerformanceNode.
+   *
+   * SAO is configured by the Scene's {@link SAO} component.
+   *
+   * @type {Boolean}
+   */
+  get saoEnabled(): boolean;
+}

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

@@ -0,0 +1,364 @@
+import { Component } from "../Component";
+import { Perspective } from "./Perspective";
+import { Ortho } from "./Ortho";
+import { Frustum } from "./Frustum";
+import { CustomProjection } from "./CustomProjection";
+
+/**
+ * Manages viewing and projection transforms for its {@link Scene}.
+ */
+export declare class Camera extends Component {
+  /**
+   * 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.
+   */
+  get deviceMatrix(): number[];
+
+  /**
+   * 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.
+   */
+  set eye(arg: number[]);
+
+  /**
+   * 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.
+   */
+  get look(): number[];
+
+  /**
+   * 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".
+   */
+  get up(): number[];
+
+  /**
+   * 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.
+   */
+  set worldAxis(arg: number[]);
+
+  /**
+   * 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.
+   */
+  get gimbalLock(): boolean;
+
+  /**
+   * 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.
+   */
+  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
+   *
+   * @param {Number} angleInc Angle of rotation in degrees
+   */
+  orbitYaw(angleInc: number): void;
+
+  /**
+   * Rotates {@link Camera#eye} about {@link Camera#look} around the right axis (orthogonal to {@link Camera#up} and "look").
+   *
+   * @param {Number} angleInc Angle of rotation in degrees
+   */
+  orbitPitch(angleInc: number): void;
+
+  /**
+   * Rotates {@link Camera#look} about {@link Camera#eye}, around the {@link Camera#up} vector.
+   *
+   * @param {Number} angleInc Angle of rotation in degrees
+   */
+  yaw(angleInc: number): void;
+
+  /**
+   * Rotates {@link Camera#look} about {@link Camera#eye}, around the right axis (orthogonal to {@link Camera#up} and "look").
+   *
+   * @param {Number} angleInc Angle of rotation in degrees
+   */
+  pitch(angleInc: number): void;
+
+  /**
+     * Pans the Camera along its local X, Y and Z axis.
+     *
+     * @param {Number[]}pan The pan vector
+     */
+  pan(pan: number[]): void;
+
+  /**
+   * Increments/decrements the Camera's zoom factor, which is the distance between {@link Camera#eye} and {@link Camera#look}.
+   *
+   * @param {Number} delta Zoom factor increment.
+   */
+  zoom(delta: number): void;
+
+  /**
+   * 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.
+   */
+  get worldUp(): number[];
+
+  /**
+   * Gets if the World-space X-axis is "up".
+   * @returns {boolean}
+   */
+  get xUp(): boolean;
+
+  /**
+   * Gets if the World-space Y-axis is "up".
+   * @returns {boolean}
+   */
+  get yUp(): boolean;
+
+  /**
+   * Gets if the World-space Z-axis is "up".
+   * @returns {boolean}
+   */
+  get zUp(): boolean;
+
+  /**
+   * 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.
+   */
+  get worldRight(): number[];
+
+  /**
+   * 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.
+   */
+  get constrainPitch(): boolean;
+
+  /**
+   * 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.
+   */
+  set constrainPitch(arg: boolean);
+
+  /**
+   * Gets distance from {@link Camera#look} to {@link Camera#eye}.
+   *
+   * @returns {Number} The distance.
+   */
+  get eyeLookDist(): boolean;
+
+  /**
+   * Gets the Camera's viewing transformation matrix.
+   *
+   * Fires a {@link Camera#matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing transform matrix.
+   */
+  get matrix(): number[];
+
+  /**
+   * Gets the Camera's viewing transformation matrix.
+   *
+   * Fires a {@link Camera#matrix:event} event on change.
+   *
+   * @returns {Number[]} The viewing transform matrix.
+   */
+  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.
+   */
+  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.
+   */
+  get viewNormalMatrix(): number[];
+
+  /**
+   * 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.
+   */
+  get inverseViewMatrix(): number[];
+
+  /**
+   * Gets the Camera's projection transformation projMatrix.
+   *
+   * Fires a {@link Camera#projMatrix:event} event on change.
+   *
+   * @returns {Number[]} The projection matrix.
+   */
+  get projMatrix(): number[];
+
+  /**
+   * Gets the Camera's perspective projection.
+   *
+   * The Camera uses this while {@link Camera#projection} equals ````perspective````.
+   *
+   * @returns {Perspective} The Perspective component.
+   */
+  get perspective(): Perspective;
+
+  /**
+   * Gets the Camera's orthographic projection.
+   *
+   * The Camera uses this while {@link Camera#projection} equals ````ortho````.
+   *
+   * @returns {Ortho} The Ortho component.
+   */
+  get ortho(): Ortho;
+
+  /**
+   * Gets the Camera's frustum projection.
+   *
+   * The Camera uses this while {@link Camera#projection} equals ````frustum````.
+   *
+   * @returns {Frustum} The Ortho component.
+   */
+  get frustum(): Frustum;
+
+  /**
+   * Gets the Camera's custom projection.
+   *
+   * This is used while {@link Camera#projection} equals "customProjection".
+   *
+   * @returns {CustomProjection} The custom projection.
+   */
+  get customProjection(): CustomProjection;
+
+  /**
+   * 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.
+   */
+  get project(): Perspective | Ortho | Frustum | CustomProjection;
+}