@pilotdev/pilot-web-3d 1.0.2 → 1.0.3

package/index.d.ts

@@ -17,15 +17,97 @@
       onPostExtensionLoad(extension: Extension): void;
   }
   
+  export 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;
+  }
+
   export class ModelPart {
       get id(): string;
       get elementTree(): ModelElementTree;
       dispose(): void;
   }
 
-  export class Selection {
-      modelId: string;
-      selected: string[];
+  export class ModelElementIds {
+    modelPartId: string;
+    elementIds: string[];
   }
   
   export class ModelElementTree {
@@ -68,7 +150,7 @@
     clearListeners(): void;
   }
   
-  export type ViewPointType = {
+  export type CameraPosition = {
     position: THREE.Vector3;
     direction: THREE.Vector3;
   };
@@ -76,102 +158,41 @@
   export 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.
-     *
-     */
-    show(elementIds: string[] | string, model?: string | ModelPart): void;
-    /**
-     *
-     */
-    showAll(): 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.
-     */
-    toggleSelect(elementIds: string[] | string, model?: string | ModelPart): void;
-    /**
-     * 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.
-     *
+     * Loads new model part to the viewer
+     * @param buffer
+     * @param options
+     * @param onSuccessCallback
+     * @param onErrorCallback
      */
-    select(elementIds: string[] | string, model?: string | ModelPart): void;
+    loadModelPart(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
     /**
-     *  Unselect all nodes in all models
+     * unloads model part from the viewer
+     * @param modelPart - model part id or model part instance
      */
-    clearSelection(): void;
+    unloadModelPart(modelPart: string | ModelPart): void;
     /**
-     *
-     * @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.
+     * Returns general model
+     * @returns { Model } - general model
      */
-    setColor(elementIds: string[] | string, color: THREE.Color, model?: string | ModelPart): void;
+    get model(): Model;
     /**
-     *
-     * @param {string | ModelPart} model - id of the model or model instance.
+     * Sets the cameras point of view.
+     * @param cameraPosition camera position and direction.
      */
-    clearColors(model?: string | ModelPart): void;
+    setCameraPosition(cameraPosition: CameraPosition): void;
     /**
-     * Sets the cameras point of view
-     * @param viewPoint camera position and direction
+     * Gets the cameras point of view.
+     * @returns camera position and direction.
      */
-    setCameraViewPoint(viewPoint: ViewPointType): void;
+    getCameraPosition(): CameraPosition;
     /**
-     * Gets the cameras point of view
-     * @returns 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.
      */
-    getCameraViewPoint(): ViewPointType;
+    makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
   }
   
   export abstract class ViewerBase {
@@ -188,14 +209,7 @@
      *
      */
     finish(): void;
-    /**
-   *
-   * @param buffer
-   * @param options
-   * @param onSuccessCallback
-   * @param onErrorCallback
-   */
-    loadModel(buffer: ArrayBuffer, options: {}, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    
     onPostExtensionLoad(extension: Extension): void;
   }
 

package/package.json

@@ -1,13 +1,13 @@
-{
-  "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.3",
+  "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"
+  }
+}