@pilotdev/pilot-web-3d 1.0.5 → 1.0.6

package/README.md

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

package/index.d.ts

@@ -1,3 +1,4 @@
+///// <reference types="@types/three" />
 /// <reference path="./three/three.d.ts" />
 declare namespace PilotWeb3D {  
   
@@ -82,6 +83,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.
@@ -135,6 +146,8 @@ declare namespace PilotWeb3D {
     static VIEWER_MOUSE_MOVE_EVENT: string;
     static VIEWER_MOUSE_UP_EVENT: string;
     static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
+    static SETTING_CHANGED_EVENT: string;
+    static SETTING_RESET_EVENT: string;
   }
   class EventTypes extends CoreEventTypes {
     static SELECTION_CHANGED_EVENT: string;
@@ -145,11 +158,14 @@ declare namespace PilotWeb3D {
     selected: string[];
     modelPartId: string;
   }
-
+  class SettingChangedEvent extends Event {
+    name: string;
+    oldValue: any;
+    newValue: any;
+  }
   class ModelPartEvent extends Event {
     modelPartId: string;
   }
-
   interface EventsDispatcher {
     addEventListener(event: string, listener: EventListener, options?: any): void;
     removeEventListener(event: string, listener: EventListener): void;
@@ -210,7 +226,8 @@ declare namespace PilotWeb3D {
     container: HTMLElement;
     layerManagers: Map<number, ILayerManager>;
     extensionsLoader: ExtensionLoader;
-    get events(): EventsDispatcher;
+    settingsManager: Readonly<ISettingsManager>;
+    events: Readonly<EventsDispatcher>;
     /**
      *
      * @returns
@@ -230,8 +247,41 @@ declare namespace PilotWeb3D {
     getExtensions(): Extension[];
   }
 
-  function CreateViewer(container: HTMLElement): GuiViewer3D;
+  function CreateViewer(container: HTMLElement, configuration?: Viewer3DConfiguration): GuiViewer3D;
 
+  type ViewerSettings = Record<string, any>;
+  class ViewerConfiguration {
+    [key: string]: any;
+  }
+  class Viewer3DConfiguration extends ViewerConfiguration {
+    settings?: ViewerSettings;
+  }
+  class SettingsNames {
+    static TELEMETRY: string;
+    static AXES: string;
+    static CAMERA_ANIMATION: string;
+    static HIDE_SMALL_ELEMENTS: string;
+    static GLOBAL_LIGHT: string;
+    static LIGHT_SOURCE: string;
+    static ANTI_ALIASING: string;
+    static HIDE_SMALL_ELEMENTS_WHEN_NAVIGATING: string;
+    static SMALL_ELEMENT_SIZE: string;
+    static LABEL_LINE_LENGTH: string;
+    static HIDE_EDGES_WHEN_NAVIGATING: string;
+    static DISPLAY_MODE: string;
+    static NAVIGATION_CUBE: string;
+  }
+  enum DisplayMode {
+    FACES_AND_EDGES = 0,
+    FACES = 1,
+    EDGES = 2
+  }
+  enum ValueType {
+    STRING = 0,
+    NUMBER = 1,
+    ENUM = 2,
+    BOOL = 3
+  }
   interface ILayerManager {
     createLayer(name: string): ILayer;
     deleteLayer(name: string): boolean;
@@ -257,45 +307,71 @@ declare namespace PilotWeb3D {
 
   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 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"
+    }
+  }
+  interface ISettingsManager {
+    changeSetting<T>(name: string, value: T, notify?: boolean): void;
+    getSettingValue<T>(name: string): T;
   }
-
   class ExtensionBase {
     protected _viewer: ViewerBase;
     constructor(viewer3D: ViewerBase, options?: object);
     load(): boolean | Promise<boolean>;
     unload(): boolean;
-    /**
-    * Gets the name of the extension.
-    * @returns {string} Returns the name of the extension.
-      */
+    activate() : boolean;
+    deactivate(): boolean;
     getName(): string;
     onMouseDown(event: MouseEvent): void;
     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);
+    constructor(viewer: Viewer3D, options?: any);
   }
 
   class ExtensionManager {

package/package.json

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