@pilotdev/pilot-web-3d 23.0.6-alpha.1 → 23.0.6

package/index.d.ts

@@ -4,9 +4,20 @@ export class InitializerOptions {
     libList?: string[];
     language?: string;
 }
+class Global {
+    G: any;
+    RESOURCE_ROOT: string;
+    initializeResourceRoot(options: InitializerOptions): void;
+    getResourceUrl(resourceRelativePath: string): string;
+}
+export const global: Global;
+export {};
+export type StringMap = {
+    [key: string]: any;
+};
 export class Localization {
     static initialize(options: any): Promise<void>;
-    static translate(stringToTrans: string): string;
+    static translate<T extends (string | StringMap) = string>(stringToTrans: string): T;
     static setLanguage(language: string): Promise<void>;
     static extendLocalization(locales: any): boolean;
 }
@@ -24,6 +35,7 @@ export class ExtensionLoader {
     loadExtension(extensionId: string): Promise<ExtensionBase>;
     unloadExtension(extensionId: string): Promise<boolean>;
     getExtensions(): string[];
+    getExtension(extensionId: string): ExtensionBase;
 }
 export interface ILayerManager {
     createLayer(name: string): ILayer;
@@ -58,6 +70,7 @@ export class CoreEventTypes {
     static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
     static SETTING_CHANGED_EVENT: string;
     static SETTING_RESET_EVENT: string;
+    static SETTING_LANGUAGE_CHANGED_EVENT: string;
 }
 export interface ISettingsStorage {
     clear(): void;
@@ -87,11 +100,11 @@ export interface ISettings {
     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;
-    static THEME: string;
+export enum BaseSettingsNames {
+    TOOLBAR = "toolbar",
+    TOOLBAR_DIRECTION = "toolbarDirection",
+    TOOLBAR_CONTENT = "toolbarContent",
+    THEME = "theme"
 }
 export class SettingChangedEvent extends Event {
     name: string;
@@ -122,13 +135,9 @@ export enum ToolbarContent {
     START = "ascn-toolbar-content-start",
     END = "ascn-toolbar-content-end"
 }
-export interface ToolbarOptions {
-    height: number;
-    direction: ToolbarDirection;
-}
 export interface ToolbarStyle {
-    direction?: ToolbarDirection;
-    content?: ToolbarContent;
+    [BaseSettingsNames.TOOLBAR_DIRECTION]?: ToolbarDirection;
+    [BaseSettingsNames.TOOLBAR_CONTENT]?: ToolbarContent;
 }
 export const defaultToolbarAppearance: ToolbarStyle;
 export type ViewerSettings = Record<string, any>;
@@ -136,6 +145,7 @@ export class ViewerConfiguration {
     settingsPrefix: string;
     appearance: ViewerSettings;
     createConfiguration(configuration: ViewerSettings, origin: ViewerSettings): void;
+    mergeConfigurationAndSettings(configuration: ViewerSettings, settings: ISettings): void;
     changeTheme(newTheme: string): void;
 }
 export type ErrorCallback = (message: string) => void;
@@ -183,7 +193,7 @@ export class Control {
 export class Toolbar extends Control {
     
     constructor(id: string, toolbarContainer: HTMLElement, options?: ToolbarStyle);
-    addControl(control: Control): void;
+    addControl(control: Control, index?: number): void;
     removeControl(id: string): void;
     changeToolbarPosition(direction: string): void;
     changeToolbarContent(content: string): void;
@@ -258,12 +268,18 @@ export abstract class ViewObject extends THREE.Object3D {
     protected _isVisible: boolean;
     protected _isHidden: boolean;
     protected _originalColor: Color;
-    /**model element entity guid */
+    /**
+     * model element entity guid
+     * @default zeroGuid
+    */
     readonly entityGuid: string;
-    /**model part guid */
+    /**
+     * model part guid
+     * @default zeroGuid
+     */
     readonly modelGuid: string;
     
-    constructor(entityGuid: string, modelGuid: string, color: Color);
+    constructor(entityGuid?: string, modelGuid?: string, color?: Color);
     /**Mesh representation of the object */
     abstract get mesh(): THREE.Mesh | null;
     /**Edge representation of the object */
@@ -575,6 +591,34 @@ export class CustomPointMaterial extends CustomMaterial {
     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 namespace Viewer3DIcons {
+    const VIEWER_SETTINGS_ICON: string;
+    const VIEWER_MODEL_BROWSER_ICON: string;
+    const VIEWER_FULL_SCREEN_ICON: string;
+    const VIEWER_COLLAPSE_ICON: string;
+    const VIEWER_ELEMENT_PROPERTIES_ICON: string;
+    const VIEWER_ADD_CLIPPING_PLANE_ICON: string;
+    const VIEWER_CLIPPING_FLIP_ICON: string;
+    const VIEWER_DELETE_CLIPPING_PLANE_ICON: string;
+    const VIEWER_CLIPPING_CUBE_ICON: string;
+    const VIEWER_ADD_REMARK_ICON: string;
+    const VIEWER_MEASUREMENT_EDGE_ICON: string;
+    const VIEWER_MEASUREMENT_PLANE_ICON: string;
+    const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
+}
+export namespace ViewerGeneralIcons {
+    const ZOOM_IN: string;
+    const ZOOM_OUT: string;
+    const CLOSE: string;
+    const STRETCH_WINDOW: string;
+    const EXPAND_TREE: string;
+    const COLLAPSE_TREE: string;
+    const ARROW_DROP_DOWN: string;
+    const ARROW_DROP_RIGHT: string;
+    const CIRCLE_ICON: string;
+    const SHOW: string;
+    const HIDE: string;
+}
 export class MeshLineGeometry extends THREE.InstancedBufferGeometry {
     type: string;
     instanceStart: THREE.BufferAttribute;
@@ -718,11 +762,33 @@ export interface IEventSigner<Data> {
         allowMissing?: boolean;
     }): boolean;
 }
-
+export interface IDisposable {
+    dispose(): void;
+}
+export class DisposeBy implements IDisposable {
+    
+    constructor(callback: () => void);
+    dispose(): void;
+}
+class RevertProperty<T, P extends keyof T> implements IDisposable {
+    dispose(): void;
+}
+export function changeProperty<T, P extends keyof T>(who: T, propName: P, newValue: T[P]): RevertProperty<T, P>;
+export class MergeDisposables implements IDisposable {
+    
+    constructor(handles: IDisposable[]);
+    push(...moreHandles: IDisposable[]): void;
+    dispose(): void;
+}
+class RemoveDomHandler implements IDisposable {
+    dispose(): void;
+}
+export function addDomListener<DomElement extends HTMLElement, Type extends keyof HTMLElementEventMap>(domElement: DomElement, type: Type, listener: (this: HTMLElement, ev: HTMLElementEventMap[Type]) => any): RemoveDomHandler;
+export {};
 export interface EventEmitter<Data> {
     emit(data?: Data, options?: object): void;
 }
-export class EventListener<Data> implements IEventListener<Data>, Disposable {
+export class RenderEventListener<Data> implements IEventListener<Data>, IDisposable {
     
     constructor(event: IEventSigner<Data>, func: EventFunction<Data>, options: {
         bind?: object;
@@ -732,7 +798,7 @@ export class EventListener<Data> implements IEventListener<Data>, Disposable {
 export class EventDispatcher<Data> implements IEventSigner<Data>, EventEmitter<Data> {
     listen(func: EventFunction<Data>, options?: {
         bind?: object;
-    }): EventListener<Data>;
+    }): IEventListener<Data>;
     unlisten(func: EventFunction<Data>, options?: {
         bind?: object;
         allowMissing?: boolean;
@@ -871,7 +937,7 @@ export enum OperationPriority {
     afterAll = 100
 }
 export type RenderOperationDelegate = (context: IRenderOperationContext) => OperationStatus;
-export interface IUserScene {
+export interface IUserScene extends THREE.Scene {
     /** Scene name */
     readonly name: string;
     /** Indicates whether the scene should to be updated (should to be managed)*/
@@ -880,8 +946,6 @@ export interface IUserScene {
     get needsRedraw(): boolean;
     /** Gets the scene intersection checker */
     get intersectionChecker(): IModelIntersectionChecker | null;
-    /** Gets the THREE.Object3D representation of the scene */
-    get threeObjectRepresentation(): THREE.Object3D | null;
     /** Sets clipping enable */
     set clippingEnable(value: boolean);
     /** Indicates whether the scene should be clipped */
@@ -903,13 +967,13 @@ export interface IUserScene {
     /** Render scene */
     render(context: IRenderOperationContext): void;
     /** Clear scene */
-    clear(): void;
+    clear(): this;
     /** Dispose scene */
     dispose(): void;
 }
 export interface I3DRenderer {
     clear(color?: boolean, depth?: boolean, stencil?: boolean): void;
-    setClearColor(color: ColorRepresentation, alpha?: number): void;
+    setClearColor(color: THREE.ColorRepresentation, alpha?: number): void;
     clearDepth(): void;
     render(scene: THREE.Object3D, camera: THREE.Camera): void;
     getSize(target: THREE.Vector2): THREE.Vector2;
@@ -2299,6 +2363,7 @@ export class EventTypes extends CoreEventTypes {
     static CAMERA_NAVIGATION_MODE_CHANGED_EVENT: string;
     static RENDER_CLICK_EVENT: string;
     static RENDER_HOVER_EVENT: string;
+    static RENDER_DOUBLE_CLICK_EVENT: string;
 }
 export class SelectionChangedEvent extends Event {
     selectedIds: ModelElementIds[];
@@ -2474,16 +2539,65 @@ export interface INavigation {
      */
     resetPivotPoint(): void;
 }
+export interface CustomSpriteMaterialParameters extends THREE.ShaderMaterialParameters {
+    color?: THREE.ColorRepresentation | undefined;
+    map?: THREE.Texture | null | undefined;
+    alphaMap?: THREE.Texture | null | undefined;
+    rotation?: number | undefined;
+    sizeAttenuation?: boolean | undefined;
+    fog?: boolean | undefined;
+    center?: THREE.Vector2 | undefined;
+}
+export class CustomSpriteMaterial extends CustomMaterial {
+    type: string;
+    readonly isSpriteMaterial: true;
+    
+    constructor(parameters?: CustomSpriteMaterialParameters);
+    /**
+     * @default new THREE.Color( 0xffffff )
+     */
+    color: THREE.Color;
+    /**
+     * @default null
+     */
+    map: THREE.Texture | null;
+    /**
+     * @default null
+     */
+    alphaMap: THREE.Texture | null;
+    /**
+     * @default 0
+     */
+    rotation: number;
+    /**
+     * @default true
+     */
+    sizeAttenuation: boolean;
+    /**
+     * @default true
+     */
+    transparent: boolean;
+    /**
+     * Whether the material is affected by fog. Default is true.
+     * @default fog
+     */
+    fog: boolean;
+    /**
+     * @default new THREE.Vector2(0.5, 0.5)
+     */
+    center: THREE.Vector2;
+    get resolution(): THREE.Vector2;
+    set resolution(value: THREE.Vector2);
+    protected refreshUniformsCommon(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: CustomSpriteMaterial, 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: CustomSpriteMaterial): this;
+}
 export class ModelLoadingOptions {
     guid: string;
     isConsolidatedModel?: boolean;
 }
-export class EventsObserver {
-    protected eventsDispatcher: IEventsDispatcher;
-    protected _listeners: Map<string, EventListener>;
-    watch(): void;
-    dispose(): void;
-}
 /**
  * This class describes the coordination model. The coordination model contains parts of the model (aka ModelPart).
  */
@@ -2827,6 +2941,53 @@ export class LabelSprite extends THREE.Sprite {
     set textPadding(value: THREE.Vector4Tuple);
     dispose(): void;
 }
+export interface MeshPointMaterialParameters extends THREE.ShaderMaterialParameters {
+    sizeAttenuation?: boolean | undefined;
+}
+export class MeshPointMaterial extends CustomMaterial {
+    
+    constructor(parameters?: MeshPointMaterialParameters);
+    /**
+     * @default true
+     */
+    sizeAttenuation: boolean;
+    get resolution(): THREE.Vector2;
+    set resolution(value: THREE.Vector2);
+    protected refreshUniformsCommon(uniforms: {
+        [uniform: string]: THREE.IUniform;
+    }, material: MeshPointMaterial, 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: MeshPointMaterial): this;
+}
+export interface MeshPointParamter {
+    point?: THREE.Vector3;
+    color?: Color;
+    size?: number;
+}
+export class MeshPoints extends THREE.Mesh {
+    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<THREE.Object3D<THREE.Event>>[]): void;
+}
 export interface IWindowStyle {
     width: string;
     height: string;
@@ -2854,30 +3015,6 @@ export class Dragger {
     constructor(allowedDraggableElement: HTMLElement, draggableContainer: HTMLElement, containerToRestriction: HTMLElement, windowStater?: WindowStater);
     get windowState(): IWindowStyle | null;
 }
-export namespace Viewer3DIcons {
-    const VIEWER_SETTINGS_ICON: string;
-    const VIEWER_MODEL_BROWSER_ICON: string;
-    const VIEWER_FULL_SCREEN_ICON: string;
-    const VIEWER_COLLAPSE_ICON: string;
-    const VIEWER_ELEMENT_PROPERTIES_ICON: string;
-    const VIEWER_ADD_CLIPPING_PLANE_ICON: string;
-    const VIEWER_CLIPPING_FLIP_ICON: string;
-    const VIEWER_DELETE_CLIPPING_PLANE_ICON: string;
-    const VIEWER_CLIPPING_CUBE_ICON: string;
-    const VIEWER_DISABLED_DELETE_CLIPPING_PLANE_ICON: string;
-    const VIEWER_DISABLED_CLIPPING_FLIP_ICON: string;
-    const VIEWER_ADD_REMARK_ICON: string;
-}
-export namespace ViewerGeneralIcons {
-    const ZOOM_IN: string;
-    const ZOOM_OUT: string;
-    const CLOSE: string;
-    const STRETCH_WINDOW: string;
-    const EXPAND_TREE: string;
-    const COLLAPSE_TREE: string;
-    const ARROW_DROP_DOWN: string;
-    const ARROW_DROP_RIGHT: string;
-}
 export class Button extends Control {
     
     constructor(id: string);

package/package.json

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