@xeokit/xeokit-sdk 2.6.72 → 2.6.75

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

@@ -0,0 +1,124 @@
+import { Component } from "../Component";
+import { Curve } from "./Curve";
+
+export declare type QuadraticBezierCurveConfiguration = {
+    /** Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+    id?: string;
+    /** The starting point. */
+    v0: number[];
+    /** The middle control point. */
+    v1: number[];
+    /** The end point. */
+    v2: number[];
+    /** Current position on this QuadraticBezierCurve, in range between ````0..1````. */
+    t: number;
+}
+
+export declare type QuadraticBezierCurveJson = {
+    v0: number[];
+    v1: number[];
+    v2: number[];
+    t: number;
+}
+
+export declare class QuadraticBezierCurve extends Curve {
+
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this MetallicMaterial as well.
+     * @param {QuadraticBezierCurveConfiguration} [cfg] Configuration
+     */
+    constructor(owner: Component, cfg?: QuadraticBezierCurveConfiguration);
+
+    /**
+     * 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(): QuadraticBezierCurveJson;
+}

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

@@ -0,0 +1,84 @@
+import { Component } from '../Component';
+import { Curve } from './Curve';
+
+export declare type SplineCurveConfiguration = {
+    /**Optional ID, unique among all components in the parent {@link Scene}, generated automatically when omitted. */
+    id?: string;
+    /**Control points on this SplineCurve. */
+    points?: number[];
+    /**Current position on this SplineCurve, in range between 0..1. */
+    t?: number;
+}
+
+export declare type SpliceCurveJSON = {
+    points: number[];
+    t: number;
+}
+
+export declare class SplineCurve extends Curve {
+
+    /**
+     * @constructor
+     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this SplineCurve as well.
+     * @param {SplineCurveConfiguration} [cfg] Configs
+     */
+    constructor(owner?: Component, cfg?: SplineCurveConfiguration);
+
+    /**
+     * Sets the control points on this SplineCurve.
+     *
+     * Default value is ````[]````.
+     *
+     * @param {Number[]} value New control points.
+     */
+    set points(value: number);
+
+    /**
+     * Gets the control points on this SplineCurve.
+     *
+     * Default value is ````[]````.
+     *
+     * @returns {Number[]} The control points.
+     */
+    get points(): number[];
+
+    /**
+     * Sets the progress along this SplineCurve.
+     *
+     * Automatically clamps to range ````[0..1]````.
+     *
+     * Default value is ````0````.
+     *
+     * @param {Number} value The new progress.
+     */
+    set t(value: number);
+
+    /**
+     * Gets the progress along this SplineCurve.
+     *
+     * Automatically clamps to range ````[0..1]````.
+     *
+     * Default value is ````0````.
+     *
+     * @returns {Number} The new progress.
+     */
+    get t(): number;
+
+    /**
+     * Gets the point on this SplineCurve at position {@link SplineCurve#t}.
+     *
+     * @returns {Number[]} The point at {@link SplineCurve#t}.
+     */
+    get point(): number;
+
+    /**
+     * Returns point on this SplineCurve at the given position.
+     *
+     * @param {Number} t Position to get point at.
+     * @returns {Number[]} Point at the given position.
+     */
+    getPoint(t: number): number[];
+
+    getJSON(): SpliceCurveJSON;
+
+}

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

@@ -0,0 +1,5 @@
+export * from './CubicBezierCurve';
+export * from './Curve';
+export * from './Path';
+export * from './QuadraticBezierCurve';
+export * from './SplineCurve';

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

@@ -204,6 +204,19 @@ export declare class Scene extends Component {
    */
   get entityOffsetsEnabled(): boolean;
 
+  /**
+   * Whether geometry is readable.
+   *
+   * This is set via the {@link Viewer} constructor and is ````false```` by default.
+   *
+   * The ````readableGeometryEnabled```` option for ````Scene#pick```` only works if this is set ````true````.
+   *
+   * Note that when ````true````, this configuration will increase the amount of browser memory used by the Viewer.
+   *
+   * @returns {Boolean} True if geometry is readable.
+   */
+  get readableGeometryEnabled(): boolean;
+
   /**
    * Whether precision surface picking is enabled.
    *
@@ -226,6 +239,34 @@ export declare class Scene extends Component {
    */
   get logarithmicDepthBufferEnabled(): boolean;
 
+  /**
+   * Sets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   *
+   * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
+   * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
+   * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
+   * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
+   * your expected usage.
+   *
+   * Default is ````0````.
+   */
+  set numCachedSectionPlanes(numCachedSectionPlanes: number);
+
+  /**
+   * Gets the number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   *
+   * This property enhances the efficiency of SectionPlane creation by proactively allocating and caching Viewer resources for a specified quantity
+   * of SectionPlanes. Introducing this parameter streamlines the initial creation speed of SectionPlanes, particularly up to the designated quantity. This parameter internally
+   * configures renderer logic for the specified number of SectionPlanes, eliminating the need for setting up logic with each SectionPlane creation and thereby enhancing
+   * responsiveness. It is important to consider that each SectionPlane impacts rendering performance, so it is recommended to set this value to a quantity that aligns with
+   * your expected usage.
+   *
+   * Default is ````0````.
+   *
+   * @returns {number} The number of {@link SectionPlane}s for which this Scene pre-caches resources.
+   */
+  get numCachedSectionPlanes(): number;
+
   /**
    * Sets whether physically-based rendering is enabled.
    *
@@ -241,6 +282,44 @@ export declare class Scene extends Component {
    */
   get pbrEnabled(): boolean
 
+  /**
+   * Sets whether data texture scene representation (DTX) is enabled for the {@link Scene}.
+   *
+   * Even when enabled, DTX will only work if supported.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  set dtxEnabled(value: boolean);
+
+  /**
+   * Gets whether data texture-based scene representation (DTX) is enabled for the {@link Scene}.
+   *
+   * Even when enabled, DTX will only apply if supported.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get dtxEnabled(): boolean;
+
+  /**
+   * Sets whether basic color texture rendering is enabled.
+   *
+   * Default is ````true````.
+   */
+  set colorTextureEnabled(colorTextureEnabled: boolean);
+
+  /**
+   * Gets whether basic color texture rendering is enabled.
+   *
+   * Default is ````true````.
+   *
+   * @returns {Boolean} True if basic color texture rendering is enabled.
+   */
+  get colorTextureEnabled(): boolean;
+
   /**
    * Gets the Z value of offset for Marker's OcclusionTester.
    * The closest the value is to 0.000 the more precise OcclusionTester will be, but at the same time the less
@@ -668,6 +747,16 @@ export declare class Scene extends Component {
    */
   clearSectionPlanes(): void;
 
+  /**
+   * Destroys all {@link Bitmaps}s in this Scene.
+   */
+  clearBitmaps(): void;
+
+  /**
+   * Destroys all {@link Line}s in this Scene.
+   */
+  clearLines(): void;
+
   /**
    * Gets the collective axis-aligned boundary (AABB) of a batch of {@link Entity}s that represent objects.
    *
@@ -822,6 +911,19 @@ export declare class Scene extends Component {
    */
   withObjects(ids: string[], callback: Function): boolean;
 
+  /**
+   * This method will "tickify" the provided `cb` function.
+   *
+   * This means, the function will be wrapped so:
+   *
+   * - it runs time-aligned to scene ticks
+   * - it runs maximum once per scene-tick
+   *
+   * @param {Function} cb The function to tickify
+   * @returns {Function}
+   */
+  tickify<T extends (...args: any[]) => any>(cb: T): (...args: Parameters<T>) => void;
+
   /**
    * Destroys this Scene.
    */

package/types/viewer/scene/sectionPlane/SectionPlane.d.ts

@@ -58,6 +58,42 @@ export declare class SectionPlane extends Component {
    */
   get pos(): number[];
 
+  /**
+   * Sets the quaternion of this SectionPlane's plane.
+   *
+   * Default value is ````[0, -1, 0, 0]````.
+   *
+   * @param {Number[]} value New quaternion.
+   */
+  set quaternion(value: number[]);
+
+  /**
+   * Gets the quaternion of this SectionPlane's plane.
+   *
+   * Default value is ````[0, -1, 0, 0]````.
+   *
+   * @returns {Number[]} value Current quaternion.
+   */
+  get quaternion(): number[];
+
+  /**
+   * Sets the roll of this SectionPlane's plane.
+   *
+   * Default value is ````0````.
+   *
+   * @param {Number[]} value New roll.
+   */
+  set roll(value: number[]);
+
+  /**
+   * Gets the roll of this SectionPlane's plane.
+   *
+   * Default value is ````0````.
+   *
+   * @returns {Number[]} value Current roll.
+   */
+  get roll(): number[];
+
   /**
    * Sets the direction of this SectionPlane's plane.
    *
@@ -90,4 +126,9 @@ export declare class SectionPlane extends Component {
    * Inverts the direction of {@link SectionPlane.dir}.
    */
   flipDir(): void;
+
+  /**
+   * @destroy
+   */
+  destroy(): void;
 }

package/types/viewer/scene/skybox/Skybox.d.ts

@@ -0,0 +1,59 @@
+import { Component } from '../Component';
+
+export declare type SkyboxConfiguration = {
+    /** Optional ID, unique among all components in the parent {Scene}, generated automatically when omitted. */
+    id?: string;
+    /** Path to skybox texture */
+    src: string | string[];
+    /** Texture encoding format.  See the {@link Texture#encoding} property for more info. */
+    encoding?: number;
+    /** Size of this Skybox, given as the distance from the center at ````[0,0,0]```` to each face. */
+    size?: number;
+    /** True when this Skybox is visible. */
+    active?: boolean;
+}
+
+export declare class Skybox extends Component {
+    /**
+     * @constructor
+     * @param {Component} owner Owner component. When destroyed, the owner will destroy this PointLight as well.
+     * @param {SkyboxConfiguration} [cfg]  Skybox configuration
+     */
+    constructor(owner: Component, cfg?: SkyboxConfiguration);
+
+    /**
+     * Sets the size of this Skybox, given as the distance from the center at [0,0,0] to each face.
+     *
+     * Default value is ````1000````.
+     *
+     * @param {Number} value The size.
+     */
+    set size(value: number);
+
+    /**
+     * Gets the size of this Skybox, given as the distance from the center at [0,0,0] to each face.
+     *
+     * Default value is ````1000````.
+     *
+     * @returns {Number} The size.
+     */
+    get size(): number;
+
+    /**
+     * Sets whether this Skybox is visible or not.
+     *
+     * Default value is ````true````.
+     *
+     * @param {Boolean} active Whether to make active or not.
+     */
+    set active(active: boolean);
+
+    /**
+     * Gets if this Skybox is visible or not.
+     *
+     * Default active is ````true````.
+     *
+     * @returns {Boolean} ````true```` if the Skybox is active.
+     */
+    get active(): boolean;
+}

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

@@ -0,0 +1 @@
+export * from './Skybox';

package/types/viewer/scene/webgl/PickResult.d.ts

@@ -33,6 +33,12 @@ export declare class PickResult {
    */
   pickSurfacePrecision: boolean;
 
+  /**
+   * True when picked from touch input, else false when from mouse input.
+   * @type {boolean}
+   */
+  touchInput: boolean;
+
   /**
    * Canvas coordinates when picking with a 2D pointer.
    * @property canvasPos
@@ -66,6 +72,13 @@ export declare class PickResult {
    */
   get localPos(): number[];
 
+  /**
+   * Canvas cursor coordinates, snapped when snap picking, otherwise same as {@link PickResult#pointerPos}.
+   * @property snappedCanvasPos
+   * @type {Number[]}
+   */
+  get snappedCanvasPos(): number[];
+
   /**
    * Picked World-space point on surface.
    * Only defined when an entity and a point on its surface was picked.
@@ -101,6 +114,12 @@ export declare class PickResult {
    */
   get uv(): number[];
 
+  /**
+   * True if snapped to edge or vertex.
+   * @returns {boolean}
+   */
+  get snapped(): boolean;
+
   /**
    * True when snapped to the nearest vertex position.
    * @type {boolean}