@xeokit/xeokit-sdk 2.6.72 → 2.6.75

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

@@ -1,5 +1,6 @@
 import { Component } from "../Component";
 import { Entity } from "../Entity";
+import { Material } from "../materials";
 import { PickResult } from "../webgl/PickResult";
 
 /**
@@ -24,6 +25,9 @@ export declare class CameraControl extends Component {
   AXIS_VIEW_FRONT: number;
   AXIS_VIEW_TOP: number;
   AXIS_VIEW_BOTTOM: number;
+  MOUSE_PAN: number;
+  MOUSE_ROTATE: number;
+  MOUSE_DOLLY: number;
 
   /**
    * Fires when the model is loaded
@@ -240,6 +244,65 @@ export declare class CameraControl extends Component {
    */
   get active(): boolean;
 
+  /**
+   * Sets whether the pointer snap to vertex.
+   *
+   * @param {boolean} arg
+   */
+  set snapToVertex(arg: boolean);
+
+  /**
+   * Gets whether the pointer snap to vertex.
+   *
+   * @returns {boolean}
+   */
+  get snapToVertex(): boolean;
+
+  /**
+   * Sets whether the pointer snap to edge.
+   *
+   * @param {boolean} arg
+   */
+  set snapToEdge(arg: boolean);
+
+  /**
+   * Gets whether the pointer snap to edge.
+   *
+   * @returns {boolean}
+   */
+  get snapToEdge(): boolean;
+
+  /**
+   * Sets the current snap radius for "hoverSnapOrSurface" events, to specify whether the radius
+   * within which the pointer snaps to the nearest vertex or the nearest edge.
+   *
+   * Default value is 30 pixels.
+   *
+   * @param {Number} arg The snap radius.
+   */
+  set snapRadius(arg: number);
+
+  /**
+   * Gets the current snap radius.
+   *
+   * @returns {Number} The snap radius.
+   */
+  get snapRadius(): number;
+
+  /**
+   * If `true`, the keyboard shortcuts are enabled ONLY if the mouse is over the canvas.
+   * 
+   * @param {boolean} arg
+   */
+  set keyboardEnabledOnlyIfMouseover(arg: boolean);
+
+  /**
+   * Gets whether the keyboard shortcuts are enabled ONLY if the mouse is over the canvas or ALWAYS.
+   * 
+   * @returns {boolean}
+   */
+  get keyboardEnabledOnlyIfMouseover(): boolean;
+
   /**
    * Sets whether the {@link Camera} follows the mouse/touch pointer.
    *
@@ -502,6 +565,47 @@ export declare class CameraControl extends Component {
    */
   get panInertia(): number;
 
+  /**
+   * Sets the keyboard layout.
+   *
+   * Supported layouts are:
+   *
+   * * ````"qwerty"```` (default)
+   * * ````"azerty"````
+   *
+   * @deprecated
+   * @param {String} arg Selects the keyboard layout.
+   */
+  set keyboardLayout(arg: string);
+
+  /**
+   * Gets the keyboard layout.
+   *
+   * Supported layouts are:
+   *
+   * * ````"qwerty"```` (default)
+   * * ````"azerty"````
+   *
+   * @deprecated
+   * @returns {String} The current keyboard layout.
+   */
+  get keyboardLayout(): string;
+
+  /**
+   * Sets a sphere as the representation of the pivot position.
+   *
+   * @param {Object} [cfg] Sphere configuration.
+   * @param {String} [cfg.size=1] Optional size factor of the sphere. Defaults to 1.
+   * @param {String} [cfg.material=PhongMaterial] Optional size factor of the sphere. Defaults to a red opaque material.
+   */
+  enablePivotSphere(cfg: {size: number, material: Material}): void;
+
+  /**
+   * Remove the sphere as the representation of the pivot position.
+   *
+   */
+  disablePivotSphere(): void;
+
   /**
    * Sets whether mouse and touch input is enabled.
    *
@@ -646,6 +750,34 @@ export declare class CameraControl extends Component {
    */
   get panToPointer(): boolean;
 
+  /**
+   * Sets whether this ````CameraControl```` is in plan-view mode.
+   *
+   * When in plan-view mode, rotation is disabled.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl#navMode} instead.
+   *
+   * @param {Boolean} arg Set ````true```` to enable plan-view mode.
+   * @deprecated
+   */
+  set planView(arg: boolean);
+
+  /**
+   * Gets whether this ````CameraControl```` is in plan-view mode.
+   *
+   * When in plan-view mode, rotation is disabled.
+   *
+   * Default is ````false````.
+   *
+   * Deprecated - use {@link CameraControl#navMode} instead.
+   *
+   * @returns {Boolean} Returns ````true```` if plan-view mode is enabled.
+   * @deprecated
+   */
+  get planView(): boolean;
+
   /**
    * Sets whether this ````CameraControl```` is in first-person mode.
    *
@@ -701,4 +833,40 @@ export declare class CameraControl extends Component {
    * @returns {Boolean} Returns ````true```` when pivoting by default about the selected point on the virtual sphere, or ````false```` when pivoting by default about {@link Camera.look}.
    */
   get smartPivot(): boolean;
+
+  /**
+   * Sets the double click time frame length in milliseconds.
+   * 
+   * If two mouse click events occur within this time frame, it is considered a double click. 
+   * 
+   * Default is ````250````
+   * 
+   * @param {Number} arg New double click time frame.
+   */
+  set doubleClickTimeFrame(arg: number);
+
+  /**
+   * Gets the double click time frame length in milliseconds.
+   *  
+   * Default is ````250````
+   * 
+   * @returns {Number} Current double click time frame.
+   */
+  get doubleClickTimeFrame(): number;
+
+  /**
+   * Sets whether to zoom the camera on mouse wheel
+   *
+   * Default is ````true````
+   *
+   * @param {Boolean} arg
+   */
+  set zoomOnMouseWheel(arg: boolean);
+
+  /**
+   * Gets whether to zoom the camera on mouse wheel
+   *
+   * @returns {Boolean}
+   */
+  get zoomOnMouseWheel(): boolean;
 }

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

@@ -66,7 +66,7 @@ export declare class LineSet extends Component {
      * @param {string} [cfg.id] Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted.
      * @param {number[]} cfg.positions World-space 3D vertex positions.
      * @param {number[]} [cfg.indices] Indices to connect ````positions```` into line segments. Note that these are separate line segments, not a polyline.
-     * @param {number[]} [cfg.color=[0,0,0]] The color of this ````LineSet````. This is both emissive and diffuse.
+     * @param {number[]} [cfg.color=[1,1,1]] The color of this ````LineSet````. This is both emissive and diffuse.
      * @param {boolean} [cfg.visible=true] Indicates whether or not this ````LineSet```` is visible.
      * @param {number} [cfg.opacity=1.0] ````LineSet````'s initial opacity factor.
      */

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

@@ -1,4 +1,5 @@
 import { Component } from "../Component";
+import { SplineCurve } from '../paths/SplineCurve';
 
 export declare type Frame = {
   t: number;
@@ -19,10 +20,89 @@ export declare type CameraPathConfiguration = {
  *
  */
 export declare class CameraPath extends Component {
-    /**
-     * @constructor
-     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this CameraPath as well.
-     * @param {CameraPathConfiguration} [cfg] Configuration
-     */
-    constructor(owner?: Component, cfg?: CameraPathConfiguration);
+  /**
+   * @constructor
+   * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this CameraPath as well.
+   * @param {CameraPathConfiguration} [cfg] Configuration
+   */
+  constructor(owner?: Component, cfg?: CameraPathConfiguration);
+
+  /**
+   * Gets the camera frames in this CameraPath.
+   *
+   * @returns {{t:Number, eye:Object, look:Object, up: Object}[]} The frames on this CameraPath.
+   */
+  get frames(): Frame[];
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#eye} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#eye}.
+   */
+  get eyeCurve(): SplineCurve;
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#look} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#look}.
+   */
+  get lookCurve(): SplineCurve;
+
+  /**
+   * Gets the {@link SplineCurve} along which {@link Camera#up} travels.
+   * @returns {SplineCurve} The SplineCurve for {@link Camera#up}.
+   */
+  get upCurve(): SplineCurve;
+
+  /**
+   * Adds a frame to this CameraPath, given as the current position of the {@link Camera}.
+   *
+   * @param {Number} t Time instant for the new frame.
+   */
+  saveFrame(t: number): void;
+
+  /**
+   * Adds a frame to this CameraPath, specified as values for eye, look and up vectors at a given time instant.
+   *
+   * @param {Number} t Time instant for the new frame.
+   * @param {Number[]} eye A three-element vector specifying the eye position for the new frame.
+   * @param {Number[]} look A three-element vector specifying the look position for the new frame.
+   * @param {Number[]} up A three-element vector specifying the up vector for the new frame.
+   */
+  addFrame(t: number, eye: number, look: number[], up: number[]): void;
+
+  /**
+   * Adds multiple frames to this CameraPath, each frame specified as a set of values for eye, look and up vectors at a given time instant.
+   *
+   * @param {{t:Number, eye:Object, look:Object, up: Object}[]} frames Frames to add to this CameraPath.
+   */
+  addFrames(frames: Frame[]): void;
+
+  /**
+   * Sets the position of the {@link Camera} to a position interpolated within this CameraPath at the given time instant.
+   *
+   * @param {Number} t Time instant.
+   */
+  loadFrame(t: number): void;
+
+  /**
+   * Gets eye, look and up vectors on this CameraPath at a given instant.
+   *
+   * @param {Number} t Time instant.
+   * @param {Number[]} eye The eye position to update.
+   * @param {Number[]} look The look position to update.
+   * @param {Number[]} up The up vector to update.
+   */
+  sampleFrame(t: number, eye: number[], look: number[], up: number[]): void;
+
+  /**
+   * Given a total duration (in seconds) for this CameraPath, recomputes the time instant at each frame so that,
+   * when animated by {@link CameraPathAnimation}, the {@link Camera} will move along the path at a constant rate.
+   *
+   * @param {Number} duration The total duration for this CameraPath.
+   */
+  smoothFrameTimes(duration: number): void;
+
+   /**
+   * Removes all frames from this CameraPath.
+   */
+   clearFrames(): void;
 }

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

@@ -91,5 +91,7 @@ export declare class CameraPathAnimation extends Component {
      * Stops playing this CameraPathAnimation.
      */
     stop(): void;
+
+    destroy(): void;
 }
 

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

@@ -88,8 +88,22 @@ export declare class ReadableGeometry extends Geometry {
    */
   get obb(): number[];
 
+  /**
+   * Returns the surface area of this Mesh.
+   * @returns {number}
+   */
+  get surfaceArea(): number;
+
+  /**
+   * Returns the centroid of this Mesh.
+   * @returns {number}
+   */
+  get centroid(): number;
+
   /**
    * Approximate number of triangles in this ReadableGeometry.
    */
   get numTriangles(): number;
+
+  destroy(): void;
 }

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

@@ -60,4 +60,6 @@ export declare class VBOGeometry extends Geometry {
    * Will be zero if {@link VBOGeometry#primitive} is not 'triangles', 'triangle-strip' or 'triangle-fan'.
    */
   get numTriangles(): Number;
+
+  destroy(): void;
 }

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

@@ -1,3 +1,4 @@
 export * from "./ReadableGeometry";
 export * from "./VBOGeometry";
-export * from "./builders";
+export * from "./builders";
+export * from "./loaders";

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

@@ -0,0 +1,2 @@
+export * from './load3DSGeometry';
+export * from './loadOBJGeometry';

package/types/viewer/scene/geometry/loaders/load3DSGeometry.d.ts

@@ -0,0 +1,17 @@
+import {Scene} from '../../scene/Scene';
+
+export declare type load3DSGeometryConfiguration = {
+    /** Path to 3DS file. */
+    src?: string;
+}
+
+export declare type Geometry3DSData = {
+    src?: string;
+    primitive: string;
+    positions: number[];
+    normals: number[] | null;
+    uv: number[];
+    indices: number[];
+}
+
+export function load3DSGeometry(scene: Scene, cfg?: load3DSGeometryConfiguration) : Promise<Geometry3DSData>;

package/types/viewer/scene/geometry/loaders/loadOBJGeometry.d.ts

@@ -0,0 +1,18 @@
+import {Scene} from '../../scene/Scene';
+
+export declare type LoadObjGeometryConfiguration = {
+    /** Path to OBJ file. */
+    src?: string;
+}
+
+export declare type ObjGeometryData = {
+    src?: string;
+    primitive: string;
+    positions: number[];
+    normals: number[] | null;
+    autoNormals: number[] | null;
+    uv: number[];
+    indices: number[]
+}
+
+export function loadOBJGeometry(scene: Scene, cfg?: LoadObjGeometryConfiguration) : Promise<ObjGeometryData>;

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

@@ -12,9 +12,11 @@ export * from "./math/math";
 export * from "./mementos";
 export * from "./mesh";
 export * from "./nodes";
+export * from './paths';
 export * from "./models";
 export * from "./scene/Scene";
 export * from "./sectionPlane";
+export * from './skybox';
 export * from "./stats";
 export * from "./viewport";
 export * from "./webgl";

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

@@ -10,6 +10,123 @@ import { Component } from "../Component";
  */
 export declare class Input extends Component {
 
+  KEY_BACKSPACE: number;
+  KEY_TAB: number;
+  KEY_ENTER: number;
+  KEY_SHIFT: number;
+  KEY_CTRL: number;
+  KEY_ALT: number;
+  KEY_PAUSE_BREAK: number;
+  KEY_CAPS_LOCK: number;
+  KEY_ESCAPE: number;
+  KEY_PAGE_UP: number;
+  KEY_PAGE_DOWN: number;
+  KEY_END: number;
+  KEY_HOME: number;
+  KEY_LEFT_ARROW: number;
+  KEY_UP_ARROW: number;
+  KEY_RIGHT_ARROW: number;
+  KEY_DOWN_ARROW: number;
+  KEY_INSERT: number;
+  KEY_DELETE: number;
+  KEY_NUM_0: number;
+  KEY_NUM_1: number;
+  KEY_NUM_2: number;
+  KEY_NUM_3: number;
+  KEY_NUM_4: number;
+  KEY_NUM_5: number;
+  KEY_NUM_6: number;
+  KEY_NUM_7: number;
+  KEY_NUM_8: number;
+  KEY_NUM_9: number;
+  KEY_A: number;
+  KEY_B: number;
+  KEY_C: number;
+  KEY_D: number;
+  KEY_E: number;
+  KEY_F: number;
+  KEY_G: number;
+  KEY_H: number;
+  KEY_I: number;
+  KEY_J: number;
+  KEY_K: number;
+  KEY_L: number;
+  KEY_M: number;
+  KEY_N: number;
+  KEY_O: number;
+  KEY_P: number;
+  KEY_Q: number;
+  KEY_R: number;
+  KEY_S: number;
+  KEY_T: number;
+  KEY_U: number;
+  KEY_V: number;
+  KEY_W: number;
+  KEY_X: number;
+  KEY_Y: number;
+  KEY_Z: number;
+  KEY_LEFT_WINDOW: number;
+  KEY_RIGHT_WINDOW: number;
+  KEY_SELECT_KEY: number;
+  KEY_NUMPAD_0: number;
+  KEY_NUMPAD_1: number;
+  KEY_NUMPAD_2: number;
+  KEY_NUMPAD_3: number;
+  KEY_NUMPAD_4: number;
+  KEY_NUMPAD_5: number;
+  KEY_NUMPAD_6: number;
+  KEY_NUMPAD_7: number;
+  KEY_NUMPAD_8: number;
+  KEY_NUMPAD_9: number;
+  KEY_MULTIPLY: number;
+  KEY_ADD: number;
+  KEY_SUBTRACT: number;
+  KEY_DECIMAL_POINT: number;
+  KEY_DIVIDE: number;
+  KEY_F1: number;
+  KEY_F2: number;
+  KEY_F3: number;
+  KEY_F4: number;
+  KEY_F5: number;
+  KEY_F6: number;
+  KEY_F7: number;
+  KEY_F8: number;
+  KEY_F9: number;
+  KEY_F10: number;
+  KEY_F11: number;
+  KEY_F12: number;
+  KEY_NUM_LOCK: number;
+  KEY_SCROLL_LOCK: number;
+  KEY_SEMI_COLON: number;
+  KEY_EQUAL_SIGN: number;
+  KEY_COMMA: number;
+  KEY_DASH: number;
+  KEY_PERIOD: number;
+  KEY_FORWARD_SLASH: number;
+  KEY_GRAVE_ACCENT: number;
+  KEY_OPEN_BRACKET: number;
+  KEY_BACK_SLASH: number;
+  KEY_CLOSE_BRACKET: number;
+  KEY_SINGLE_QUOTE: number;
+  KEY_SPACE: number;
+  MOUSE_LEFT_BUTTON: number;
+  MOUSE_MIDDLE_BUTTON: number;
+  MOUSE_RIGHT_BUTTON: number;
+
+  element: HTMLCanvasElement;
+
+  altDown: boolean;
+  ctrlDown: boolean;
+  mouseDownLeft: boolean;
+  mouseDownMiddle: boolean;
+  mouseDownRight: boolean;
+  keyDown: boolean[];
+  enabled: boolean;
+  keyboardEnabled: boolean;
+  mouseover: boolean;
+  mouseCanvasPos: number[];
+
+
   /**
    * Sets whether input handlers are enabled.
    */

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

@@ -16,4 +16,45 @@ export declare class AmbientLight extends Light {
    * @param {AmbientLightConfiguration} [cfg] AmbientLight configuration
    */
   constructor(owner: Component, cfg: AmbientLightConfiguration);
+
+  /**
+   * 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.
+   */
+  get color(): number;
+
+  /**
+   * 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.
+   */
+  get intensity(): number;
+
+  /**
+   * Destroys this AmbientLight.
+   */
+  destroy(): void;
 }

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

@@ -0,0 +1,27 @@
+import { Component } from '../Component';
+
+export declare type CubeTextureConfiguration = {
+    /**Optional ID for this CubeTexture, unique among all components in the parent scene, generated automatically when omitted. */
+    id?: string;
+    /**Paths to six image files to load into this CubeTexture. */
+    src: string[];
+    /**Flips this CubeTexture's source data along its vertical axis when true. */
+    flipY?: boolean;
+    /**Encoding format. Supported values are {@link LinearEncoding} and {@link sRGBEncoding}. */
+    encoding?: number;
+}
+
+export declare class CubeTexture extends Component {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this component as well.
+     * @param {CubeTextureConfiguration} [cfg] Configs
+     */
+    constructor(owner: Component, cfg?: CubeTextureConfiguration);
+
+    /**
+     * Destroys this CubeTexture
+     *
+     */
+    destroy(): void;
+}

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

@@ -22,4 +22,81 @@ export declare class DirLight extends Light {
    * @param {DirLightConfiguration} [cfg] DirLight configuration
    */
   constructor(owner: Component, cfg: DirLightConfiguration);
+
+  /**
+   * 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.
+   */
+  get dir(): number;
+
+  /**
+   * 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.
+   */
+  get color(): number[];
+
+  /**
+   * 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.
+   */
+  get intensity(): number;
+
+  /**
+   * 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.
+   */
+  get castsShadow(): boolean;
+  
+  /**
+   * Destroys this DirLight.
+   */
+  destroy(): void;
 }