@pilotdev/pilot-web-3d 1.0.2 → 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,66 +1,156 @@
- 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 ModelPart {
-      get id(): string;
-      get elementTree(): ModelElementTree;
-      dispose(): void;
+  class Model {
+    /**
+     * Returns all model parts loaded in the viewer.
+     * @returns {ModelPart[]} - An array of visible and hidden model parts
+     */
+    getAllModelParts(): ModelPart[];
+    /**
+     * Gets visible model parst
+     * @returns {ModelPart[]} - An array of visible model parts
+     */
+    getVisibleModelParts(): ModelPart[];
+    /**
+     * Gets hidden model parts
+     * @returns {ModelPart[]} - An array of hidden model parts
+     */
+    getHiddenModelParts(): ModelPart[];
+    /**
+     * Temporarily remove a model part from the Viewer, but keep loaders, materials, and geometry alive.
+     * @param {string | ModelPart} modelPart - model part id or model part instance
+     */
+    hideModelPart(modelPart: string | ModelPart): void;
+    /**
+     * Shows hidden model part
+     * @param {string | ModelPart} modelPart - model part id or model part instance
+     */
+    showModelPart(modelPart: string | ModelPart): void;
+    /**
+     * Hide model elements
+     * @param {string[]|string} elementIds - An array of model elements id or just a single model element id.
+     * @param {string | ModelPart} modelPart - id of the model part that contains the element ids. By default uses the initial model part loaded into the scene.
+     */
+    hide(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    /**
+     * Hides all elements and model parts from the viewer
+     */
+    hideAll(): void;
+    /**
+     * Ensures the passed in elements are shown.
+     *
+     * @param {string[] | string} elementIds - An array of model elements or just a single model element.
+     * @param {string | ModelPart} modelPart - id of the model part that contains the model element id. By default uses the initial model part loaded into the scene.
+     *
+     */
+    show(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    /**
+     * Shows all elements and model parts
+     */
+    showAll(): void;
+    /**
+     * Selects the array of model elements. You can also pass in a single model element id instead of an array.
+     *
+     * @param {string[] | string} elementIds - element or array of elements to select.
+     * @param {string | ModelPart} modelPart - model part id or the model part instance containing the elements.
+     *
+     */
+    select(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    /**
+     *  Unselect all model elements in all model parts
+     */
+    clearSelection(): void;
+    /**
+     * Returns the current selection.
+     * @returns {ModelElementIds[]} Array of the currently selected model elements.
+     */
+    getSelection(): ModelElementIds[];
+    /**
+     * Sets color to elements
+     * @param {string[] | string} elementIds - element or array of elements to change color.
+     * @param {number} r - red
+     * @param {number} g - green
+     * @param {number} b - blue
+     * @param {number} a - alpha
+     * @param {string | ModelPart} modelPart - id of the model part or model part instance containing the elements.
+     */
+    setColor(elementIds: string[] | string, r: number, g: number, b: number, a: number, modelPart?: string | ModelPart): void;
+    /**
+     * Resets all changed colors for all elements in all model parts
+     * @param {string | ModelPart} model - id of the model part or model part instance.
+     */
+    clearColors(model?: string | ModelPart): void;
+  }
+
+  class ModelPart {
+    get id(): string;
+    get elementTree(): ModelElementTree;
+    dispose(): void;
   }
 
-  export class Selection {
-      modelId: string;
-      selected: string[];
+  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;
+  }
+  class SelectionEvent extends Event {
+    selected: string[];
+    modelPartId: string;
   }
-  export class SelectionEvent extends Event {
-      selected: string[];
-      modelId: 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;
@@ -68,113 +158,52 @@
     clearListeners(): void;
   }
   
-  export type ViewPointType = {
+  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;
-    loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
-    unloadModel(model: string | ModelPart): void;
-    /**
-     * Returns all models loaded in the viewer.
-     * @returns {ModelPart[]} - An array of visible and hidden models
-     */
-    getAllModels(): ModelPart[];
-    /**
-    * @returns {ModelPart[]} - An array of visible models
-    */
-    getVisibleModels(): ModelPart[];
-    /**
-    * @returns {ModelPart[]} - An array of hidden models
-    */
-    getHiddenModels(): ModelPart[];
-    /**
-     * Temporarily remove a model from the Viewer, but keep loaders, materials, and geometry alive.
-     * @param {string | ModelPart} model - model id or ModelPart object
-     * @returns {boolean} true indicates success, i.e., modelId referred to a visible model that is now hidden
-     */
-    hideModel(model: string | ModelPart): void;
-    /**
-     *
-     * @param {string | ModelPart} model - model id or ModelPart object
-     */
-    showModel(model: string | ModelPart): void;
-    /**
-     * Returns the current selection.
-     * @returns {Selection[]} Array of the currently selected nodes.
-     */
-    getSelection(): Selection[];
-    /**
-     * Hide elements
-     * @param {string[]|string} elementIds - An array of elements (elementIds) or just a single element.
-     * @param {string | ModelPart} model - id of the model that contains the elementIds. By default uses the initial model loaded into the scene.
-     */
-    hide(elementIds: string[] | string, model?: string | ModelPart): void;
-    /**
-     *
-     */
-    hideAll(): void;
     /**
-     * Ensures the passed in elements (elementIds) are shown.
-     *
-     * @param {string[] | string} elementIds - An array of elements (elementIds) or just a single node.
-     * @param {string | ModelPart} model - id of the model that contains the elementId. By default uses the initial model loaded into the scene.
-     *
+     * Loads new model part to the viewer
+     * @param buffer
+     * @param options
+     * @param onSuccessCallback
+     * @param onErrorCallback
      */
-    show(elementIds: string[] | string, model?: string | ModelPart): void;
+    loadModelPart(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
     /**
-     *
+     * unloads model part from the viewer
+     * @param modelPart - model part id or model part instance
      */
-    showAll(): void;
+    unloadModelPart(modelPart: string | ModelPart): void;
     /**
-     * Toggles the selection for a given elementIds.
-     * If it was unselected, it is selected.
-     * If it was selected, it is unselected.
-     *
-     * @param {string} elementIds
-     * @param {string | ModelPart} model - model that contains the elementIds. Uses the initial model loaded by default.
+     * Returns general model
+     * @returns { Model } - general model
      */
-    toggleSelect(elementIds: string[] | string, model?: string | ModelPart): void;
+    get model(): Model;
     /**
-     * Selects the array of ids. You can also pass in a single id instead of an array.
-     *
-     * @param {string[] | string} elementIds - element or array of elements to select.
-     * @param {string | ModelPart} model - model id or the model instance containing the ids.
-     *
+     * Sets the cameras point of view.
+     * @param cameraPosition camera position and direction.
      */
-    select(elementIds: string[] | string, model?: string | ModelPart): void;
+    setCameraPosition(cameraPosition: CameraPosition): void;
     /**
-     *  Unselect all nodes in all models
+     * Gets the cameras point of view.
+     * @returns camera position and direction.
      */
-    clearSelection(): void;
+    getCameraPosition(): CameraPosition;
     /**
-     *
-     * @param {string[] | string} elementIds - element or array of elements to change color.
-     * @param color -
-     * @param {string | ModelPart} model - id of the model or model instance containing the ids.
-     */
-    setColor(elementIds: string[] | string, color: THREE.Color, model?: string | ModelPart): void;
-    /**
-     *
-     * @param {string | ModelPart} model - id of the model or model instance.
-     */
-    clearColors(model?: string | ModelPart): void;
-    /**
-     * Sets the cameras point of view
-     * @param viewPoint camera position and direction
+     * Makes screenshot
+     * @param {string} [mimeType=image/png] Image MIME type.
+     * @param {number} [qualityArgument=1.0] Image quality to be used for image/jpeg or image/webp formats.
+     * @returns Blob object representing render image.
      */
-    setCameraViewPoint(viewPoint: ViewPointType): void;
-    /**
-     * Gets the cameras point of view
-     * @returns camera position and direction
-     */
-    getCameraViewPoint(): ViewPointType;
+    makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
   }
   
-  export abstract class ViewerBase {
+  abstract class ViewerBase {
     container: HTMLElement;
     layerManagers: Map<number, ILayerManager>;
     extensionsLoader: ExtensionLoader;
@@ -188,32 +217,25 @@
      *
      */
     finish(): void;
-    /**
-   *
-   * @param buffer
-   * @param options
-   * @param onSuccessCallback
-   * @param onErrorCallback
-   */
-    loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    
     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[];
@@ -221,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;
@@ -267,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.2",
-  "description": "TypeScript definitions for ASCON pilotweb3d.js library",
-  "main": "",
-  "types": "index.d.ts",
-  "scripts": {},
-  "license": "MIT",
-  "typeScriptVersion": "4.4.3",
-  "devDependencies": {
-    "@types/three": "0.135.0"
-  }
-}
+{
+  "name": "@pilotdev/pilot-web-3d",
+  "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": {}
+}