@pilotdev/pilot-web-3d 24.0.1 → 24.4.0

package/index.d.ts

@@ -218,6 +218,7 @@ export namespace Viewer3DIcons {
     const VIEWER_ADD_REMARK_ICON: string;
     const VIEWER_MEASUREMENT_EDGE_ICON: string;
     const VIEWER_MEASUREMENT_PLANE_ICON: string;
+    const VIEWER_MEASUREMENT_PERPENDICULAR_ICON: string;
     const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
 }
 export namespace ViewerGeneralIcons {
@@ -355,6 +356,7 @@ export class ExtensionBase {
     * @returns {string} Returns the name of the extension.
       */
     getName(): string;
+    isActive(): boolean;
     addCursorPhantomFromSvg(template: string): void;
     removeCursorPhantom(): void;
     onMouseDown(event: MouseEvent): void;
@@ -454,7 +456,7 @@ export abstract class ViewerBase {
     /**
      *
      */
-    finish(): void;
+    finish(): Promise<void>;
     onPostExtensionLoad(extension: ExtensionBase): void;
     onExtensionUnloading(extension: ExtensionBase): void;
     onPostExtensionUnload(extension: ExtensionBase): void;
@@ -538,13 +540,14 @@ export class Checkbox {
     onChange(value: boolean): void;
     createElement(): Element;
 }
-interface ISelectItem {
+export interface ISelectItem {
     text: string;
     value: string;
 }
 export class Select {
     
     constructor(id: string, items: ISelectItem[], placeholder: string);
+    get items(): ISelectItem[];
     get select(): HTMLElement;
     get disabled(): boolean;
     set disabled(value: boolean);
@@ -552,15 +555,13 @@ export class Select {
     set selectedIndex(value: number);
     get placeholder(): string;
     set placeholder(value: string);
-    get label(): HTMLElement;
-    get previousSelectedIndex(): number;
+    get label(): HTMLLabelElement;
     onChange({ index, value }: {
         index: any;
         value: any;
     }): void;
     update(array: ISelectItem[], selectedIndex?: number): void;
 }
-export {};
 export class ViewerToolbar extends Toolbar {
 }
 interface ElementClass {
@@ -622,6 +623,10 @@ export abstract class SettingsBase implements ISettings {
     getSettingValue<T>(name: string): T;
     protected abstract getKeyWithPrefix(key: string): string;
 }
+export function createSvgElement(svgString: string): HTMLElement;
+export function isString(element: any): boolean;
+export function isSvg(element: string): boolean;
+export function isSvgString(element: any): boolean;
 export const MouseButtons: {
     Left: number;
     Middle: number;
@@ -753,7 +758,7 @@ export interface ICameraControl {
      * @param iOrientation - camera orientation after zooming (optional)
      * @param isAnimationEnabled - is animated zoom enabled
      */
-    zoomToFit(bb: THREE.Box3, iOrientation?: CameraOrientation, iAnimationEnabled?: boolean): void;
+    zoomToFit(boundingBox: THREE.Box3, iOrientation?: CameraOrientation, iAnimationEnabled?: boolean): void;
     /**
      * Gets the navigation mode.
      */
@@ -872,7 +877,7 @@ export interface IIntersectionChecker<TOptions> {
      */
     getIntersectionPoint(): THREE.Intersection<THREE.Object3D> | undefined;
     /**
-     * Gets {@link THREE.Intersection} between a casted {@link ray} and model object.
+     * Gets {@link THREE.Intersection<THREE.Object3D>} between a casted {@link ray} and model object.
      * @param ray
      * @param camera
      * @param options - (optional) intersection check options.
@@ -916,6 +921,20 @@ export interface IIntersectionChecker<TOptions> {
         modelId: string;
         guid: string;
     }[];
+    /**
+     * Gets all intersections between a ray, casted from {@link camera} to {@link ndcPoint} and model objects.
+     * @param ray
+     * @param camera
+     * @param options - (optional) intersection check options.
+     */
+    getAllIntersectionsByRay(ray: THREE.Ray, camera: THREE.Camera, options?: TOptions): THREE.Intersection<THREE.Object3D>[];
+    /**
+     * Gets IDs of the model objects intersected by ray, casted from {@link camera} to {@link ndcPoint}.
+     * @param ndcPos
+     * @param camera
+     * @param options - (optional) intersection check options.
+     */
+    getAllIntersectionsByNdcPt(ndcPos: THREE.Vector2, camera: THREE.Camera, options?: TOptions): THREE.Intersection<THREE.Object3D>[];
 }
 export interface ISceneIntersectionChecker extends IIntersectionChecker<SceneCheckOptions> {
     /** Gets the bounding box of the scene*/
@@ -1034,6 +1053,7 @@ export interface I3DRenderer {
     render(scene: THREE.Object3D, camera: THREE.Camera): void;
     getSize(target: THREE.Vector2): THREE.Vector2;
     setSize(width: number, height: number, updateStyle?: boolean): void;
+    setPixelRatio(value: number): void;
     setViewport(x: THREE.Vector4 | number, y?: number, width?: number, height?: number): void;
     getViewport(target: THREE.Vector4): THREE.Vector4;
     dispose(): void;
@@ -1048,13 +1068,15 @@ export interface IRenderViewer3D {
      * An object can only be placed on one scene.
      * @param iObj - object to place.
      * @param sceneID - (optional) scene name. `MainScene` by default.
+     * @param redraw - (optional) force a redraw of the scene after adding an object. False by default.
      */
-    placeObjectOnScene(iObj: THREE.Object3D, sceneID?: string): Promise<void>;
+    placeObjectOnScene(iObj: THREE.Object3D, sceneID?: string, redraw?: boolean): Promise<void>;
     /**
      * Remove object from scene.
-     * @param iObj
+     * @param iObj - object to remove.
+     * @param redraw - (optional) force a redraw of the scene after removing an object. False by default.
      */
-    removeObjectFromScene(iObj: THREE.Object3D): Promise<void>;
+    removeObjectFromScene(iObj: THREE.Object3D, redraw?: boolean): Promise<void>;
     /**
      * Set clipping planes for rendering.
      * @param planes - array of clipping planes.
@@ -2972,6 +2994,7 @@ export class DeletionManager {
  * This class describes the coordination model. The coordination model contains parts of the model (aka ModelPart).
  */
 export class Model {
+    readonly eventDispatcher: IEventsDispatcher;
     /**
      * Returns all model parts loaded in the viewer.
      * @returns {ModelPart[]} - An array of visible and hidden model parts
@@ -3123,6 +3146,21 @@ export class Model {
      * @param filter - filter to remove.
      */
     removeDeletionFilter(filter: DeleteEventFilter): void;
+    /**
+     * Set model version.
+     * @param value - specified version of the model.
+     */
+    setModelVersion(value: bigint): void;
+    /**
+     * Get current version of the model.
+     * @returns current model version.
+     */
+    getModelVersion(): bigint;
+    /**
+     * Get list of all model versions.
+     * @returns list of all model versions.
+     */
+    getAllModelVersions(): bigint[];
 }
 export interface INavigation {
     /**
@@ -3150,30 +3188,18 @@ export interface INavigation {
      * Gets navigation area rectangle
      */
     getNavigationArea(): DOMRect;
-    /**
-     * Sets the camera parameters.
-     */
-    setCameraParameters(params: CameraParameters): void;
-    /**
-     * Gets the camera parameters.
-     */
-    getCameraParameters(): CameraParameters;
     /**
      * Gets the camera control.
      */
     getCameraControl(): ICameraControl;
     /**
-     * Gets the Three.js camera.
-     */
-    getCamera(): THREE.Camera;
-    /**
-     * Fits camera to objects by IDs.
+     * Fits camera to objects by IDs. It fits the entire model if no ID is provided.
      * @param {string[] | string} elementIds  - element or array of elements
      * @param {string | ModelPart} modelPart - the model part id or the model part instance containing the elements.
      * @param {boolean} immediate - true to avoid the default transition.
      * @returns
      */
-    fitToView(elementIds: string[] | string, modelPart: string | ModelPart, immediate?: boolean): void;
+    fitToView(elementIds?: string[] | string, modelPart?: string | ModelPart, immediate?: boolean): void;
     /**
      * Sets the camera pivot point.
      */
@@ -3207,7 +3233,7 @@ export class Viewer3D extends ViewerBase {
     get navigation(): INavigation;
     getConfiguration(): Viewer3DConfiguration;
     start(): Promise<number>;
-    finish(): void;
+    finish(): Promise<void>;
     /**
      * Loads new model part to the viewer
      * @param buffer
@@ -3216,12 +3242,28 @@ export class Viewer3D extends ViewerBase {
      * @param onErrorCallback
      */
     loadModelPart(data: ArrayBuffer | string, options: ModelLoadingOptions, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
+    /**
+     * Updates the model part data file
+     * @param data
+     * @param options
+     * @param onSuccessCallback
+     * @param onErrorCallback
+     */
+    updateModelPart(data: ArrayBuffer | string, options: ModelLoadingOptions, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
     /**
      * unloads model part from the viewer
      * @param modelPart - model part id or model part instance
      */
     unloadModelPart(modelPart?: string | ModelPart): void;
+    /**
+     * Sets virtual origin of the model
+     * @param point \{ x , y , z } coordinates of the virtual origin
+     */
     setVirtualOrigin(point: Point3): Promise<void>;
+    /**
+     * Gets virtual origin of the model
+     * @returns \{ x , y , z } coordinates of the virtual origin
+     */
     getVirtualOrigin(): Point3;
     /**
      * Makes screenshot

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "24.0.1",
+  "version": "24.4.0",
   "description": "TypeScript definitions for ASCON PilotWeb3D component",
   "main": "",
   "types": "index.d.ts",