@pilotdev/pilot-web-3d 26.1.0 → 26.3.0

package/index.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="@types/three" />
 declare namespace PilotWeb3D {
+export interface IObject3D<TEventMap extends THREE.Object3DEventMap = THREE.Object3DEventMap> extends THREE.Object3D<TEventMap> {
+}
 export enum UpdateType {
     /**No changes */
     None = 0,
@@ -52,7 +54,70 @@ export interface ViewObjectEventMap extends THREE.Object3DEventMap {
         updateType: UpdateType;
     };
 }
-export abstract class ViewObject extends THREE.Object3D<ViewObjectEventMap> {
+export interface IViewObject extends THREE.Object3D<ViewObjectEventMap> {
+    /**
+     * constant flag to check if a given object is {@link IViewObject}.
+     * @defaultValue `true`
+     */
+    readonly isViewObject: boolean;
+    /**
+     * model element entity guid
+     * @default zeroGuid
+     */
+    readonly entityGuid: string;
+    /**
+     * model part guid
+     * @default zeroGuid
+     */
+    readonly modelGuid: string;
+    /**Mesh representation of the object */
+    get mesh(): THREE.Mesh | null;
+    /**Edge representation of the object */
+    get edges(): THREE.LineSegments | null;
+    /**Set visibility of this object */
+    setVisible(value: boolean): void;
+    /**Get visibility of this object */
+    isVisible(): boolean;
+    /**Hide this object from the scene */
+    setHidden(iVal: boolean): void;
+    /**Check if object is hidden from the scene */
+    isHidden(): boolean;
+    /**Select this object */
+    setSelected(value: boolean): void;
+    /**Check if object is selected */
+    isSelected(): boolean;
+    /**Hover this object */
+    setHovered(value: boolean): void;
+    /**Check if object is hovered */
+    isHovered(): boolean;
+    /**Set color for this object */
+    setColor(color: Color): void;
+    /**Get color of this object */
+    getColor(): Color;
+    /**Reset color to original color for this object */
+    resetColor(): void;
+    /**Gets original color for this object */
+    getOriginalColor(): Color;
+    /**Check if object is in ghost mode */
+    isGhosted(): boolean;
+    /**Set ghost mode for this object */
+    setGhosted(value: boolean): void;
+    /**Get local matrix of this object */
+    getMatrix(target: THREE.Matrix4): THREE.Matrix4;
+    /**Set local matrix of this object */
+    setMatrix(source: THREE.Matrix4): void;
+    /**Get world matrix of this object */
+    getMatrixWorld(target: THREE.Matrix4): THREE.Matrix4;
+    /**Set world matrix of this object */
+    setMatrixWorld(source: THREE.Matrix4): void;
+    /**Dispose geometry */
+    dispose(): void;
+    /**User defined bounding box calculation for this object. Returns an empty THREE.Box3 by default.*/
+    getBoundingBox(): THREE.Box3;
+    /**User defined raycast implementation for this object. Empty method by default. */
+    raycast(iRaycaster: THREE.Raycaster, oIntersects: THREE.Intersection[]): void;
+}
+export abstract class ViewObject extends THREE.Object3D<ViewObjectEventMap> implements IViewObject {
     protected _isDisposed: boolean;
     protected _isSelected: boolean;
     protected _isHovered: boolean;
@@ -62,6 +127,7 @@ export abstract class ViewObject extends THREE.Object3D<ViewObjectEventMap> {
     protected _isGhosted: boolean;
     protected _originalColor: Color;
     protected _color: Color;
+    readonly isViewObject: boolean;
     /**
      * model element entity guid
      * @default zeroGuid
@@ -121,6 +187,14 @@ export abstract class ViewObject extends THREE.Object3D<ViewObjectEventMap> {
     resetColor(): void;
     /**Gets original color for this object */
     getOriginalColor(): Color;
+    /**Get local matrix of this object */
+    getMatrix(target: THREE.Matrix4): THREE.Matrix4;
+    /**Set local matrix of this object */
+    setMatrix(source: THREE.Matrix4): void;
+    /**Get world matrix of this object */
+    getMatrixWorld(target: THREE.Matrix4): THREE.Matrix4;
+    /**Set world matrix of this object */
+    setMatrixWorld(source: THREE.Matrix4): void;
     /**Dispose geometry */
     dispose(): void;
     /**User defined bounding box calculation for this object. Returns an empty THREE.Box3 by default.*/
@@ -368,6 +442,7 @@ export const defaultToolbarAppearance: ToolbarStyle;
 export interface IMenu {
     controls: IControl[];
     addControl(control: IControl, index?: number): void;
+    addControls(controls: IControl[], index?: number): void;
     removeControl(index: number): void;
 }
 export class Separator extends Control {
@@ -422,6 +497,7 @@ export class ContextMenu implements IMenu {
     get menuWrapper(): HTMLElement;
     setEnabled(index: number, value: boolean): void;
     addControl(control: IControl, index?: number): void;
+    addControls(controls: IControl[], index?: number): void;
     removeControl(index?: number): void;
     clearList(): void;
     changeControl(item: IControl, index: number): void;
@@ -449,6 +525,7 @@ export class Toolbar extends Control implements IMenu, IToolbar {
     /** @deprecated */
     readonly controls: IControl[];
     addControl(control: IControl, index?: number): IToolbarButton;
+    addControls(controls: IControl[], index?: number): IToolbarButton[];
     removeControl(index: number): void;
     getControls(): IToolbarButton[];
     changeToolbarPosition(direction: ToolbarPosition): void;
@@ -763,15 +840,19 @@ export class HoverEvent extends Event {
 export class RenderViewSettings {
     telemetry?: boolean;
     hideEdgesWhenNavigation?: boolean;
+    lightSources?: boolean;
     antiAliasing?: boolean;
     displayMode?: DisplayMode;
     cameraMode?: CameraMode;
     orthoNavigationCube?: boolean;
+    cameraAnimation?: boolean;
     hideSmallElements?: boolean;
     smallObjectSize?: number;
     frustumCulling?: boolean;
     limitedMemory?: boolean;
     memoryLimitValue?: number;
+    pointCloudBudget?: boolean;
+    pointCloudBudgetValue?: number;
     /** Desired render framerate */
     desiredFramerate?: number;
     /** Allocated time for rendering operations, excluding scene rendering */
@@ -1041,7 +1122,7 @@ export interface ModelElement {
     get name(): string;
     get children(): ModelElement[];
     get hasGeometry(): boolean;
-    get viewObject(): ViewObject | undefined;
+    get viewObject(): IViewObject | undefined;
 }
 export interface ModelElementTree {
     /**
@@ -1091,6 +1172,178 @@ export interface ModelElementTree {
      */
     getChildLevelNumber(element: string | ModelElement): number;
 }
+export abstract class BufferedData {
+    protected static _offsetBegin: number;
+    protected static _offsetEnd: number;
+    protected static allocateBuffer(count: number, itemByteLength: number): ArrayBuffer;
+    static registerBufferedObjects: (buffer: ArrayBuffer) => void;
+    static unregisterBufferedObjects: (buffer: ArrayBuffer) => void;
+    protected _view: DataView;
+    protected _float64: Float64Array;
+    private get bufferReferencesCount();
+    private set bufferReferencesCount(value);
+    setBuffer(buffer: ArrayBuffer, offset: number): void;
+    dispose(): void;
+}
+export class MatrixUtils {
+    static setIdentity(te: Float64Array, tBegin: number): void;
+    static copy(te: Float64Array, tBegin: number, se: Float64Array, sBegin: number): void;
+    static copyToMatrix4(target: THREE.Matrix4, se: Float64Array, sBegin: number): void;
+    static copyFromMatrix4(te: Float64Array, tBegin: number, source: THREE.Matrix4): void;
+    static equals(ae: Float64Array, aBegin: number, be: Float64Array, bBegin: number): boolean;
+    static multiplyBBB(te: Float64Array, tBegin: number, ae: Float64Array, aBegin: number, be: Float64Array, bBegin: number): void;
+    static multiplyBMB(te: Float64Array, tBegin: number, a: THREE.Matrix4, be: Float64Array, bBegin: number): void;
+    static premultiply(te: Float64Array, tBegin: number, m: THREE.Matrix4): void;
+}
+export class CommonEventDispatcher<TEventMap extends THREE.Object3DEventMap = THREE.Object3DEventMap> {
+    addEventListener(type: string, listener: Function): void;
+    hasEventListener(type: string, listener: Function): boolean;
+    removeEventListener(type: string, listener: Function): void;
+    dispatchTargetedEvent(event: any): void;
+}
+class UserEventDispatcher<TEventMap extends THREE.Object3DEventMap = THREE.Object3DEventMap> {
+    addEventListener(type: string, listener: Function): void;
+    hasEventListener(type: string, listener: Function): boolean;
+    removeEventListener(type: string, listener: Function): void;
+    dispatchTargetedEvent(event: any): void;
+    isEmpty(): boolean;
+}
+export const enum BufferedObject3DFlag {
+    matrixWorldAutoUpdate = 0,
+    matrixWorldNeedsUpdate = 1,
+    visible = 2,
+    castShadow = 3,
+    receiveShadow = 4,
+    frustumCulled = 5,
+    END = 6
+}
+export abstract class BufferedObject3D<TEventMap extends THREE.Object3DEventMap = THREE.Object3DEventMap> extends BufferedData implements IObject3D<TEventMap> {
+    protected static _offsetBegin: number;
+    protected static _offsetFlags: number;
+    protected static _offsetId: number;
+    protected static _offsetMatrix: number;
+    protected static _offsetMatrixWorld: number;
+    protected static _offsetRenderOrder: number;
+    protected static _offsetEnd: number;
+    protected setBit(bit: number, value: boolean): void;
+    protected getBit(bit: number): boolean;
+    protected _commonEventDispatcher: CommonEventDispatcher<TEventMap>;
+    protected _userEventDispatcher: UserEventDispatcher<TEventMap>;
+    isObject3D: true;
+    parent: IObject3D | null;
+    children: IObject3D[];
+    type: string;
+    uuid: string;
+    userData: Record<string, any>;
+    get isBufferedObject3D(): boolean;
+    get matrixWorldAutoUpdate(): boolean;
+    set matrixWorldAutoUpdate(value: boolean);
+    get matrixWorldNeedsUpdate(): boolean;
+    set matrixWorldNeedsUpdate(value: boolean);
+    get visible(): boolean;
+    set visible(value: boolean);
+    get castShadow(): boolean;
+    set castShadow(value: boolean);
+    get receiveShadow(): boolean;
+    set receiveShadow(value: boolean);
+    get frustumCulled(): boolean;
+    set frustumCulled(value: boolean);
+    get id(): number;
+    set id(value: number);
+    get renderOrder(): number;
+    set renderOrder(value: number);
+    error(methodName: string, className?: string, msg?: string): null;
+    warning(methodName: string, className?: string, msg?: string): null;
+    static getMatrixWorld(target: THREE.Matrix4, obj: THREE.Object3D): THREE.Matrix4;
+    static getMatrix(target: THREE.Matrix4, obj: THREE.Object3D): THREE.Matrix4;
+    getMatrix(target: THREE.Matrix4): THREE.Matrix4;
+    setMatrix(source: THREE.Matrix4): void;
+    getMatrixWorld(target: THREE.Matrix4): THREE.Matrix4;
+    setMatrixWorld(source: THREE.Matrix4): void;
+    get matrix(): THREE.Matrix4;
+    set matrix(value: THREE.Matrix4);
+    get matrixWorld(): THREE.Matrix4;
+    set matrixWorld(value: THREE.Matrix4);
+    get matrixAutoUpdate(): boolean;
+    set matrixAutoUpdate(value: boolean);
+    get name(): string;
+    set name(value: string);
+    get layers(): THREE.Layers;
+    set layers(value: THREE.Layers);
+    get animations(): THREE.AnimationClip[];
+    set animations(value: THREE.AnimationClip[]);
+    get customDepthMaterial(): THREE.Material | undefined;
+    set customDepthMaterial(value: THREE.Material | undefined);
+    get customDistanceMaterial(): THREE.Material | undefined;
+    set customDistanceMaterial(value: THREE.Material | undefined);
+    get modelViewMatrix(): THREE.Matrix4;
+    set modelViewMatrix(value: THREE.Matrix4);
+    get normalMatrix(): THREE.Matrix3;
+    set normalMatrix(value: THREE.Matrix3);
+    get up(): THREE.Vector3;
+    set up(value: THREE.Vector3);
+    get position(): THREE.Vector3;
+    set position(value: THREE.Vector3);
+    get rotation(): THREE.Euler;
+    set rotation(value: THREE.Euler);
+    get quaternion(): THREE.Quaternion;
+    set quaternion(value: THREE.Quaternion);
+    get scale(): THREE.Vector3;
+    set scale(value: THREE.Vector3);
+    setCommonEventDispatcher(eventDispatcher: CommonEventDispatcher<TEventMap>): void;
+    addEventListener(type: any, listener: any): void;
+    hasEventListener(type: any, listener: any): boolean;
+    removeEventListener(type: any, listener: any): void;
+    dispatchEvent(event: any): void;
+    onBeforeShadow(): void;
+    onAfterShadow(): void;
+    onBeforeRender(): void;
+    onAfterRender(): void;
+    applyMatrix4(matrix: THREE.Matrix4): void;
+    applyQuaternion(q: THREE.Quaternion): this;
+    setRotationFromAxisAngle(axis: THREE.Vector3, angle: number): void;
+    setRotationFromEuler(euler: THREE.Euler): void;
+    setRotationFromMatrix(m: THREE.Matrix4): void;
+    setRotationFromQuaternion(q: THREE.Quaternion): void;
+    rotateOnAxis(axis: THREE.Vector3, angle: number): this;
+    rotateOnWorldAxis(axis: THREE.Vector3, angle: number): this;
+    rotateX(angle: number): this;
+    rotateY(angle: number): this;
+    rotateZ(angle: number): this;
+    translateOnAxis(axis: THREE.Vector3, distance: number): this;
+    translateX(distance: number): this;
+    translateY(distance: number): this;
+    translateZ(distance: number): this;
+    localToWorld(vector: THREE.Vector3): THREE.Vector3;
+    worldToLocal(vector: THREE.Vector3): THREE.Vector3;
+    lookAt(x: number | THREE.Vector3, y?: number, z?: number): void;
+    add(...object: IObject3D[]): this;
+    remove(...object: IObject3D[]): this;
+    removeFromParent(): this;
+    clear(): this;
+    attach(object: IObject3D): this;
+    getObjectById(id: number): IObject3D | undefined;
+    getObjectByName(name: string): IObject3D | undefined;
+    getObjectByProperty(name: string, value: any): IObject3D | undefined;
+    getObjectsByProperty(name: string, value: any, result?: Array<IObject3D>): Array<IObject3D>;
+    getWorldPosition(target: THREE.Vector3): THREE.Vector3;
+    getWorldQuaternion(target: THREE.Quaternion): THREE.Quaternion;
+    getWorldScale(target: THREE.Vector3): THREE.Vector3;
+    getWorldDirection(target: THREE.Vector3): THREE.Vector3;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
+    traverse(callback: (object: IObject3D) => any): void;
+    traverseVisible(callback: (object: IObject3D) => any): void;
+    traverseAncestors(callback: (object: IObject3D) => any): void;
+    updateMatrix(): void;
+    updateMatrixWorld(force?: boolean): void;
+    updateMatrixWorldWithCheck(force?: boolean): boolean;
+    updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void;
+    updateWorldMatrixWithCheck(updateParents: boolean, updateChildren: boolean): boolean;
+    toJSON(meta: any): any;
+    clone(recursive?: boolean): this;
+    copy(source: this, recursive?: boolean): this;
+}
+export {};
 export class TPair<TKey, TValue> {
     
     constructor(key: TKey, value: TValue);
@@ -1291,6 +1544,120 @@ export class CloudPointMaterial extends CustomMaterial {
         [uniform: string]: THREE.IUniform;
     }, material: CustomMaterial, renderer: THREE.WebGLRenderer): void;
 }
+export const enum BufferedViewObjectFlag {
+    isDisposed = 6,
+    isSelected = 7,
+    isHovered = 8,
+    isVisible = 9,
+    isHidden = 10,
+    isDecomposed = 11,
+    isGhosted = 12,
+    END = 13
+}
+export abstract class BufferedViewObject extends BufferedObject3D<ViewObjectEventMap> implements IViewObject {
+    protected static _offsetBegin: number;
+    protected static _offsetOriginalColor: number;
+    protected static _offsetColor: number;
+    protected static _offsetEnd: number;
+    /**
+     * model element entity guid
+     * @default zeroGuid
+    */
+    readonly entityGuid: string;
+    /**
+     * model part guid
+     * @default zeroGuid
+     */
+    readonly modelGuid: string;
+    get isViewObject(): boolean;
+    protected get _isDisposed(): boolean;
+    protected set _isDisposed(value: boolean);
+    protected get _isSelected(): boolean;
+    protected set _isSelected(value: boolean);
+    protected get _isHovered(): boolean;
+    protected set _isHovered(value: boolean);
+    protected get _isVisible(): boolean;
+    protected set _isVisible(value: boolean);
+    protected get _isHidden(): boolean;
+    protected set _isHidden(value: boolean);
+    protected get _isDecomposed(): boolean;
+    protected set _isDecomposed(value: boolean);
+    protected get _isGhosted(): boolean;
+    protected set _isGhosted(value: boolean);
+    protected get _originalColor(): Color;
+    protected set _originalColor(value: Color);
+    protected get _color(): Color;
+    protected set _color(value: Color);
+    /**Mesh representation of the object */
+    abstract get mesh(): THREE.Mesh | null;
+    /**Edge representation of the object */
+    abstract get edges(): THREE.LineSegments | null;
+    add(...object: THREE.Object3D[]): this;
+    remove(...object: THREE.Object3D[]): this;
+    updateMatrixWorld(force?: boolean): void;
+    updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void;
+    updateMatrix(): void;
+    applyMatrix4(matrix: THREE.Matrix4): void;
+    /** Decompose object matrix to position, rotation and scale vectors or free these vectors to reduce memory consumption. */
+    setDecomposed(value: boolean): void;
+    /**Check if object is decomposed: have valid position, quaternion, scale, up vectors */
+    isDecomposed(): boolean;
+    /**Set visibility of this object */
+    setVisible(value: boolean): void;
+    /**Get visibility of this object */
+    isVisible(): boolean;
+    /**Hide this object from the scene */
+    setHidden(iVal: boolean): void;
+    /**Check if object is hidden from the scene */
+    isHidden(): boolean;
+    /**Select this object */
+    setSelected(value: boolean): void;
+    /**Check if object is selected */
+    isSelected(): boolean;
+    /**Hover this object */
+    setHovered(value: boolean): void;
+    /**Check if object is hovered */
+    isHovered(): boolean;
+    /**Set color for this object */
+    setColor(color: Color): void;
+    /**Get color of this object */
+    getColor(): Color;
+    /**Check if object is in ghost mode */
+    isGhosted(): boolean;
+    /**Set ghost mode for this object */
+    setGhosted(value: boolean): void;
+    /**Reset color to original color for this object */
+    resetColor(): void;
+    /**Gets original color for this object */
+    getOriginalColor(): Color;
+    /**Dispose geometry */
+    dispose(): void;
+    /**User defined bounding box calculation for this object. Returns an empty THREE.Box3 by default.*/
+    getBoundingBox(): THREE.Box3;
+    /**User defined raycast implementation for this object. Empty method by default. */
+    raycast(iRaycaster: THREE.Raycaster, oIntersects: THREE.Intersection[]): void;
+    /**User defined hover behavior for this object. Empty method by default. */
+    protected setHoveredForObject(value: boolean): void;
+    /**User defined selection behavior for this object. Empty method by default. */
+    protected setSelectedForObject(value: boolean): void;
+    /**User defined hide behavior for this object. Has default implementation used on the MainScene only. */
+    protected setHiddenForObject(iVal: boolean): void;
+    /**User defined visibility behavior for this object. Sets THREE.Object3D visibility by default. */
+    protected setVisibleForObject(value: boolean): void;
+    /**User defined change color behavior for this object. Empty method by default. */
+    protected setColorForObject(color: Color): void;
+    /**User defined ghost mode behavior for this object. Empty method by default. */
+    protected setGhostModeForObject(value: boolean): void;
+    /**Reset color to the original color for this object. */
+    protected resetColorForObject(): void;
+    /**
+     * Notifies subscribers about changes in {@link object}.
+     * @param updateType type of changes to be reported.
+     * @param object (optional) object to be reported about. This object by default.
+     */
+    protected riseOnUpdated(updateType?: UpdateType, object?: THREE.Object3D): void;
+    getRelativePosition(absPosition: THREE.Vector3): THREE.Vector3;
+}
 export interface IBatchedMaterial extends CustomMaterial {
     textureSize: number;
     blockPosTexture: THREE.DataTexture;
@@ -2037,7 +2404,7 @@ export interface ModelPart {
     getModelPartPlacement(): THREE.Matrix4;
     setModelPartPlacement(placement: THREE.Matrix4Tuple | number[]): void;
     setModelPartScaling(scaling: number): void;
-    getViewObject(): ViewObject;
+    getViewObject(): IViewObject;
     getVirtualOrigin(): THREE.Vector3;
     dispose(): void;
 }
@@ -3315,6 +3682,8 @@ export class SettingsNames {
     static SHOW_SPACE_ELEMENTS: string;
     static SHOW_VOID_ELEMENTS: string;
     static SHOW_HIDDEN_ELEMENTS: string;
+    static POINT_CLOUD_BUDGET: string;
+    static POINT_CLOUD_BUDGET_VALUE: string;
 }
 export enum ValueType {
     STRING = 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "26.1.0",
+  "version": "26.3.0",
   "description": "TypeScript definitions for ASCON PilotWeb3D component",
   "main": "",
   "types": "index.d.ts",