@pilotdev/pilot-web-3d 1.0.3 → 1.0.4-1

package/README.md

@@ -1,9 +1,9 @@
 # Installation
-> `npm install --save-dev @pilotdev/pilot-web-3d`
+> `npm install --save @pilotdev/pilot-web-3d`
 
 # Summary
-This package contains type definitions for Ascon pilot-web-3d.js library (https://pilotcloud.ascon.net/).
+This package contains type definitions for Ascon Pilot.Web.3D component (https://pilotcloud.ascon.net/).
 
 ### Additional Details
- * Last updated: Thu, 25 Aug 2022 17:10:25 GMT
+ * Last updated: Thu, 2 Sept 2022 10:10:25 GMT
  * Global values: `PilotWeb3d`

package/index.d.ts

@@ -1,23 +1,23 @@
- export namespace PilotWeb3D {  
+/// <reference path="./three/three.d.ts" />
+declare namespace PilotWeb3D {  
   
-  export type InitializeSuccessCallback = () => void;
-  export function Initializer(options: any, callback: InitializeSuccessCallback): void;
-  export function shutdown(): void;
-  export type ErrorCallback = (message: string) => void;
-  export type SuccessCallback = (modelId: any) => void;
-  export enum DocumentType {
-      UNKNOWN = 0,
-      DOCUMENT_2D = 1,
-      DOCUMENT_3D = 2
+  type InitializeSuccessCallback = () => void;
+  function Initializer(options: any, callback: InitializeSuccessCallback): void;
+  function shutdown(): void;
+  type ErrorCallback = (message: string) => void;
+  type SuccessCallback = (modelId: any) => void;
+  enum DocumentType {
+    UNKNOWN = 0,
+    DOCUMENT_2D = 1,
+    DOCUMENT_3D = 2
   }
 
-  export class GuiViewer3D extends Viewer3D {
-      loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
-      getToolbar(): ViewerToolbar;
-      onPostExtensionLoad(extension: Extension): void;
+  class GuiViewer3D extends Viewer3D {
+    getToolbar(): ViewerToolbar;
+    onPostExtensionLoad(extension: Extension): void;
   }
   
-  export class Model {
+  class Model {
     /**
      * Returns all model parts loaded in the viewer.
      * @returns {ModelPart[]} - An array of visible and hidden model parts
@@ -99,50 +99,58 @@
     clearColors(model?: string | ModelPart): void;
   }
 
-  export class ModelPart {
-      get id(): string;
-      get elementTree(): ModelElementTree;
-      dispose(): void;
+  class ModelPart {
+    get id(): string;
+    get elementTree(): ModelElementTree;
+    dispose(): void;
   }
 
-  export class ModelElementIds {
+  class ModelElementIds {
     modelPartId: string;
     elementIds: string[];
   }
   
-  export class ModelElementTree {
+  class ModelElementTree {
     enumElementChildren(element: string | ModelElement, callback: (guid: string) => void, recursive?: boolean): void;
     getRootElement(): ModelElement;
     getAllElements(): ModelElement[];
+    getElement(id: string) : ModelElement;
     isViewableElement(element: string | ModelElement): boolean;
     isDetachedElement(element: string | ModelElement): boolean;
     getChildLevelNumber(element: string | ModelElement): number;
   }
 
-  export class ModelElement {
+  class ModelElement {
     get id(): string;
+    get modelPartId(): string;
     get parent(): ModelElement | undefined;
     get type(): string;
     get name(): string;
     get children(): ModelElement[];
   }
 
-  export class CoreEventTypes {
+  class CoreEventTypes {
     static VIEWER_RESIZE_EVENT: string;
     static VIEWER_MOUSE_DOWN_EVENT: string;
     static VIEWER_MOUSE_MOVE_EVENT: string;
     static VIEWER_MOUSE_UP_EVENT: string;
     static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
   }
-  export class EventTypes extends CoreEventTypes {
-      static SELECTION_CHANGED_EVENT: string;
+  class EventTypes extends CoreEventTypes {
+    static SELECTION_CHANGED_EVENT: string;
+    static MODEL_PART_LOADED: string;
+    static MODEL_PART_UNLOADED: string;
   }
-  export class SelectionEvent extends Event {
-      selected: string[];
-      modelId: string;
+  class SelectionEvent extends Event {
+    selected: string[];
+    modelPartId: string;
+  }
+
+  class ModelPartEvent extends Event {
+    modelPartId: string;
   }
 
-  export interface EventsDispatcher {
+  interface EventsDispatcher {
     addEventListener(event: string, listener: EventListener, options?: any): void;
     removeEventListener(event: string, listener: EventListener): void;
     hasEventListener(event: string, listener: EventListener): boolean;
@@ -150,12 +158,12 @@
     clearListeners(): void;
   }
   
-  export type CameraPosition = {
+  type CameraPosition = {
     position: THREE.Vector3;
     direction: THREE.Vector3;
   };
-  export var ViewerInstance: Viewer3D;
-  export class Viewer3D extends ViewerBase {
+  var ViewerInstance: Viewer3D;
+  class Viewer3D extends ViewerBase {
     start(): number;
     finish(): void;
     /**
@@ -195,7 +203,7 @@
     makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
   }
   
-  export abstract class ViewerBase {
+  abstract class ViewerBase {
     container: HTMLElement;
     layerManagers: Map<number, ILayerManager>;
     extensionsLoader: ExtensionLoader;
@@ -213,21 +221,21 @@
     onPostExtensionLoad(extension: Extension): void;
   }
 
-  export class ExtensionLoader {
+  class ExtensionLoader {
     loadExtension(extensionId: string): Promise<Extension>;
     unloadExtension(extensionId: string): Promise<boolean>;
     getExtensions(): Extension[];
   }
 
-  export function CreateViewer(container: HTMLDivElement): GuiViewer3D;
+  function CreateViewer(container: HTMLElement): GuiViewer3D;
 
-  export interface ILayerManager {
+  interface ILayerManager {
     createLayer(name: string): ILayer;
     deleteLayer(name: string): boolean;
     getLayer(name: string): ILayer | null;
     hasLayer(name: string): boolean;
   }
-  export interface ILayer {
+  interface ILayer {
     addOverlay(overlay: Overlay): boolean;
     removeOverlay(overlay: Overlay): boolean;
     getOverlays(): Overlay[];
@@ -235,37 +243,38 @@
     getViewBox(): LayerViewBox;
     dispose(): void;
   }
-  export  type Overlay = HTMLElement | any;
-  export  type LayerContainer = HTMLElement | any;
-  export  type LayerViewBox = DOMRect | any;
+  type Overlay = HTMLElement | any;
+  type LayerContainer = HTMLElement | any;
+  type LayerViewBox = DOMRect | any;
 
-  export  class Toolbar extends Control {
+  class Toolbar extends Control {
     addControl(control: Control): void;
     removeControl(id: string): void;
   }
 
-  export  class Control {
+  class Control {
     container: HTMLElement;
     id: string;
     addClass(cssClass: string): void;
     removeClass(cssClass: string): void;
   }
 
-  export  class ViewerToolbar extends Toolbar {
+  class ViewerToolbar extends Toolbar {
   }
 
-  export  class ToolbarBuilder {
+  class ToolbarBuilder {
     addButton(id: string): ButtonBuilder;
     removeItem(id: string): void;
   }
-  export  class ButtonBuilder {
-      withCaption(caption: string): ButtonBuilder;
-      withIcon(icon: string): ButtonBuilder;
-      withClickAction(action: EventListener): ButtonBuilder;
-      withIsChecked(value: boolean): ButtonBuilder;
+  class ButtonBuilder {
+    withCaption(caption: string): ButtonBuilder;
+    withIcon(icon: string): ButtonBuilder;
+    withClickAction(action: EventListener): ButtonBuilder;
+    withIsChecked(value: boolean): ButtonBuilder;
   }
 
-  export  class Extension {
+  class Extension {
+    protected _viewer: ViewerBase;
     constructor(viewer3D: ViewerBase, options?: object);
     load(): boolean | Promise<boolean>;
     unload(): boolean;
@@ -281,10 +290,10 @@
     onToolbarCreated(builder: ToolbarBuilder): void;
   }
 
-  export class ExtensionManager {
+  class ExtensionManager {
     registerExtensionType(extensionId: string, extension: typeof Extension): boolean;
     unregisterExtensionType(extensionId: string): boolean;
     getExtensionType(extensionId: string): typeof Extension;
   }
-  export const theExtensionManager: ExtensionManager;
+  const theExtensionManager: ExtensionManager;
 }

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "1.0.3",
+  "version": "1.0.4-1",
   "description": "TypeScript definitions for ASCON Pilot.Web.3D component",
   "main": "",
   "types": "index.d.ts",
   "scripts": {},
   "license": "MIT",
   "typeScriptVersion": "4.4.3",
-  "dependencies": {
-    "@types/three": "0.135.0"
-  }
+  "dependencies": {}
 }