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

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,6 @@
+export * from "./Camera";
+export * from "./CameraControl/CameraControl";
+export * from "./Component";
+export * from "./Entity";
+export * from "./math/math";
+export * from "./PerformanceModel/PerformanceModel";

package/types/viewer/scene/marker/Marker.d.ts

@@ -0,0 +1,136 @@
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+
+export declare type MarkerConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** Entity to associate this Marker with. When the Marker has an Entity, then {@link Marker#visible} will always be ````false```` if {@link Entity#visible} is false. */
+  entity?: Entity
+  /** Indicates whether or not this Marker is hidden (ie. {@link Marker#visible} is ````false```` whenever occluded by {@link Entity}s in the {@link Scene}. */
+  occludable?: boolean;
+  /** World-space 3D Marker position. */
+  worldPos?: number[];
+};
+
+/**
+ * @desc Tracks the World, View and Canvas coordinates, and visibility, of a position within a {@link Scene}.
+ */
+export class Marker extends Component {
+  /**
+   * @constructor
+   * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this Marker as well.
+   * @param {MarkerConfiguration} [cfg]  Marker configuration
+   */
+  constructor(owner?: Component, cfg?: MarkerConfiguration);
+  
+  /**
+   * Sets the {@link Entity} this Marker is associated with.
+   *
+   * An Entity is optional. When the Marker has an Entity, then {@link Marker#visible} will always be ````false````
+   * if {@link Entity#visible} is false.
+   *
+   * @type {Entity}
+   */
+  set entity(arg: Entity);
+  
+  /**
+   * Gets the {@link Entity} this Marker is associated with.
+   *
+   * @type {Entity}
+   */
+  get entity(): Entity;
+
+  /**
+   * Sets the World-space 3D position of this Marker.
+   *
+   * Fires a "worldPos" event with new World position.
+   *
+   * @type {Number[]}
+   */
+  set worldPos(arg: number[]);
+
+  /**
+   * Gets the World-space 3D position of this Marker.
+   *
+   * @type {Number[]}
+   */
+  get worldPos(): number[];
+
+  /**
+   * Sets whether occlusion testing is performed for this Marker.
+   *
+   * When this is ````true````, then {@link Marker#visible} will be ````false```` whenever the Marker is occluded by an {@link Entity} in the 3D view.
+   *
+   * The {@link Scene} periodically occlusion-tests all Markers on every 20th "tick" (which represents a rendered frame). We
+   * can adjust that frequency via property {@link Scene#ticksPerOcclusionTest}.
+   *
+   * @type {Boolean}
+   */
+  set occludable(arg: boolean);
+
+  /**
+   * Gets whether occlusion testing is performed for this Marker.
+   *
+   * When this is ````true````, then {@link Marker#visible} will be ````false```` whenever the Marker is occluded by an {@link Entity} in the 3D view.
+   *
+   * @type {Boolean}
+   */
+  get occludable(): boolean;
+
+  /**
+   * Gets the RTC center of this Marker.
+   *
+   * This is automatically calculated from {@link Marker#worldPos}.
+   *
+   * @type {Number[]}
+   */
+  get origin(): number[];
+
+  /**
+   * Gets the RTC position of this Marker.
+   *
+   * This is automatically calculated from {@link Marker#worldPos}.
+   *
+   * @type {Number[]}
+   */
+  get rtcPos(): number[];
+
+  /**
+   * View-space 3D coordinates of this Marker.
+   *
+   * This property is read-only and is automatically calculated from {@link Marker#worldPos} and the current {@link Camera} position.
+   *
+   * The Marker fires a "viewPos" event whenever this property changes.
+   *
+   * @type {Number[]}
+   */
+  get viewPos(): number[];
+
+  /**
+   * Canvas-space 2D coordinates of this Marker.
+   *
+   * This property is read-only and is automatically calculated from {@link Marker#worldPos} and the current {@link Camera} position and projection.
+   *
+   * The Marker fires a "canvasPos" event whenever this property changes.
+   *
+   * @type {Number[]}
+   */
+  get canvasPos(): number[];
+
+  /**
+   * Indicates if this Marker is currently visible.
+   *
+   * This is read-only and is automatically calculated.
+   *
+   * The Marker is **invisible** whenever:
+   *
+   * * {@link Marker#canvasPos} is currently outside the canvas,
+   * * {@link Marker#entity} is set to an {@link Entity} that has {@link Entity#visible} ````false````, or
+   * * or {@link Marker#occludable} is ````true```` and the Marker is currently occluded by an Entity in the 3D view.
+   *
+   * The Marker fires a "visible" event whenever this property changes.
+   *
+   * @type {Boolean}
+   */
+  get visible(): boolean;
+}

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

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

package/types/viewer/scene/materials/EdgeMaterial.d.ts

@@ -0,0 +1,83 @@
+import { Material } from "./Material";
+import { Component } from "../Component";
+
+export declare type EdgeMaterialConfiguration = {
+  /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+  id?: string;
+  /** RGB edge color. */
+  edgeColor?: number[];
+  /** Edge transparency. */
+  edgeAlpha?: number;
+  /** Edge width in pixels. */
+  edgeWidth?: number;
+  /** Selects a preset EdgeMaterial configuration */
+  preset?:  string;
+};
+
+/**
+ * Configures the appearance of {@link Entity}s when their edges are emphasised.
+ */
+export declare class EdgeMaterial extends Material {
+  /**
+   * @constructor
+   * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+   * @param {EdgeMaterialConfiguration} [cfg] The EdgeMaterial configuration
+   */
+  constructor(owner: Component, cfg?: EdgeMaterialConfiguration);
+
+  /**
+   * Gets available EdgeMaterial presets.
+   */
+  get presets(): any;
+
+  /**
+   * Selects a preset EdgeMaterial configuration.
+   * @type {String}
+   */
+  set preset(arg: string);
+
+  /**
+   * The current preset EdgeMaterial configuration.
+   */
+  get preset(): string;
+
+  /**
+   * Sets RGB edge color.
+   */
+  set edgeColor(arg: number[]);
+
+  /**
+   * Gets RGB edge color.
+   */
+  get edgeColor(): number[];
+
+  /**
+   * Sets edge transparency.
+   */
+  set edgeAlpha(arg: number);
+
+  /**
+   * Gets edge transparency.
+   */
+  get edgeAlpha(): number;
+
+  /**
+   * Sets edge width.
+   */
+  set edgeWidth(arg: number);
+
+  /**
+   * Gets edge width.
+   */
+  get edgeWidth(): number;
+
+  /**
+   * Sets if edges are visible.
+   */
+  set edges(arg: boolean);
+
+  /**
+   * Gets if edges are visible.
+   */
+  get edges(): boolean;
+}