@pilotdev/pilot-web-3d 23.0.3 → 23.0.5

package/index.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="@types/three" />
 declare namespace PilotWeb3D {
+export class Localization {
+    static initialize(options: any): Promise<void>;
+    static translate(stringToTrans: string): string;
+    static setLanguage(language: string): Promise<void>;
+    static extendLocalization(locales: any): boolean;
+}
 export class LoadingSpinner {
     addToDOM(container: HTMLElement): void;
     removeFromDOM(container: HTMLElement): void;
@@ -13,7 +19,7 @@ export const theExtensionManager: ExtensionManager;
 export class ExtensionLoader {
     loadExtension(extensionId: string): Promise<ExtensionBase>;
     unloadExtension(extensionId: string): Promise<boolean>;
-    getExtensions(): ExtensionBase[];
+    getExtensions(): string[];
 }
 export interface ILayerManager {
     createLayer(name: string): ILayer;
@@ -40,10 +46,6 @@ export interface IEventsDispatcher {
     dispatchEventAsync(event: string | Event): void;
     clearListeners(): void;
 }
-export type ViewerSettings = Record<string, any>;
-export class ViewerConfiguration {
-    [key: string]: any;
-}
 export class CoreEventTypes {
     static VIEWER_RESIZE_EVENT: string;
     static VIEWER_MOUSE_DOWN_EVENT: string;
@@ -78,21 +80,54 @@ export class InMemorySettingsStorage implements ISettingsStorage {
     getKeys(): string[];
 }
 export interface ISettings {
-    changeSetting<T>(name: string, value: T, notify?: boolean): void;
+    changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
     getSettingValue<T>(name: string): T;
 }
+
+export class BaseSettingsNames {
+    static TOOLBAR: string;
+    static TOOLBAR_DIRECTION: string;
+    static TOOLBAR_CONTENT: string;
+}
 export class SettingChangedEvent extends Event {
     name: string;
     oldValue: any;
     newValue: any;
+    providedData: any;
 }
 export abstract class SettingsBase implements ISettings {
     protected _eventDispatcher: IEventsDispatcher;
     protected _storage: ISettingsStorage;
-    changeSetting<T>(name: string, value: T, notify?: boolean): void;
+    changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
     getSettingValue<T>(name: string): T;
     protected abstract getKeyWithPrefix(key: string): string;
 }
+export enum ToolbarDirection {
+    TOP_FIXED = "ascn-toolbar-direction-fixed-top",
+    TOP_FLUENT = "ascn-toolbar-direction-top",
+    BOTTOM_FIXED = "ascn-toolbar-direction-fixed-bottom",
+    BOTTOM_FLUENT = "ascn-toolbar-direction-bottom"
+}
+export enum ToolbarContent {
+    CENTER = "ascn-toolbar-content-center",
+    START = "ascn-toolbar-content-start",
+    END = "ascn-toolbar-content-end"
+}
+export interface ToolbarOptions {
+    height: number;
+    direction: ToolbarDirection;
+}
+export interface ToolbarStyle {
+    direction?: ToolbarDirection;
+    content?: ToolbarContent;
+}
+export const defaultToolbarAppearance: ToolbarStyle;
+export type ViewerSettings = Record<string, any>;
+export class ViewerConfiguration {
+    settingsPrefix: string;
+    appearance: ViewerSettings;
+    createConfiguration(configuration: ViewerSettings, origin: ViewerSettings): void;
+}
 export type ErrorCallback = (message: string) => void;
 export type SuccessCallback = (modelId: any) => void;
 export enum DocumentType {
@@ -100,16 +135,19 @@ export enum DocumentType {
     DOCUMENT_2D = 1,
     DOCUMENT_3D = 2
 }
+export const defaultBaseSettings: ViewerConfiguration;
 export abstract class ViewerBase {
     protected _clientContainer: HTMLElement;
     protected _loadingSpinner: LoadingSpinner;
     protected _documentType: DocumentType;
     protected _configuration: ViewerConfiguration;
-    container: HTMLElement;
-    layerManagers: Map<number, ILayerManager>;
-    extensionsLoader: ExtensionLoader;
+    readonly container: HTMLElement;
+    readonly layerManagers: Map<number, ILayerManager>;
+    readonly extensionsLoader: ExtensionLoader;
     abstract settings: ISettings;
     abstract events: IEventsDispatcher;
+    get rootContainer(): HTMLElement;
+    getConfiguration(): ViewerConfiguration;
     /**
      *
      * @returns
@@ -133,9 +171,11 @@ export class Control {
 }
 export class Toolbar extends Control {
     
-    constructor(id: string);
+    constructor(id: string, toolbarContainer: HTMLElement, options?: ToolbarStyle);
     addControl(control: Control): void;
     removeControl(id: string): void;
+    changeToolbarPosition(direction: string): void;
+    changeToolbarContent(content: string): void;
 }
 export class ExtensionBase {
     protected _viewer: ViewerBase;
@@ -200,6 +240,7 @@ export class Color {
     toArray(array: Array<number>, offset?: number): Array<number>;
 }
 export abstract class ViewObject extends THREE.Object3D {
+    protected _isDisposed: boolean;
     protected _isSelected: boolean;
     protected _isHovered: boolean;
     protected _isVisible: boolean;
@@ -266,18 +307,297 @@ export abstract class ViewObject extends THREE.Object3D {
      */
     protected riseOnUpdated(updateType?: UpdateType, object?: THREE.Object3D): void;
 }
-export type EventFunction<Data> = ((data: Data) => void) | (() => void);
-export interface IEventListener<Data> {
-    dispose(): void;
+export abstract class CustomMaterial extends THREE.ShaderMaterial {
+    
+    constructor();
+    copy(source: CustomMaterial): this;
+    protected customProgramCacheKeyCallback(): string;
+    protected onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
+    protected onBeforeCompileCallback(shader: THREE.Shader): void;
+    protected refreshTransformUniform(map: THREE.Texture, uniform: THREE.IUniform): void;
+}
+export interface CustomMeshLambertMaterialParameters extends THREE.ShaderMaterialParameters, THREE.MeshLambertMaterialParameters {
+    instancing?: boolean | undefined;
+}
+export class CustomMeshLambertMaterial extends CustomMaterial {
+    type: string;
+    
+    constructor(parameters?: CustomMeshLambertMaterialParameters);
+    /**
+     * @default false
+     */
+    get instancing(): boolean;
+    set instancing(value: boolean);
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: THREE.Color;
+    /**
+     * @default null
+     */
+    bumpMap: THREE.Texture | null;
+    /**
+     * @default 1
+     */
+    bumpScale: number;
+    /**
+     * @default null
+     */
+    displacementMap: THREE.Texture | null;
+    /**
+     * @default 1
+     */
+    displacementScale: number;
+    /**
+     * @default 0
+     */
+    displacementBias: number;
+    /**
+     * @default new THREE.Color( 0x000000 )
+     */
+    emissive: THREE.Color;
+    /**
+     * @default 1
+     */
+    emissiveIntensity: number;
+    /**
+     * @default null
+     */
+    emissiveMap: THREE.Texture | null;
+    /**
+     * @default false
+     */
+    flatShading: boolean;
+    /**
+     * @default null
+     */
+    map: THREE.Texture | null;
+    /**
+     * @default null
+     */
+    lightMap: THREE.Texture | null;
+    /**
+     * @default 1
+     */
+    lightMapIntensity: number;
+    /**
+     * @default null
+     */
+    normalMap: THREE.Texture | null;
+    normalMapType: THREE.NormalMapTypes;
+    /**
+     * @default new THREE.Vector2( 1, 1 )
+     */
+    normalScale: THREE.Vector2;
+    /**
+     * @default null
+     */
+    aoMap: THREE.Texture | null;
+    /**
+     * @default 1
+     */
+    aoMapIntensity: number;
+    /**
+     * @default null
+     */
+    specularMap: THREE.Texture | null;
+    /**
+     * @default null
+     */
+    alphaMap: THREE.Texture | null;
+    /**
+     * @default null
+     */
+    envMap: THREE.Texture | null;
+    /**
+     * @default THREE.MultiplyOperation
+     */
+    combine: THREE.Combine;
+    /**
+     * @default 1
+     */
+    reflectivity: number;
+    /**
+     * @default 0.98
+     */
+    refractionRatio: number;
+    /**
+     * @default false
+     */
+    wireframe: boolean;
+    /**
+     * @default 1
+     */
+    wireframeLinewidth: number;
+    /**
+     * @default 'round'
+     */
+    wireframeLinecap: string;
+    /**
+     * @default 'round'
+     */
+    wireframeLinejoin: string;
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+    protected refreshUniformsCommon(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: CustomMeshLambertMaterial, renderer: THREE.WebGLRenderer): void;
+    protected onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
+    copy(source: CustomMeshLambertMaterial): this;
 }
-export interface IEventSigner<Data> {
-    listen(callback: EventFunction<Data>, options?: {
-        bind?: object;
-    }): IEventListener<Data>;
-    unlisten(callback: EventFunction<Data>, options?: {
-        bind?: object;
-        allowMissing?: boolean;
-    }): boolean;
+export interface CustomLineMaterialParameters extends THREE.ShaderMaterialParameters, THREE.LineBasicMaterialParameters {
+    instancing?: boolean | undefined;
+}
+export class CustomLineMaterial extends CustomMaterial {
+    type: string;
+    
+    constructor(parameters?: CustomLineMaterialParameters);
+    /**
+     * @default false
+     */
+    get instancing(): boolean;
+    set instancing(value: boolean);
+    /**
+     * @default 0xffffff
+     */
+    color: THREE.Color;
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default true
+     */
+    fog: boolean;
+    /**
+     * @default 1
+     */
+    linewidth: number;
+    /**
+     * @default 'round'
+     */
+    linecap: string;
+    /**
+     * @default 'round'
+     */
+    linejoin: string;
+    /**
+     * @default null
+     */
+    map: THREE.Texture | null;
+    protected refreshUniformsCommon(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: CustomLineMaterial, renderer: THREE.WebGLRenderer): void;
+    protected onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
+    copy(source: CustomLineMaterial): this;
+}
+export interface MeshLineMaterialParameters extends THREE.ShaderMaterialParameters {
+    alphaToCoverage?: boolean | undefined;
+    color?: THREE.ColorRepresentation | undefined;
+    dashed?: boolean | undefined;
+    dashScale?: number | undefined;
+    dashSize?: number | undefined;
+    dashOffset?: number | undefined;
+    gapSize?: number | undefined;
+    linewidth?: number | undefined;
+    resolution?: THREE.Vector2 | undefined;
+    wireframe?: boolean | undefined;
+    worldUnits?: boolean | undefined;
+}
+export class MeshLineMaterial extends CustomMaterial {
+    type: string;
+    
+    constructor(parameters: MeshLineMaterialParameters);
+    get color(): THREE.Color;
+    set color(value: THREE.ColorRepresentation);
+    get worldUnits(): boolean;
+    set worldUnits(value: boolean);
+    get dashed(): boolean;
+    set dashed(value: boolean);
+    get dashScale(): number;
+    set dashScale(value: number);
+    get dashSize(): number;
+    set dashSize(value: number);
+    get dashOffset(): number;
+    set dashOffset(value: number);
+    get gapSize(): number;
+    set gapSize(value: number);
+    get resolution(): THREE.Vector2;
+    set resolution(value: THREE.Vector2);
+    onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
+}
+export interface CustomPointMaterialParameters extends THREE.ShaderMaterialParameters, THREE.PointsMaterialParameters {
+}
+export class CustomPointMaterial extends CustomMaterial {
+    type: string;
+    
+    constructor(parameters?: CustomPointMaterialParameters);
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: THREE.Color;
+    /**
+     * @default null
+     */
+    map: THREE.Texture | null;
+    /**
+     * @default null
+     */
+    alphaMap: THREE.Texture | null;
+    /**
+     * @default 1
+     */
+    size: number;
+    /**
+     * @default true
+     */
+    sizeAttenuation: boolean;
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+    protected refreshUniformsCommon(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: CustomPointMaterial, renderer: THREE.WebGLRenderer): void;
+    protected onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
+    copy(source: CustomPointMaterial): this;
+}
+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: THREE.Color): void;
+    setPoints(points: THREE.Vector3[]): this;
+    setPositions(array: ArrayLike<number>): this;
+    setColors(array: ArrayLike<number>): this;
+    computeLineDistances(): this;
+    toBufferGeometry(): THREE.BufferGeometry;
+    toWireframeGeometry(): THREE.BufferGeometry;
+    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 {
+    type: string;
+    material: MeshLineMaterial;
+    geometry: MeshLineGeometry;
+    
+    constructor(geometry?: MeshLineGeometry, material?: MeshLineMaterial);
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
+}
+export class TPair<TKey, TValue> {
+    get key(): TKey;
+    get value(): TValue;
 }
 export type Point3 = {
     x: number;
@@ -373,6 +693,19 @@ export interface ICameraControl {
      */
     setNavigationMode(mode: CameraNavigationMode, isEnable: boolean, duration?: number): void;
 }
+export type EventFunction<Data> = ((data: Data) => void) | (() => void);
+export interface IEventListener<Data> {
+    dispose(): void;
+}
+export interface IEventSigner<Data> {
+    listen(callback: EventFunction<Data>, options?: {
+        bind?: object;
+    }): IEventListener<Data>;
+    unlisten(callback: EventFunction<Data>, options?: {
+        bind?: object;
+        allowMissing?: boolean;
+    }): boolean;
+}
 export interface IModelIntersectionChecker {
     /** Gets the center of the model*/
     get modelCenter(): THREE.Vector3;
@@ -422,10 +755,6 @@ export interface IModelIntersectionChecker {
         guid: string;
     }[];
 }
-export class TPair<TKey, TValue> {
-    get key(): TKey;
-    get value(): TValue;
-}
 export class RenderViewSettings {
     telemetry?: boolean;
     hideEdgesWhenNavigation?: boolean;
@@ -532,6 +861,8 @@ export interface IUserScene {
     render(context: IRenderOperationContext): void;
     /** Clear scene */
     clear(): void;
+    /** Dispose scene */
+    dispose(): void;
 }
 export interface I3DRenderer {
     clear(color?: boolean, depth?: boolean, stencil?: boolean): void;
@@ -662,7 +993,9 @@ export enum ValueType {
     BOOL = 3
 }
 export class Viewer3DConfiguration extends ViewerConfiguration {
-    settings?: ViewerSettings;
+    render: ViewerSettings;
+    
+    constructor(appearance?: ViewerSettings, render?: ViewerSettings);
 }
 export const defaultViewer3DSettings: ViewerSettings;
 export enum IfcType {
@@ -2108,7 +2441,7 @@ export class Model {
     * Returns specific model part loaded in the viewer by its id.
     * @returns {ModelPart} - a model part with specified id
     */
-    getModelPart(id: string): ModelPart;
+    getModelPart(id: string): ModelPart | null;
     /**
      * Gets visible model parst
      * @returns {ModelPart[]} - An array of visible model parts
@@ -2214,6 +2547,7 @@ export class Viewer3D extends ViewerBase {
     settings: Readonly<ISettings>;
     get navigation(): INavigation;
     events: Readonly<IEventsDispatcher>;
+    getConfiguration(): Viewer3DConfiguration;
     start(): Promise<number>;
     finish(): void;
     /**
@@ -2250,7 +2584,16 @@ export class GuiViewer3D extends Viewer3D {
     onPostExtensionLoad(extension: ExtensionBase): void;
     protected getToolbarHeight(): number;
 }
+export type InitializeSuccessCallback = () => void;
+export function coreInitializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
+export function coreShutdown(): void;
 export function CreateViewer(container: HTMLElement, configuration?: Viewer3DConfiguration): GuiViewer3D;
+/**
+ * @param options
+ * @param callback
+ */
+export function Initializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
+export function shutdown(): void;
 export class Extension extends ExtensionBase {
     protected _viewer: Viewer3D;
     
@@ -2361,13 +2704,99 @@ export class GizmoBuilder {
     static buildRotationAxis(axisDir: THREE.Vector3, handleBaseMatrial?: THREE.Material, handleHoveredMaterial?: THREE.Material, handleSelectedMaterial?: THREE.Material, pickerBaseMatrial?: THREE.Material, pickerHoveredMaterial?: THREE.Material, pickerSelectedMaterial?: THREE.Material): GizmoAxis;
     static buildScaleAxis(axisDir: THREE.Vector3, handleBaseMatrial?: THREE.Material, handleHoveredMaterial?: THREE.Material, handleSelectedMaterial?: THREE.Material): GizmoAxis;
 }
-export type InitializeSuccessCallback = () => void;
-/**
- * @param options
- * @param callback
- */
-export function Initializer(options: any, callback: InitializeSuccessCallback): void;
-export function shutdown(): void;
+export interface LabelSpriteParameters {
+    text?: string | undefined;
+    sizeAttenuation?: boolean | undefined;
+    fontFace?: string | FontFace | undefined;
+    fontSize?: number | undefined;
+    borderColor?: Color | undefined;
+    backgroundColor?: Color | undefined;
+    borderThickness?: number | undefined;
+    borderRadius?: number | undefined;
+    textColor?: Color | undefined;
+    textPadding?: THREE.Vector4Tuple | undefined;
+}
+export class LabelSprite extends THREE.Sprite {
+    readonly extraHeightFactor = 1.4;
+    
+    constructor(parameters: LabelSpriteParameters);
+    get sizeAttenuation(): boolean;
+    set sizeAttenuation(value: boolean);
+    /**
+     * @default ''
+     */
+    get text(): string;
+    set text(value: string);
+    /**
+    * @default 'Roboto, sans-serif'
+    */
+    get fontFace(): string | FontFace;
+    set fontFace(value: string | FontFace);
+    /**
+    * @default 12
+    */
+    get fontSize(): number;
+    set fontSize(value: number);
+    /**
+    * @default 2
+    */
+    get borderThickness(): number;
+    set borderThickness(value: number);
+    /**
+    * @default new Color(0, 0, 0, 1.0)
+    */
+    get borderColor(): Color;
+    set borderColor(value: Color);
+    /**
+    * @default 1
+    */
+    get borderRadius(): number;
+    set borderRadius(value: number);
+    /**
+    * @default new Color(1.0, 1.0, 1.0, 1.0)
+    */
+    get backgroundColor(): Color;
+    set backgroundColor(value: Color);
+    /**
+    * @default new Color(0, 0, 0, 1.0)
+    */
+    get textColor(): Color;
+    set textColor(value: Color);
+    /**
+     * Label text padding: left, top, right, bottom
+     * @default [0, 0, 0, 0]
+     */
+    get textPadding(): THREE.Vector4Tuple;
+    set textPadding(value: THREE.Vector4Tuple);
+    dispose(): void;
+}
+export interface IWindowStyle {
+    width: string;
+    height: string;
+    left: string;
+    right: string;
+    top: string;
+}
+export interface IWindowStateOptions {
+    saveKey: string;
+    restoreWindowSize: boolean;
+}
+export class WindowStater {
+    get windowStylesState(): IWindowStyle;
+    get windowOptionsState(): IWindowStateOptions;
+    restore(): void;
+    saveWindowState(): void;
+}
+export class Resizer {
+    
+    constructor(resizableContainer: HTMLElement, containerToRestriction: HTMLElement, elementAnchor?: HTMLElement, windowStater?: WindowStater);
+    get windowState(): IWindowStyle | null;
+}
+export class Dragger {
+    
+    constructor(allowedDraggableElement: HTMLElement, draggableContainer: HTMLElement, containerToRestriction: HTMLElement, windowStater?: WindowStater);
+    get windowState(): IWindowStyle | null;
+}
 export class Button extends Control {
     
     constructor(id: string);
@@ -2402,5 +2831,32 @@ export namespace Button {
         CLICK = "click"
     }
 }
+interface ElementClass {
+    panelClassName?: string;
+    contentClassName?: string;
+    headerClassName?: string;
+}
+export class Dialog extends Control {
+    responseDialog: (state?: boolean) => void;
+    
+    constructor(id: string, panelToAttach: HTMLElement);
+    get dialog(): HTMLElement;
+    get dialogContent(): HTMLElement;
+    get resizable(): boolean;
+    setDialogContent(value: HTMLElement): Dialog;
+    setHeader(value: HTMLElement): Dialog;
+    setCaption(value: string): Dialog;
+    setIcon(iconClassName: string): Dialog;
+    setFooter(value: HTMLElement): Dialog;
+    setDialogElementClassNames(value: ElementClass): Dialog;
+    setResizable(value: boolean): Dialog;
+    setWindowOptions(value: IWindowStateOptions): Dialog;
+    setDraggable(value: boolean): Dialog;
+    openDialog(): HTMLElement;
+    destroyDialog(): void;
+    isDialogShown(): boolean;
+    subscribe(fn: (state: boolean) => void): void;
+}
+export {};
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "23.0.3",
+  "version": "23.0.5",
   "description": "TypeScript definitions for ASCON PilotWeb3D component",
   "main": "",
   "types": "index.d.ts",
@@ -9,7 +9,7 @@
   "license": "MIT",
   "typeScriptVersion": "4.9.4",
   "devDependencies": {
-    "@types/three": "0.135.0"
+    "@types/three": "0.148.0"
   },
   "keywords": [
     "pilotdev",