@xeokit/xeokit-sdk 2.6.73 → 2.6.75

package/types/viewer/scene/models/SceneModel.d.ts

@@ -3,6 +3,8 @@ import { SceneModelEntity } from "./SceneModelEntity";
 import { EdgeMaterial, EmphasisMaterial } from "../materials";
 import { SceneModelMesh } from "./SceneModelMesh";
 import { SceneModelTextureSet } from "./SceneModelTextureSet";
+import { SceneModelTransform } from "./SceneModelTransform";
+import { SceneModelTexture } from "./SceneModelTexture";
 
 /**
  * A high-performance model representation for efficient rendering and low memory usage.
@@ -25,6 +27,49 @@ export declare class SceneModel extends Component {
      */
     on(event: "error", callback: (msg: string) => void, scope?: any): string;
 
+    /**
+     * Returns true to indicate that this Component is a SceneModel.
+     * @type {Boolean}
+     */
+    get isPerformanceModel(): boolean;
+
+    /**
+     * The {@link SceneModelTransform}s in this SceneModel.
+     *
+     * Each {@link SceneModelTransform} is stored here against its {@link SceneModelTransform.id}.
+     *
+     * @returns {*|{}}
+     */
+    get transforms(): { [key: string]: SceneModelTransform }
+
+    /**
+     * The {@link SceneModelTexture}s in this SceneModel.
+     *
+     * * Each {@link SceneModelTexture} is created with {@link SceneModel.createTexture}.
+     * * Each {@link SceneModelTexture} is stored here against its {@link SceneModelTexture.id}.
+     *
+     * @returns {*|{}}
+     */
+    get textures(): { [key: string]: SceneModelTexture }
+
+    /**
+     * The {@link SceneModelTextureSet}s in this SceneModel.
+     *
+     * Each {@link SceneModelTextureSet} is stored here against its {@link SceneModelTextureSet.id}.
+     *
+     * @returns {*|{}}
+     */
+    get textureSets(): { [key: string]: SceneModelTextureSet }
+
+    /**
+     * The {@link SceneModelMesh}es in this SceneModel.
+     *
+     * Each {@link SceneModelMesh} is stored here against its {@link SceneModelMesh.id}.
+     *
+     * @returns {*|{}}
+     */
+    get meshes(): { [key: string]: SceneModelMesh }
+
     /**
      * Returns the {@link SceneModelEntity}s in this SceneModel.
      * @returns {*|{}}
@@ -42,6 +87,15 @@ export declare class SceneModel extends Component {
      */
     get origin(): number[];
 
+    /**
+     * Sets the SceneModel's local translation.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @type {number[]}
+     */
+    set position(value: number[]);
+
     /**
      * Gets the SceneModel's local translation.
      *
@@ -51,6 +105,15 @@ export declare class SceneModel extends Component {
      */
     get position(): number[];
 
+    /**
+     * Sets the SceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
+     *
+     * Default value is ````[0,0,0]````.
+     *
+     * @type {number[]}
+     */
+    set rotation(value: number[]);
+
     /**
      * Gets the SceneModel's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
      *
@@ -60,6 +123,15 @@ export declare class SceneModel extends Component {
      */
     get rotation(): number[];
 
+    /**
+     * Sets the SceneModel's local rotation quaternion.
+     *
+     * Default value is ````[0,0,0,1]````.
+     *
+     * @type {number[]}
+     */
+    set quaternion(value: number[]);
+
     /**
      * Gets the VBOSceneModels's local rotation quaternion.
      *
@@ -69,6 +141,16 @@ export declare class SceneModel extends Component {
      */
     get quaternion(): number[];
 
+    /**
+     * Sets the SceneModel's local scale.
+     *
+     * Default value is ````[1,1,1]````.
+     *
+     * @type {number[]}
+     * @deprecated
+     */
+    set scale(value: number[]);
+
     /**
      * Gets the SceneModel's local scale.
      *
@@ -78,6 +160,15 @@ export declare class SceneModel extends Component {
      */
     get scale(): number[];
 
+    /**
+     * Sets the SceneModel's local modeling transform matrix.
+     *
+     * Default value is ````[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]````.
+     *
+     * @type {number[]}
+     */
+    set matrix(value: number[])
+
     /**
      * Gets the SceneModel's local modeling transform matrix.
      *
@@ -87,6 +178,22 @@ export declare class SceneModel extends Component {
      */
     get matrix(): number[];
 
+    /**
+     * Gets the SceneModel's local modeling rotation transform matrix.
+     *
+     * @type {number[]}
+     */
+    get rotationMatrix(): number[];
+
+    /**
+     * Gets the conjugate of the SceneModel's local modeling rotation transform matrix.
+     *
+     * This is used for RTC view matrix management in renderers.
+     *
+     * @type {Number[]}
+     */
+    get rotationMatrixConjugate(): number[];
+
     /**
      * Gets the SceneModel's World matrix.
      *
@@ -168,13 +275,6 @@ export declare class SceneModel extends Component {
      */
     get aabb(): number[];
 
-    /**
-     * The number of entities in this SceneModel.
-     *
-     * @type {number}
-     */
-    get numEntities(): number;
-
     /**
      * The approximate number of triangle primitives in this SceneModel.
      *
@@ -424,6 +524,15 @@ export declare class SceneModel extends Component {
      */
     get pbrEnabled(): boolean;
 
+    /**
+     * Gets if color textures are enabled for this SceneModel.
+     *
+     * Only works when {@link Scene#colorTextureEnabled} is also true.
+     *
+     * @type {Boolean}
+     */
+    get colorTextureEnabled(): boolean;
+
     /**
      * Returns true to indicate that SceneModel is implements {@link Drawable}.
      *
@@ -467,6 +576,12 @@ export declare class SceneModel extends Component {
      */
     get edgeMaterial(): EdgeMaterial;
 
+    /**
+     *
+     * @param cfg
+     */
+    createQuantizationRange(arg: {id: string | number, aabb: number[]}): void;
+
     /**
      * Creates a texture within this SceneModel.
      *
@@ -702,6 +817,13 @@ export declare class SceneModel extends Component {
         edges?: boolean;
     }): SceneModelEntity;
 
+    /**
+     * Pre-renders all meshes that have been added, even if the SceneModel has not bee finalized yet.
+     * This is use for progressively showing the SceneModel while it is being loaded or constructed.
+     * @returns {boolean}
+     */
+    preFinalize(): boolean;
+
     /**
      * Finalizes this SceneModel.
      *
@@ -710,4 +832,9 @@ export declare class SceneModel extends Component {
      * Once finalized, you can't add anything more to this SceneModel.
      */
     finalize(): void;
+
+    /**
+     * Destroys this SceneModel.
+     */
+    destroy(): void;
 }

package/types/viewer/scene/models/SceneModelEntity.d.ts

@@ -1,6 +1,7 @@
 import {Entity} from "../Entity";
 import {SceneModelMesh} from "./SceneModelMesh";
 import {SceneModel} from "./SceneModel";
+import { Material } from "../materials";
 
 /**
  * An abstract 3D scene element that can be individually shown, hidden, selected,
@@ -89,6 +90,11 @@ export declare abstract class SceneModelEntity implements Entity {
      */
     get aabb(): number[];
 
+    /**
+     * The approximate number of primitives in this SceneModelEntity
+     */
+    get numPrimitives(): number;
+
     /**
      * The approximate number of triangles in this SceneModelEntity.
      *
@@ -205,6 +211,26 @@ export declare abstract class SceneModelEntity implements Entity {
      */
     get edges(): boolean;
 
+    /**
+     * Toggle View Frustum Culling
+     */
+    set culledVFC(arg: boolean);
+
+    /**
+     * Gets View Frustum Culling
+     */
+    get culledVFC(): boolean;
+
+    /**
+     * Toggle Level of Detail Culling
+     */
+    set culledLOD(arg: boolean);
+
+    /**
+     * Gets level of detail culling
+     */
+    get culledLOD(): boolean;
+
     /**
      * Sets if this SceneModelEntity is culled.
      *
@@ -363,6 +389,20 @@ export declare abstract class SceneModelEntity implements Entity {
      */
     get saoEnabled(): boolean;
 
+    /**
+     * Sets the material for this SceneModelEntity that will be used on the caps 
+     * when the objects of this entity are sliced
+     * 
+     * If there is no capMaterial attached to a SceneModelEntity then its objects
+     * will not be capped when sliced
+     */
+    set capMaterial(value: Material);
+
+    /**
+     * Gets the cap material attached to this SceneModelEntity
+     */
+    get capMaterial(): Material;
+
     /**
      * Sets the SceneModelEntity's 3D World-space offset.
      *
@@ -398,6 +438,31 @@ export declare abstract class SceneModelEntity implements Entity {
      */
     getEachVertex(callback: any): void;
 
+    /**
+     * Gets the indices of this entity in a callback
+     */
+    getEachIndex(callback: any): void;
+
+    /**
+     * Returns the volume of this SceneModelEntity.
+     *
+     * Only works when {@link Scene.readableGeometryEnabled | Scene.readableGeometryEnabled} is `true` and the
+     * SceneModelEntity contains solid triangle meshes; returns `0` otherwise.
+     *
+     * @returns {number}
+     */
+    get volume(): number;
+
+    /**
+     * Returns the surface area of this SceneModelEntity.
+     *
+     * Only works when {@link Scene.readableGeometryEnabled | Scene.readableGeometryEnabled} is `true` and the
+     * SceneModelEntity contains triangle meshes; returns `0` otherwise.
+     *
+     * @returns {number}
+     */
+    get surfaceArea(): number;
+
     /**
      * The {@link SceneModel} to which this SceneModelEntity belongs.
      */

package/types/viewer/scene/models/SceneModelMesh.d.ts

@@ -72,4 +72,16 @@ export declare class SceneModelMesh {
      */
     isSolid(): boolean;
 
+    /**
+     * Returns the volume of this SceneModelMesh.
+     * @returns {number}
+     */
+    get volume(): number;
+
+    /**
+     * Returns the surface area of this SceneModelMesh.
+     * @returns {number}
+     */
+    get surfaceArea(): number;
+
 }

package/types/viewer/scene/paths/CubicBezierCurve.d.ts

@@ -0,0 +1,146 @@
+import { Component } from '../Component';
+import { Curve } from './Curve';
+
+export declare type CubicBezierCurveConfiguration = {
+    /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+    id?: string;
+    /** The starting point. */
+    v0: number[];
+    /** The first control point. */
+    v1: number[];
+    /** The middle control point. */
+    v2: number[];
+    /** The ending point. */
+    v3: number[];
+    /** Current position on this CubicBezierCurve, in range between 0..1. */
+    t: number;
+}
+
+export declare type CubicBezierCurveJson = {
+    v0: number[],
+    v1: number[],
+    v2: number[],
+    v3: number[],
+    t: number
+}
+
+export declare class CubicBezierCurve extends Curve {
+    /**
+     * @constructor
+     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this CubicBezierCurve as well.
+     * @param {CubicBezierCurveConfiguration} [cfg] Configs
+     */
+    constructor(owner: Component, cfg?: CubicBezierCurveConfiguration);
+
+    /**
+     * Sets the starting point on this CubicBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @param {Number[]} value The starting point.
+     */
+    set v0(value: number[]);
+
+    /**
+     * Gets the starting point on this CubicBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @returns {Number[]} The starting point.
+     */
+    get v0(): number[];
+
+    /**
+     * Sets the first control point on this CubicBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @param {Number[]} value The first control point.
+     */
+    set v1(value: number[]);
+
+    /**
+     * Gets the first control point on this CubicBezierCurve.
+     *
+     * Fires a {@link CubicBezierCurve#v1:event} event on change.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @returns {Number[]} The first control point.
+     */
+    get v1(): number[];
+
+    /**
+     * Sets the second control point on this CubicBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @param {Number[]} value The second control point.
+     */
+    set v2(value: number[]);
+
+    /**
+     * Gets the second control point on this CubicBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @returns {Number[]} The second control point.
+     */
+    get v2(): number[];
+
+    /**
+     * Sets the end point on this CubicBezierCurve.
+     *
+     * Fires a {@link CubicBezierCurve#v3:event} event on change.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @param {Number[]} value The end point.
+     */
+    set v3(value: number[]);
+
+    /**
+     * Gets the end point on this CubicBezierCurve.
+     *
+     * Fires a {@link CubicBezierCurve#v3:event} event on change.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````
+     *
+     * @returns {Number[]} The end point.
+     */
+    get v3(): number[];
+
+    /**
+     * Sets the current position of progress along this CubicBezierCurve.
+     *
+     * Automatically clamps to range ````[0..1]````.
+     *
+     * @param {Number} value New progress time value.
+     */
+    set t(value: number);
+
+    /**
+     * Gets the current position of progress along this CubicBezierCurve.
+     *
+     * @returns {Number} Current progress time value.
+     */
+    get t(): number;
+
+    /**
+     * Returns point on this CubicBezierCurve at the given position.
+     *
+     * @returns {Number[]} The point at the given position.
+     */
+    get point(): number[];
+
+    /**
+     * Returns point on this CubicBezierCurve at the given position.
+     *
+     * @param {Number} t Position to get point at.
+     *
+     * @returns {Number[]} The point at the given position.
+     */
+    getPoint(t: number): number[];
+
+    getJSON(): CubicBezierCurveJson;
+}

package/types/viewer/scene/paths/Curve.d.ts

@@ -0,0 +1,75 @@
+import { Component } from "../Component";
+
+export declare type CurveConfiguration = {
+    /**Optional ID, unique among all components in the parent {@link Curve}, generated automatically when omitted. */
+    id?: string 
+    /**Current position on this Curve, in range between ````0..1```` */
+    t?: number
+}
+
+export declare class Curve extends Component {
+    /**
+     * @constructor
+     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this Curve as well.
+     * @param {CurveConfiguration} [cfg] Configs
+     */
+    constructor(owner?: Component, cfg?: CurveConfiguration);
+
+    /**
+     * Sets the progress along this Curve.
+     *
+     * Automatically clamps to range ````[0..1]````.
+     *
+     * Default value is ````0````.
+     *
+     * @param {Number} value The progress value.
+     */
+    set t(value: number);
+
+    /**
+     * Gets the progress along this Curve.
+     *
+     * @returns {Number} The progress value.
+     */
+    get t(): number;
+
+    /**
+     * Gets the tangent on this Curve at position {@link Curve#t}.
+     *
+     * @returns {Number[]} The tangent.
+     */
+    get tangent(): number[];
+
+    /**
+     * Gets the length of this Curve.
+     *
+     * @returns {Number} The Curve length.
+     */
+    get length(): number;
+
+    /**
+     * Returns a normalized tangent vector on this Curve at the given position.
+     *
+     * @param {Number} t Position to get tangent at.
+     * @returns {Number[]} Normalized tangent vector
+     */
+    getTangent(t: number): number[];
+
+    getPointAt(u: number): number[];
+
+    /**
+     * Samples points on this Curve, at the given number of equally-spaced divisions.
+     *
+     * @param {Number} divisions The number of divisions.
+     * @returns {{Array of Array}} Array of sampled 3D points.
+     */
+    getPoints(divisions: number): number[][];
+
+    /**
+     * 
+     * @param {Number} u
+     * @param {Number} distance 
+     * @returns {Number}
+     */
+    getUToTMapping(u: number, distance: number): number;
+}

package/types/viewer/scene/paths/Path.d.ts

@@ -0,0 +1,119 @@
+import { Component } from '../Component';
+import { Curve } from './Curve';
+
+export declare type PathConfiguration = {
+    /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+    id?: string;
+    /** IDs or instances of {{#crossLink "path"}}{{/crossLink}} subtypes to add to this Path. */
+    paths: string[];
+    /** Current position on this Path, in range between 0..1. */
+    t: number;
+}
+
+export declare type PathJson = {
+    v0: number[];
+    v1: number[];
+    v2: number[];
+    t: number;
+}
+
+export declare class Path extends Curve { 
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this MetallicMaterial as well.
+     * @param {PathConfiguration} [cfg] Configuration
+     */
+    constructor(owner: Component, cfg?: PathConfiguration);
+
+    /**
+     * Sets the starting point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @param {Number[]} value New starting point.
+     */
+    set v0(value: number[]);
+
+    /**
+     * Gets the starting point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @returns {Number[]} The starting point.
+     */
+    get v0(): number[];
+
+    /**
+     * Sets the middle control point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @param {Number[]} value New middle control point.
+     */
+    set v1(value: number[]);
+
+    /**
+     * Gets the middle control point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @returns {Number[]} The middle control point.
+     */
+    get v1(): number[];
+
+    /**
+     * Sets the end point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @param {Number[]} value The new end point.
+     */
+    set v2(value: number[]);
+
+    /**
+     * Gets the end point on this QuadraticBezierCurve.
+     *
+     * Default value is ````[0.0, 0.0, 0.0]````.
+     *
+     * @returns {Number[]} The end point.
+     */
+    get v2(): number[];
+
+    /**
+     * Sets the progress along this QuadraticBezierCurve.
+     *
+     * Automatically clamps to range [0..1].
+     *
+     * Default value is ````0````.
+     *
+     * @param {Number} value The new progress location.
+     */
+    set t(value: number);
+
+    /**
+     * Gets the progress along this QuadraticBezierCurve.
+     *
+     * Default value is ````0````.
+     *
+     * @returns {Number} The current progress location.
+     */
+    get t(): number;
+
+    /**
+     Point on this QuadraticBezierCurve at position {@link QuadraticBezierCurve/t}.
+
+     @property point
+     @type {Number[]}
+     */
+    get point(): number[];
+
+    /**
+     * Returns the point on this QuadraticBezierCurve at the given position.
+     *
+     * @param {Number} t Position to get point at.
+     * @returns {Number[]} The point.
+     */
+    getPoint(t: number): number[];
+
+    getJSON(): PathJson;
+}