@pilotdev/pilot-web-3d 25.6.0 → 25.8.3-alpha

package/index.d.ts

@@ -172,7 +172,7 @@ export type StringMap = {
 };
 export class Localization {
     static initialize(options: any): Promise<void>;
-    static translate<T extends (string | StringMap) = string>(stringToTrans: string): T;
+    static translate<T extends (string | StringMap) = string>(stringToTrans: string, options?: {}): T;
     static setLanguage(language: string): Promise<void>;
     static extendLocalization(locales: any): boolean;
     static numberToStr(value: number, digitsAfterPoint?: number): string;
@@ -238,6 +238,7 @@ export namespace Viewer3DIcons {
     const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
     const VIEWER_ZOOM_TO_FIT_ICON: string;
     const VIEWER_RENDER_OPTIONS_ICON: string;
+    const VIEWER_CONTEXT_MENU_COPY_PROPS: string;
 }
 export namespace ViewerGeneralIcons {
     const CLOSE: string;
@@ -275,7 +276,14 @@ export class SettingChangedEvent extends Event {
     newValue: any;
     providedData: any;
 }
+export class ProgressBar {
+    start(): void;
+    stop(): void;
+    setDeterminate(value: boolean): void;
+    setProgress(value: number): void;
+}
 export class LoadingSpinner {
+    protected readonly _progress: ProgressBar;
     set loadingTextKey(value: string);
     get loadingTextKey(): string;
     addToDOM(container: HTMLElement): void;
@@ -317,6 +325,11 @@ export interface IControl {
     setState(state: ControlState.State): void;
     getState(): ControlState.State;
 }
+export class Tooltip {
+    setTooltip(hint: string): HTMLElement;
+    setDisabled(value: boolean): void;
+    hide(): void;
+}
 export class Control implements IControl {
     protected _tooltip: Tooltip;
     container: HTMLElement;
@@ -386,6 +399,7 @@ export class ExtensionBase {
     onMouseUp(event: MouseEvent): void;
     onMouseLongTouch(event: MouseEvent): void;
     onToolbarCreated(toolbar: Toolbar): void;
+    onContextMenu(menu: IMenu): void;
     onTouchStart(event: TouchEvent): void;
     onTouchEnd(event: TouchEvent): void;
 }
@@ -498,6 +512,11 @@ export class EventsDispatcherCore implements IEventsDispatcher {
     removeEvent(type: string): void;
     clearListeners(): void;
 }
+export interface IMenuBuilder {
+    build(): IControl[];
+    removeAllButtons(): IMenuBuilder;
+    withButton(controlId: string, icon: string, translationKey: string, command: () => void): IMenuBuilder;
+}
 export class Button extends Control {
     
     constructor(id: string);
@@ -508,6 +527,7 @@ export class Button extends Control {
     getIsChecked(): boolean;
     setIcon(iconClassName: string): void;
     setFromSvgTemlate(template: string): void;
+    withoutIcon(): void;
     /**
      * Override this method to be notified when the user clicks on the button.
      * @param {MouseEvent} event
@@ -530,10 +550,15 @@ export namespace Button {
         CLICK = "click"
     }
 }
-export class SubMenu implements IMenu {
+export class ContextMenu implements IMenu {
     readonly controls: IControl[];
     set selectedIndex(value: number | number[]);
     get selectedIndex(): number | number[];
+    set opened(value: boolean);
+    get opened(): boolean;
+    set textStubKey(value: string);
+    get textStubKey(): string;
+    get menuWrapper(): HTMLElement;
     setEnabled(index: number, value: boolean): void;
     addControl(control: IControl, index?: number): void;
     removeControl(index?: number): void;
@@ -544,7 +569,7 @@ export class SubMenu implements IMenu {
 export class ComboButton extends Control {
     
     constructor(id: string, selectedIndex?: number);
-    get subMenu(): SubMenu;
+    get subMenu(): ContextMenu;
     /**
      * Override this method to be notified when the user clicks on the button.
      * @param {MouseEvent} event
@@ -612,6 +637,7 @@ export class Dialog extends Control implements ICloseable {
     setSvgIcon(template: string): Dialog;
     setFooter(value: HTMLElement): Dialog;
     setDialogElementClassNames(value: ElementClass): Dialog;
+    setSize(width: number, height: number): Dialog;
     setResizable(value: boolean): Dialog;
     setWindowOptions(value: IWindowStateOptions): Dialog;
     setDraggable(value: boolean): Dialog;
@@ -659,6 +685,9 @@ export function createSvgElement(svgString: string): HTMLElement;
 export function isString(element: any): boolean;
 export function isSvg(element: string): boolean;
 export function isSvgString(element: any): boolean;
+export class GlobalEvents {
+    static events: EventsDispatcherCore;
+}
 export const MouseButtons: {
     Left: number;
     Middle: number;
@@ -671,6 +700,17 @@ export class RenderEventTypes {
     static RENDER_HOVER_EVENT: string;
     static RENDER_DOUBLE_CLICK_EVENT: string;
     static RENDER_SELECTION_RESET_EVENT: string;
+    static RENDER_RIGHT_CLICK_WITHOUT_MOVEMENT: string;
+    static RENDER_UPDATE_CANVAS: string;
+}
+export class RightClickEvent extends Event {
+    modelId: string;
+    modelElementId: string;
+    ctrlKey: boolean;
+    intersection?: THREE.Intersection;
+    offsetX: number;
+    offsetY: number;
+    customTarget: HTMLElement;
 }
 export class SelectionChangedEvent extends Event {
     selectedIds: ModelElementIds[];
@@ -692,9 +732,6 @@ export class HoverEvent extends Event {
     
     constructor(type: string, modelId: string, modelElementId: string, intersection?: THREE.Intersection);
 }
-export class GlobalEvents {
-    static events: EventsDispatcherCore;
-}
 export class RenderViewSettings {
     telemetry?: boolean;
     hideEdgesWhenNavigation?: boolean;
@@ -705,6 +742,7 @@ export class RenderViewSettings {
     hideSmallElements?: boolean;
     smallObjectSize?: number;
     frustumCulling?: boolean;
+    limitedMemory?: boolean;
     /** Desired render framerate */
     desiredFramerate?: number;
     /** Allocated time for rendering operations, excluding scene rendering */
@@ -873,6 +911,8 @@ export class EventTypes extends CoreEventTypes {
     static RENDER_CLICK_EVENT: string;
     static RENDER_HOVER_EVENT: string;
     static RENDER_DOUBLE_CLICK_EVENT: string;
+    static RENDER_RIGHT_CLICK_WITHOUT_MOVEMENT: string;
+    static RENDER_UPDATE_CANVAS: string;
 }
 export class ModelPartEvent extends Event {
     modelPartId: string;
@@ -900,16 +940,75 @@ export class VisibilityChangedEvent extends Event {
 export class DeleteEvent extends Event {
     deletedIds: ModelElementIds[];
 }
+export class UpdateCanvasEvent extends Event {
+}
 
 export enum SelectionMode {
     Append = 0,
     Replace = 1
 }
+export class ElementNode {
+    Guid: string;
+    ObjectState: IfcNodeState;
+    Revision: bigint;
+    ParentGuid: string;
+    Name: string;
+    Type: string;
+    RepresentationType: string;
+    RepresentationTypeEnum: IfcType[];
+    RepresentationStatus: string;
+    RepresentationStatusFlag: IfcRepresentationStatus;
+    GridObject: GridObject;
+    MeshesProperties: Map<string, MeshProperty[]>;
+}
+export enum IfcNodeState {
+    Undefined = 0,
+    Added = 1,
+    Removed = 2,
+    AttributesModified = 3,
+    AttributesQuantitiesModified = 4,
+    PlacementModified = 8,
+    PlacementAndAttributesModified = 11,
+    PlacementAndAttributesQuantitiesModified = 12
+}
+export enum IfcRepresentationStatus {
+    SUCCESS = 0,
+    NO_REPRESENTATION = 1,
+    IGNORED_IFC_TYPE = 2,
+    IFC_PARSING_ERROR = 4,
+    SOLID_CREATION_ERROR = 8,
+    TESSELATING_ERROR = 16,
+    C3D_EXEPTION = 32,
+    UNCLOSED_SOLID = 64
+}
+export class MeshProperty {
+    meshColor: number;
+    meshPlacement: Float64Array;
+}
+export class GridObject {
+    gridPlacement: Float64Array;
+    gridAxes: GridAxis[];
+}
+export class GridAxis {
+    id: number;
+    type: AxisType;
+    label: string;
+    data: Float32Array;
+}
+export enum AxisType {
+    LINE = 0,
+    CIRCLE = 1,
+    ARC = 2
+}
 export interface ModelElement {
     get id(): string;
     get modelPartId(): string;
     get parent(): ModelElement | undefined;
     get type(): string;
+    get representationType(): string | undefined;
+    get representationTypeEnum(): IfcType[] | undefined;
+    get representationStatus(): string | undefined;
+    get representationStatusFlag(): IfcRepresentationStatus | undefined;
     get name(): string;
     get children(): ModelElement[];
     get hasGeometry(): boolean;
@@ -936,7 +1035,7 @@ export interface ModelElementTree {
     /**
      * Gets model element by id
      * @param { string } id - model element id
-     * @returns model element;
+     * @returns model element
      */
     getElement(id: string): ModelElement | undefined;
     /**
@@ -945,6 +1044,11 @@ export interface ModelElementTree {
      * @returns {boolean}
      */
     isViewableElement(element: string | ModelElement): boolean;
+    /**
+     * Gets detached elements of the model part
+     * @returns array of the detached elements
+     */
+    getDetachedElements(): ModelElement[];
     /**
      * Checks given element is detached from the root element
      * @param {string|ModelElement} element - element id or element instance
@@ -1228,6 +1332,89 @@ export type MemoryInfo = {
     bBoxes: number;
     memory: number;
 };
+export interface MeshPointMaterialParameters extends THREE.ShaderMaterialParameters {
+    sizeAttenuation?: boolean | undefined;
+    discreteClipping?: boolean | undefined;
+}
+export class MeshPointMaterial extends CustomMaterial {
+    
+    constructor(parameters?: MeshPointMaterialParameters);
+    /**
+     * @default true
+     */
+    get discreteClipping(): boolean;
+    set discreteClipping(value: boolean);
+    get resolution(): THREE.Vector2;
+    /**
+     * @default true
+     */
+    sizeAttenuation: boolean;
+    copy(source: MeshPointMaterial): this;
+    protected refreshUniforms(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: CustomMaterial, renderer: THREE.WebGLRenderer): void;
+}
+export interface MeshPointParamter {
+    point?: THREE.Vector3;
+    color?: Color;
+    size?: number;
+}
+export class MeshPoints extends THREE.Mesh<THREE.InstancedBufferGeometry, MeshPointMaterial, ViewObjectEventMap> {
+    geometry: THREE.InstancedBufferGeometry;
+    material: MeshPointMaterial;
+    
+    constructor();
+    /**
+    * @default new Color( 1,1,1,1 )
+    */
+    color: Color;
+    /**
+   * @default 1
+   */
+    pointSize: number;
+    /**
+   * @default new THREE.Vector3(0, 0, 0)
+   */
+    point: THREE.Vector3;
+    addPoint(pointParameter?: MeshPointParamter): number;
+    updatePoint(index: number, pointParameter: MeshPointParamter): void;
+    removePoint(index: number): this;
+    updateAttributes(): void;
+    dispose(): void;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
+}
+export class MeshLineGeometry extends THREE.InstancedBufferGeometry {
+    type: string;
+    instanceStart: THREE.BufferAttribute;
+    instanceEnd: THREE.BufferAttribute;
+    instanceColorStart: THREE.BufferAttribute;
+    instanceColorEnd: THREE.BufferAttribute;
+    
+    constructor();
+    applyMatrix4(matrix: THREE.Matrix4): this;
+    updatePoint(index: number, point: THREE.Vector3): void;
+    updateColor(index: number, color: Color): void;
+    setPoints(points: THREE.Vector3[]): this;
+    setPositions(array: ArrayLike<number>): this;
+    setColors(array: ArrayLike<number>): this;
+    computeLineDistances(): this;
+    toBufferGeometry(): THREE.BufferGeometry;
+    toWireframeGeometry(): THREE.WireframeGeometry;
+    fromWireframeGeometry(geometry: THREE.WireframeGeometry): this;
+    fromEdgesGeometry(geometry: THREE.EdgesGeometry): this;
+    fromMesh(mesh: THREE.Mesh): this;
+    fromLineSegments(lineSegments: THREE.LineSegments): this;
+    computeBoundingBox(): void;
+    computeBoundingSphere(): void;
+}
+export class MeshLine extends THREE.Mesh<MeshLineGeometry, MeshLineMaterial, ViewObjectEventMap> {
+    type: string;
+    material: MeshLineMaterial;
+    geometry: MeshLineGeometry;
+    
+    constructor(geometry?: MeshLineGeometry, material?: MeshLineMaterial);
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
+}
 export interface SceneCheckOptions {
     /** specify whether intersections should be filtered by clippings */
     filterByClipping?: boolean;
@@ -1740,38 +1927,6 @@ export class CustomSpriteMaterial extends CustomMaterial {
         [uniform: string]: THREE.IUniform;
     }, material: CustomMaterial, renderer: THREE.WebGLRenderer): void;
 }
-export class MeshLineGeometry extends THREE.InstancedBufferGeometry {
-    type: string;
-    instanceStart: THREE.BufferAttribute;
-    instanceEnd: THREE.BufferAttribute;
-    instanceColorStart: THREE.BufferAttribute;
-    instanceColorEnd: THREE.BufferAttribute;
-    
-    constructor();
-    applyMatrix4(matrix: THREE.Matrix4): this;
-    updatePoint(index: number, point: THREE.Vector3): void;
-    updateColor(index: number, color: Color): void;
-    setPoints(points: THREE.Vector3[]): this;
-    setPositions(array: ArrayLike<number>): this;
-    setColors(array: ArrayLike<number>): this;
-    computeLineDistances(): this;
-    toBufferGeometry(): THREE.BufferGeometry;
-    toWireframeGeometry(): THREE.WireframeGeometry;
-    fromWireframeGeometry(geometry: THREE.WireframeGeometry): this;
-    fromEdgesGeometry(geometry: THREE.EdgesGeometry): this;
-    fromMesh(mesh: THREE.Mesh): this;
-    fromLineSegments(lineSegments: THREE.LineSegments): this;
-    computeBoundingBox(): void;
-    computeBoundingSphere(): void;
-}
-export class MeshLine extends THREE.Mesh<MeshLineGeometry, MeshLineMaterial, ViewObjectEventMap> {
-    type: string;
-    material: MeshLineMaterial;
-    geometry: MeshLineGeometry;
-    
-    constructor(geometry?: MeshLineGeometry, material?: MeshLineMaterial);
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
-}
 export class CustomSprite extends THREE.Sprite {
     material: CustomSpriteMaterial;
     
@@ -1847,57 +2002,6 @@ export class LabelSprite extends CustomSprite {
     dispose(): void;
     rebuildSpriteMaterial(): void;
 }
-export interface MeshPointMaterialParameters extends THREE.ShaderMaterialParameters {
-    sizeAttenuation?: boolean | undefined;
-    discreteClipping?: boolean | undefined;
-}
-export class MeshPointMaterial extends CustomMaterial {
-    
-    constructor(parameters?: MeshPointMaterialParameters);
-    /**
-     * @default true
-     */
-    get discreteClipping(): boolean;
-    set discreteClipping(value: boolean);
-    get resolution(): THREE.Vector2;
-    /**
-     * @default true
-     */
-    sizeAttenuation: boolean;
-    copy(source: MeshPointMaterial): this;
-    protected refreshUniforms(uniforms: {
-        [uniform: string]: THREE.IUniform;
-    }, material: CustomMaterial, renderer: THREE.WebGLRenderer): void;
-}
-export interface MeshPointParamter {
-    point?: THREE.Vector3;
-    color?: Color;
-    size?: number;
-}
-export class MeshPoints extends THREE.Mesh<THREE.InstancedBufferGeometry, MeshPointMaterial, ViewObjectEventMap> {
-    geometry: THREE.InstancedBufferGeometry;
-    material: MeshPointMaterial;
-    
-    constructor();
-    /**
-    * @default new Color( 1,1,1,1 )
-    */
-    color: Color;
-    /**
-   * @default 1
-   */
-    pointSize: number;
-    /**
-   * @default new THREE.Vector3(0, 0, 0)
-   */
-    point: THREE.Vector3;
-    addPoint(pointParameter?: MeshPointParamter): number;
-    updatePoint(index: number, pointParameter: MeshPointParamter): void;
-    removePoint(index: number): this;
-    updateAttributes(): void;
-    dispose(): void;
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
-}
 export interface ModelPart {
     get id(): string;
     get elementTree(): ModelElementTree;
@@ -3164,6 +3268,7 @@ export class SettingsNames {
     static HIDE_SMALL_ELEMENTS: string;
     static SMALL_ELEMENT_SIZE: string;
     static FRUSTUM_CULLING: string;
+    static LIMITED_MEMORY: string;
     static LABEL_LINE_LENGTH: string;
     static HIDE_EDGES_WHEN_NAVIGATING: string;
     static DISPLAY_MODE: string;
@@ -3192,6 +3297,16 @@ export class Viewer3DConfiguration extends ViewerConfiguration {
     constructor(appearance?: ViewerSettings, render?: ViewerSettings);
 }
 export const defaultViewer3DSettings: ViewerSettings;
+export class BimProxyTypes {
+    static BIM_OTHERS_NODE: string;
+    static BIM_OTHER_3D_MODEL_TYPE: string;
+    static BIM_IFC_COLLISION: string;
+    static BIM_POINT_CLOUD: string;
+}
+export class BimOther3DModelNames {
+    static getNameByExtension(extension: string): string | undefined;
+    static typeNameExists(typeName: string): boolean;
+}
 export class ModelLoadingOptions {
     guid: string;
     isConsolidatedModel?: boolean;
@@ -3551,11 +3666,12 @@ export class Viewer3D extends ViewerBase {
      */
     makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
     setThemeFromSettings(): void;
+    protected createUI(): void;
 }
 export class GuiViewer3D extends Viewer3D {
-    loadModelPart(buffer: ArrayBuffer | string | Blob, options: ModelLoadingOptions, onSuccessCallback?: SuccessCallback, onErrorCallback?: ErrorCallback): Promise<void>;
     getToolbar(): ViewerToolbar;
     onPostExtensionLoad(extension: ExtensionBase): void;
+    protected createUI(): void;
     protected getToolbarHeight(): number;
 }
 export function CreateViewer(container: HTMLElement, configuration?: Viewer3DConfiguration): GuiViewer3D;

package/package.json

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