@xeokit/xeokit-sdk 2.2.5 → 2.3.0-beta-4

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

@@ -0,0 +1,57 @@
+import { Component } from "../Component";
+import { Camera } from "./Camera";
+
+/**
+ * Defines a custom projection for a {@link Camera} as a custom 4x4 matrix..
+ */
+export declare class CustomProjection extends Component {
+  /**
+   * The Camera this CustomProjection belongs to.
+   */
+  camera: Camera;
+
+  /**
+   * 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.
+   */
+  get matrix(): number[];
+
+  /**
+   * Gets the inverse of {@link CustomProjection.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link CustomProjection.matrix}.
+   */
+  get inverseMatrix(): number[];
+
+  /**
+   * Gets the transpose of {@link CustomProjection.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link CustomProjection.matrix}.
+   */
+  get transposedMatrix(): number[];
+
+  /**
+   * Un-projects the given Canvas-space coordinates, using this CustomProjection.
+   *
+   * @param {Number[]} canvasPos Inputs 2D Canvas-space coordinates.
+   * @param {Number} screenZ Inputs Screen-space Z coordinate.
+   * @param {Number[]} screenPos Outputs 3D Screen/Clip-space coordinates.
+   * @param {Number[]} viewPos Outputs un-projected 3D View-space coordinates.
+   * @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/Frustum.d.ts

@@ -0,0 +1,166 @@
+import { Component } from "../Component";
+import { Camera } from "./Camera";
+
+/**
+ * Defines its {@link Camera}'s perspective projection as a frustum-shaped view volume.
+ */
+export declare class Frustum extends Component {
+  /**
+   * The Camera this Frustum belongs to.
+   *
+   * @property camera
+   * @type {Camera}
+   * @final
+   */
+  camera: Camera;
+
+  /**
+   * 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.
+   */
+  set right(arg: number);
+
+  /**
+   * 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.
+   */
+  get right(): number;
+
+  /**
+   * 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.
+   */
+  set bottom(arg: number);
+
+  /**
+   * 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.
+   */
+  set top(arg: number);
+
+  /**
+   * 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.
+   */
+  get near(): number;
+
+  /**
+   * 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.
+   */
+  set far(arg: number);
+
+  /**
+   * 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.
+   */
+  get matrix(): number[];
+
+  /**
+   * Gets the inverse of {@link Frustum.matrix}.
+   *
+   * @returns {Number[]} The inverse orthographic projection matrix.
+   */
+  get inverseMatrix(): number[];
+
+  /**
+   * Gets the transpose of {@link Frustum.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Frustum.matrix}.
+   */
+  get transposedMatrix(): number[];
+
+  /**
+   * Un-projects the given Canvas-space coordinates, using this Frustum projection.
+   *
+   * @param {Number[]} canvasPos Inputs 2D Canvas-space coordinates.
+   * @param {Number} screenZ Inputs Screen-space Z coordinate.
+   * @param {Number[]} screenPos Outputs 3D Screen/Clip-space coordinates.
+   * @param {Number[]} viewPos Outputs un-projected 3D View-space coordinates.
+   * @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/Ortho.d.ts

@@ -0,0 +1,115 @@
+import { Component } from "../Component";
+import { Camera } from "./Camera";
+
+/**
+ * Defines its {@link Camera}'s orthographic projection as a box-shaped view volume.
+ */
+export declare class Ortho extends Component {
+  /**
+   * The Camera this Ortho belongs to.
+   *
+   * @property camera
+   * @type {Camera}
+   * @final
+   */
+  camera: Camera;
+
+  /**
+   * Sets scale factor for this Ortho's extents on X and Y axis.
+   *
+   * Clamps to minimum value of ````0.01```.
+   *
+   * Fires a "scale" event on change.
+   *
+   * Default value is ````1.0````
+   * @param {Number} value New scale value.
+   */
+  set scale(arg: number);
+
+  /**
+   * 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.
+   */
+  set near(arg: number);
+
+  /**
+   * 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.
+   */
+  set far(arg: number);
+
+  /**
+   * 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.
+   */
+  get matrix(): number[];
+
+  /**
+   * Gets the inverse of {@link Ortho.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link Ortho.matrix}.
+   */
+  get inverseMatrix(): number[];
+
+  /**
+   * Gets the transpose of {@link Ortho.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Ortho.matrix}.
+   */
+  get transposedMatrix(): number[];
+
+  /**
+   * Un-projects the given Canvas-space coordinates, using this Ortho projection.
+   *
+   * @param {Number[]} canvasPos Inputs 2D Canvas-space coordinates.
+   * @param {Number} screenZ Inputs Screen-space Z coordinate.
+   * @param {Number[]} screenPos Outputs 3D Screen/Clip-space coordinates.
+   * @param {Number[]} viewPos Outputs un-projected 3D View-space coordinates.
+   * @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

@@ -0,0 +1,136 @@
+import { Component } from "../Component";
+import { Camera } from "./Camera";
+
+/**
+ * @desc Defines its {@link Camera}'s perspective projection using a field-of-view angle.
+ */
+export declare class Perspective extends Component {
+  /**
+   * The Camera this Perspective belongs to.
+   *
+   * @property camera
+   * @type {Camera}
+   * @final
+   */
+  camera: Camera;
+
+  /**
+   * 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.
+   */
+  get fov(): number;
+
+  /**
+   * 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.
+   *
+   * 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;
+
+  /**
+   * 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.
+   */
+  get near(): number;
+
+  /**
+   * 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.
+   */
+  set far(arg: number);
+
+  /**
+   * 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.
+   */
+  get matrix(): number[];
+
+  /**
+   * Gets the inverse of {@link Perspective.matrix}.
+   *
+   * @returns {Number[]} The inverse of {@link Perspective.matrix}.
+   */
+  get inverseMatrix(): number[];
+
+  /**
+   * Gets the transpose of {@link Perspective.matrix}.
+   *
+   * @returns {Number[]} The transpose of {@link Perspective.matrix}.
+   */
+  get transposedMatrix(): number[];
+
+  /**
+   * Un-projects the given Canvas-space coordinates and Screen-space depth, using this Perspective projection.
+   *
+   * @param {Number[]} canvasPos Inputs 2D Canvas-space coordinates.
+   * @param {Number} screenZ Inputs Screen-space Z coordinate.
+   * @param {Number[]} screenPos Outputs 3D Screen/Clip-space coordinates.
+   * @param {Number[]} viewPos Outputs un-projected 3D View-space coordinates.
+   * @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/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./Camera";
+export * from "./CameraFlightAnimation";
+export * from "./CameraPath";
+export * from "./CameraPathAnimation";

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

@@ -0,0 +1,7 @@
+import { Component } from "../Component";
+
+/**
+ * Defines a shape for one or more {@link Mesh}es.
+ */
+export declare class Geometry extends Component {
+}

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

@@ -0,0 +1,95 @@
+import {Geometry} from "./Geometry";
+import {Component} from "../Component";
+
+export declare type ReadableGeometryConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, */
+  id?: string;
+  /** Optional map of user-defined metadata to attach to this Geometry. */
+  meta?: {[key: string]: any};
+  /** The primitive type. */
+  primitive?: "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+  /** Positions array. */
+  positions?: number[];
+  /** Vertex normal vectors array. */
+  normals?: number[];
+  /** UVs array. */
+  uv?: number[];
+  /** Vertex colors. */
+  colors?: number[];
+  /** Indices array. */
+  indices?: number[];
+  /** Set true to automatically generate normal vectors from the positions and indices, if those are supplied.*/
+  autoVertexNormals?: boolean;
+  /** Stores positions, colors, normals and UVs in compressGeometry and oct-encoded formats for reduced memory footprint and GPU bus usage.*/
+  compressGeometry?: boolean;
+  /** When a {@link Mesh} renders this Geometry as wireframe, this indicates the threshold angle (in degrees) between the face normals of adjacent triangles below which the edge is discarded.*/
+  edgeThreshold?: number;
+};
+
+/**
+ * A {@link Geometry} that keeps its geometry data in both browser and GPU memory.
+ *
+ * ReadableGeometry uses more memory than {@link VBOGeometry}, which only stores its geometry data in GPU memory.
+ */
+ export declare class ReadableGeometry extends Geometry {
+  /**
+   * constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {ReadableGeometryConfiguration} cfg Configs
+   */
+  constructor(owner: Component, cfg?: ReadableGeometryConfiguration);
+
+  /**
+   * Gets the Geometry"s primitive type.
+   */
+  get primitive(): "points" | "lines"| "line-loop"| "line-strip"| "triangles"| "triangle-strip" | "triangle-fan";
+
+  /**
+   * Indicates if this Geometry is quantized.
+   */
+  get compressGeometry(): boolean;
+
+  /**
+   * The Geometry's vertex positions.
+   */
+  get positions(): number[];
+  set positions(arg: number[]);
+
+  /**
+   * The Geometry's vertex normals.
+   */
+  get normals(): number[];
+  set normals(arg: number[]);
+
+  /**
+   The Geometry's UV coordinates.
+   */
+  get uv(): number[];
+  set uv(arg: number[]);
+
+  /**
+   * The Geometry's vertex colors.
+   */
+  get colors(): number[];
+  set colors(arg: number[]);
+
+  /**
+   * The Geometry's indices.
+   */
+  get indices(): Uint16Array | Uint32Array;
+
+  /**
+   * Local-space axis-aligned 3D boundary (AABB) of this geometry.
+   */
+  get aabb(): number[];
+
+  /**
+   * Local-space oriented 3D boundary (OBB) of this geometry.
+   */
+  get obb(): number[];
+
+  /**
+   * Approximate number of triangles in this ReadableGeometry.
+   */
+  get numTriangles(): number;
+}

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

@@ -0,0 +1 @@
+export * from "./ReadableGeometry";

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

@@ -0,0 +1,17 @@
+export * from "./Component";
+export * from "./Entity";
+
+export * from "./camera";
+export * from "./CameraControl/CameraControl";
+export * from "./geometry";
+export * from "./marker";
+export * from "./materials";
+export * from "./math/math";
+export * from "./mementos";
+export * from "./mesh";
+export * from "./nodes";
+export * from "./models";
+export * from "./scene/Scene";
+export * from "./sectionPlane";
+export * from "./viewport";
+export * from "./webgl";