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

package/index.d.ts

@@ -1,23 +1,23 @@
 /// <reference path="./three/three.d.ts" />
 declare namespace PilotWeb3D {  
   
-   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
+  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
   }
 
-   class GuiViewer3D extends Viewer3D {
-      getToolbar(): ViewerToolbar;
-      onPostExtensionLoad(extension: Extension): void;
+  class GuiViewer3D extends Viewer3D {
+    getToolbar(): ViewerToolbar;
+    onPostExtensionLoad(extension: Extension): void;
   }
   
-   class Model {
+  class Model {
     /**
      * Returns all model parts loaded in the viewer.
      * @returns {ModelPart[]} - An array of visible and hidden model parts
@@ -82,6 +82,16 @@ declare namespace PilotWeb3D {
      * @returns {ModelElementIds[]} Array of the currently selected model elements.
      */
     getSelection(): ModelElementIds[];
+     /**
+     * Returns the hidden element ids.
+     * @returns {ModelElementIds[]} Array of the currently hidden model elements.
+     */
+    getHiddenElements(): ModelElementIds[];
+    /**
+     * Returns the visible element ids.
+     * @returns {ModelElementIds[]} Array of the currently visible model elements.
+     */
+    getVisibleElements(): ModelElementIds[];
     /**
      * Sets color to elements
      * @param {string[] | string} elementIds - element or array of elements to change color.
@@ -99,50 +109,58 @@ declare namespace PilotWeb3D {
     clearColors(model?: string | ModelPart): void;
   }
 
-   class ModelPart {
-      get id(): string;
-      get elementTree(): ModelElementTree;
-      dispose(): void;
+  class ModelPart {
+    get id(): string;
+    get elementTree(): ModelElementTree;
+    dispose(): void;
   }
 
-   class ModelElementIds {
+  class ModelElementIds {
     modelPartId: string;
     elementIds: string[];
   }
   
-   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;
   }
 
-   class ModelElement {
+  class ModelElement {
     get id(): string;
+    get modelPartId(): string;
     get parent(): ModelElement | undefined;
     get type(): string;
     get name(): string;
     get children(): ModelElement[];
   }
 
-   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;
   }
-   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;
   }
-   class SelectionEvent extends Event {
-      selected: string[];
-      modelId: string;
+  class SelectionEvent extends Event {
+    selected: string[];
+    modelPartId: string;
   }
 
-   interface EventsDispatcher {
+  class ModelPartEvent extends Event {
+    modelPartId: string;
+  }
+
+  interface EventsDispatcher {
     addEventListener(event: string, listener: EventListener, options?: any): void;
     removeEventListener(event: string, listener: EventListener): void;
     hasEventListener(event: string, listener: EventListener): boolean;
@@ -150,12 +168,15 @@ declare namespace PilotWeb3D {
     clearListeners(): void;
   }
   
-   type CameraPosition = {
-    position: THREE.Vector3;
-    direction: THREE.Vector3;
+  type CameraPosition = {
+    position: { x: number, y: number, z: number },
+    eyeDir: { x: number, y: number, z: number },
+    angle: number,
+    viewCenter: { x: number, y: number, z: number }
   };
-   var ViewerInstance: Viewer3D;
-   class Viewer3D extends ViewerBase {
+
+  var ViewerInstance: Viewer3D;
+  class Viewer3D extends ViewerBase {
     start(): number;
     finish(): void;
     /**
@@ -195,7 +216,7 @@ declare namespace PilotWeb3D {
     makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
   }
   
-   abstract class ViewerBase {
+  abstract class ViewerBase {
     container: HTMLElement;
     layerManagers: Map<number, ILayerManager>;
     extensionsLoader: ExtensionLoader;
@@ -213,21 +234,21 @@ declare namespace PilotWeb3D {
     onPostExtensionLoad(extension: Extension): void;
   }
 
-   class ExtensionLoader {
+  class ExtensionLoader {
     loadExtension(extensionId: string): Promise<Extension>;
     unloadExtension(extensionId: string): Promise<boolean>;
     getExtensions(): Extension[];
   }
 
-   function CreateViewer(container: HTMLElement): GuiViewer3D;
+  function CreateViewer(container: HTMLElement): GuiViewer3D;
 
-   interface ILayerManager {
+  interface ILayerManager {
     createLayer(name: string): ILayer;
     deleteLayer(name: string): boolean;
     getLayer(name: string): ILayer | null;
     hasLayer(name: string): boolean;
   }
-   interface ILayer {
+  interface ILayer {
     addOverlay(overlay: Overlay): boolean;
     removeOverlay(overlay: Overlay): boolean;
     getOverlays(): Overlay[];
@@ -235,37 +256,63 @@ declare namespace PilotWeb3D {
     getViewBox(): LayerViewBox;
     dispose(): void;
   }
-    type Overlay = HTMLElement | any;
-    type LayerContainer = HTMLElement | any;
-    type LayerViewBox = DOMRect | any;
+  type Overlay = HTMLElement | any;
+  type LayerContainer = HTMLElement | any;
+  type LayerViewBox = DOMRect | any;
 
-    class Toolbar extends Control {
+  class Toolbar extends Control {
     addControl(control: Control): void;
     removeControl(id: string): void;
   }
 
-    class Control {
+  class Control {
     container: HTMLElement;
-    id: string;
+    constructor(id: string);
     addClass(cssClass: string): void;
     removeClass(cssClass: string): void;
+    getId(): string;
+    setToolTip(tooltipText: string): void;
   }
 
-    class ViewerToolbar extends Toolbar {
+  class ViewerToolbar extends Toolbar {
   }
 
-    class ToolbarBuilder {
-    addButton(id: string): ButtonBuilder;
-    removeItem(id: string): void;
+  class Button extends Control {
+    constructor(id: string);
+    setIsChecked(value: boolean): void;
+    setState(state: Button.State): boolean;
+    getState(): Button.State;
+    setIcon(iconClassName: string): void;
+    /**
+     * Override this method to be notified when the user clicks on the button.
+     * @param {MouseEvent} event
+     */
+    onClick: (event: MouseEvent) => void;
+    /**
+     * Override this method to be notified when the mouse enters the button.
+     * @param {MouseEvent} event
+     */
+    onMouseOver: (event: MouseEvent) => void;
+    /**
+     * Override this method to be notified when the mouse leaves the button.
+     * @param {MouseEvent} event
+     */
+    onMouseOut: (event: MouseEvent) => void;
   }
-    class ButtonBuilder {
-      withCaption(caption: string): ButtonBuilder;
-      withIcon(icon: string): ButtonBuilder;
-      withClickAction(action: EventListener): ButtonBuilder;
-      withIsChecked(value: boolean): ButtonBuilder;
+  namespace Button {
+    enum State {
+        ACTIVE = 0,
+        INACTIVE = 1,
+        DISABLED = 2
+    }
+    enum Event {
+        STATE_CHANGED = "Button.StateChanged",
+        CLICK = "click"
+    }
   }
-
-    class Extension {
+  
+  class ExtensionBase {
+    protected _viewer: ViewerBase;
     constructor(viewer3D: ViewerBase, options?: object);
     load(): boolean | Promise<boolean>;
     unload(): boolean;
@@ -278,13 +325,18 @@ declare namespace PilotWeb3D {
     onMouseMove(event: MouseEvent): void;
     onMouseUp(event: MouseEvent): void;
     onMouseLongTouch(event: MouseEvent): void;
-    onToolbarCreated(builder: ToolbarBuilder): void;
+    onToolbarCreated(builder: Toolbar): void;
+  }
+
+  class Extension extends ExtensionBase{
+    protected _viewer: Viewer3D;
+    constructor(viewer: Viewer3D, options?: object);
   }
 
-   class ExtensionManager {
+  class ExtensionManager {
     registerExtensionType(extensionId: string, extension: typeof Extension): boolean;
     unregisterExtensionType(extensionId: string): boolean;
     getExtensionType(extensionId: string): typeof Extension;
   }
-   const theExtensionManager: ExtensionManager;
+  const theExtensionManager: ExtensionManager;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "1.0.4",
+  "version": "1.0.5-1",
   "description": "TypeScript definitions for ASCON Pilot.Web.3D component",
   "main": "",
   "types": "index.d.ts",