@pilotdev/pilot-web-3d 24.20.0 → 24.22.0

package/index.d.ts

@@ -45,7 +45,13 @@ export class Color {
     toArray(array: Array<number>, offset?: number): Array<number>;
     clone(): Color;
 }
-export abstract class ViewObject extends THREE.Object3D {
+export interface ViewObjectEventMap extends THREE.Object3DEventMap {
+    dispose: object;
+    update: {
+        updateType: UpdateType;
+    };
+}
+export abstract class ViewObject extends THREE.Object3D<ViewObjectEventMap> {
     protected _isDisposed: boolean;
     protected _isSelected: boolean;
     protected _isHovered: boolean;
@@ -77,7 +83,7 @@ export abstract class ViewObject extends THREE.Object3D {
     /**Edge representation of the object */
     abstract get edges(): THREE.LineSegments | null;
     add(...object: THREE.Object3D[]): this;
-    remove(...object: THREE.Object3D<THREE.Event>[]): this;
+    remove(...object: THREE.Object3D[]): this;
     updateMatrixWorld(force?: boolean): void;
     updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void;
     updateMatrix(): void;
@@ -656,16 +662,16 @@ export class ClickedEvent extends Event {
     modelId: string;
     modelElementId: string;
     ctrlKey: boolean;
-    intersection?: THREE.Intersection<THREE.Object3D>;
+    intersection?: THREE.Intersection;
     
-    constructor(type: string, modelId: string, modelElementId: string, ctrlKey: boolean, intersection?: THREE.Intersection<THREE.Object3D>);
+    constructor(type: string, modelId: string, modelElementId: string, ctrlKey: boolean, intersection?: THREE.Intersection);
 }
 export class HoverEvent extends Event {
     modelId: string;
     modelElementId: string;
-    intersection?: THREE.Intersection<THREE.Object3D>;
+    intersection?: THREE.Intersection;
     
-    constructor(type: string, modelId: string, modelElementId: string, intersection?: THREE.Intersection<THREE.Object3D>);
+    constructor(type: string, modelId: string, modelElementId: string, intersection?: THREE.Intersection);
 }
 export class GlobalEvents {
     static events: EventsDispatcherCore;
@@ -677,6 +683,8 @@ export class RenderViewSettings {
     displayMode?: DisplayMode;
     cameraMode?: CameraMode;
     orthoNavigationCube?: boolean;
+    hideSmallElements?: boolean;
+    smallObjectSize?: number;
     /** Desired render framerate */
     desiredFramerate?: number;
     /** Allocated time for rendering operations, excluding scene rendering */
@@ -927,12 +935,12 @@ export interface ModelCheckOptions extends SceneCheckOptions {
 }
 export interface IIntersectionChecker<TOptions> {
     /**
-     * Gets {@link THREE.Intersection<THREE.Object3D>} between a casted {@link ray} and model object.
+     * Gets {@link THREE.Intersection} between a casted {@link ray} and model object.
      * @param ray
      * @param camera
      * @param options - (optional) intersection check options.
      */
-    getIntersectionByRay(ray: THREE.Ray, camera: THREE.Camera, options?: TOptions): THREE.Intersection<THREE.Object3D> | undefined;
+    getIntersectionByRay(ray: THREE.Ray, camera: THREE.Camera, options?: TOptions): THREE.Intersection | undefined;
     /**
      * Gets ID of the model object intersected by {@link ray}
      * @param ray
@@ -949,7 +957,7 @@ export interface IIntersectionChecker<TOptions> {
      * @param camera
      * @param options - (optional) intersection check options.
      */
-    getIntersectionByNdcPt(ndcPoint: THREE.Vector2, camera: THREE.Camera, options?: TOptions): THREE.Intersection<THREE.Object3D> | undefined;
+    getIntersectionByNdcPt(ndcPoint: THREE.Vector2, camera: THREE.Camera, options?: TOptions): THREE.Intersection | undefined;
     /**
      * Gets ID of the model object intersected by ray, casted from {@link camera} to {@link ndcPoint}.
      * @param ndcPoint
@@ -977,14 +985,20 @@ export interface IIntersectionChecker<TOptions> {
      * @param camera
      * @param options - (optional) intersection check options.
      */
-    getAllIntersectionsByRay(ray: THREE.Ray, camera: THREE.Camera, options?: TOptions): THREE.Intersection<THREE.Object3D>[];
+    getAllIntersectionsByRay(ray: THREE.Ray, camera: THREE.Camera, options?: TOptions): THREE.Intersection[];
     /**
      * 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>[];
+    getAllIntersectionsByNdcPt(ndcPos: THREE.Vector2, camera: THREE.Camera, options?: TOptions): THREE.Intersection[];
+    /**
+     * Gets bounding box of the model elements.
+     * @param elements
+     * @param options
+     */
+    getObjectsBoundingBox(elements: ModelElementIds[], options?: TOptions): THREE.Box3;
 }
 export interface ISceneIntersectionChecker extends IIntersectionChecker<SceneCheckOptions> {
     /** Gets the bounding box of the scene*/
@@ -997,7 +1011,7 @@ export interface IModelIntersectionChecker extends IIntersectionChecker<ModelChe
     get modelCenter(): THREE.Vector3;
 }
 export interface I3DRenderer {
-    clippingPlanes: THREE.Plane[];
+    clippingPlanes: readonly THREE.Plane[];
     domElement: HTMLCanvasElement;
     clear(color?: boolean, depth?: boolean, stencil?: boolean): void;
     getClearColor(target: THREE.Color): THREE.Color;
@@ -1267,7 +1281,7 @@ export interface IGizmoObject extends THREE.Object3D {
     setActive(value: boolean): void;
     dispose(): void;
 }
-export class GizmoObject extends THREE.Object3D implements IGizmoObject {
+export class GizmoObject extends THREE.Object3D<ViewObjectEventMap> implements IGizmoObject {
     protected _meshes: THREE.Mesh[];
     readonly baseMaterial: THREE.Material;
     readonly hoverMaterial: THREE.Material;
@@ -1279,9 +1293,9 @@ export class GizmoObject extends THREE.Object3D implements IGizmoObject {
     getActive(): boolean;
     setActive(value: boolean): void;
     dispose(): void;
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
 }
-export abstract class GizmoAxis extends THREE.Object3D implements IGizmoObject {
+export abstract class GizmoAxis extends THREE.Object3D<ViewObjectEventMap> implements IGizmoObject {
     readonly handle: IGizmoObject;
     readonly picker?: IGizmoObject;
     readonly helper?: IGizmoObject;
@@ -1300,7 +1314,7 @@ export abstract class GizmoAxis extends THREE.Object3D implements IGizmoObject {
     getHovered(): boolean;
     setHovered(value: boolean): void;
     dispose(): void;
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
     abstract moveByNdcPt(ndcPos: THREE.Vector2, camera: THREE.Camera): THREE.Matrix4;
     protected abstract updateGizmoPlane(camera: THREE.Camera): void;
     protected setStartPt(ndcPos: THREE.Vector2, camera: THREE.Camera): void;
@@ -1328,7 +1342,12 @@ export class GizmoScaleAxis extends GizmoAxis {
     moveByNdcPt(ndcPos: THREE.Vector2, camera: THREE.Camera): THREE.Matrix4;
     protected updateGizmoPlane(camera: THREE.Camera): void;
 }
-export class GizmoControl extends THREE.Object3D {
+export interface GizmoEventMap extends ViewObjectEventMap {
+    activeAxisChanged: {
+        isAxisActive: boolean;
+    };
+}
+export class GizmoControl extends THREE.Object3D<GizmoEventMap> {
     
     constructor(camera: THREE.Camera, navAgent: INavigationAgent);
     attachTo(object: THREE.Object3D, asChild?: boolean): void;
@@ -1368,7 +1387,7 @@ export abstract class CustomMaterial extends THREE.ShaderMaterial {
     protected refreshUniforms(uniforms: {
         [uniform: string]: THREE.IUniform;
     }, material: CustomMaterial, renderer: THREE.WebGLRenderer): void;
-    protected onBeforeCompileCallback(shader: THREE.Shader): void;
+    protected onBeforeCompileCallback(parameters: THREE.WebGLProgramParametersWithUniforms, renderer: THREE.WebGLRenderer): void;
     protected refreshTransformUniform(map: THREE.Texture, uniform: THREE.IUniform): void;
     protected onBeforeRender(renderer: THREE.WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: THREE.BufferGeometry, material: THREE.Material, group: THREE.Group): void;
     protected materialHash(opacity?: number, color?: THREE.Color): number;
@@ -1629,7 +1648,7 @@ export class MeshLineGeometry extends THREE.InstancedBufferGeometry {
     computeBoundingBox(): void;
     computeBoundingSphere(): void;
 }
-export class MeshLine extends THREE.Mesh {
+export class MeshLine extends THREE.Mesh<MeshLineGeometry, MeshLineMaterial, ViewObjectEventMap> {
     type: string;
     material: MeshLineMaterial;
     geometry: MeshLineGeometry;
@@ -1641,7 +1660,7 @@ export class CustomSprite extends THREE.Sprite {
     material: CustomSpriteMaterial;
     
     constructor(material: CustomSpriteMaterial);
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
     dispose(): void;
 }
 export interface LabelSpriteParameters {
@@ -1737,7 +1756,7 @@ export interface MeshPointParamter {
     color?: Color;
     size?: number;
 }
-export class MeshPoints extends THREE.Mesh {
+export class MeshPoints extends THREE.Mesh<THREE.InstancedBufferGeometry, MeshPointMaterial, ViewObjectEventMap> {
     geometry: THREE.InstancedBufferGeometry;
     material: MeshPointMaterial;
     
@@ -1759,7 +1778,7 @@ export class MeshPoints extends THREE.Mesh {
     removePoint(index: number): this;
     updateAttributes(): void;
     dispose(): void;
-    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
 }
 export interface ModelPart {
     get id(): string;
@@ -3006,7 +3025,7 @@ export class SettingsNames {
     static GLOBAL_LIGHT: string;
     static LIGHT_SOURCE: string;
     static ANTI_ALIASING: string;
-    static HIDE_SMALL_ELEMENTS_MOVING: string;
+    static HIDE_SMALL_ELEMENTS: string;
     static SMALL_ELEMENT_SIZE: string;
     static LABEL_LINE_LENGTH: string;
     static HIDE_EDGES_WHEN_NAVIGATING: string;
@@ -3035,8 +3054,8 @@ export class Viewer3DConfiguration extends ViewerConfiguration {
 export const defaultViewer3DSettings: ViewerSettings;
 export interface IBatchedMaterial extends CustomMaterial {
     textureSize: number;
-    blockPosTexture: DataTexture;
-    colorTexture: DataTexture;
+    blockPosTexture: THREE.DataTexture;
+    colorTexture: THREE.DataTexture;
     useBlockPosTexture: boolean;
     useBlockColorTexture: boolean;
 }
@@ -3055,11 +3074,11 @@ class BatchedMaterialBase extends CustomMaterial implements IBatchedMaterial {
     /**
      * @default null
      */
-    blockPosTexture: DataTexture;
+    blockPosTexture: THREE.DataTexture;
     /**
      * @default null
      */
-    colorTexture: DataTexture;
+    colorTexture: THREE.DataTexture;
     /**
      * @default true
      */
@@ -3151,10 +3170,11 @@ export class Model {
     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[] | 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.
+     * @param {boolean} recursive - set to hide child elements. True by default.
      */
-    hide(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    hide(elementIds: string[] | string, modelPart?: string | ModelPart, recursive?: boolean): void;
     /**
      * Hides all elements and model parts from the viewer
      */
@@ -3164,9 +3184,10 @@ export class Model {
      *
      * @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.
+     * @param {boolean} recursive - set to show child elements. True by default.
      *
      */
-    show(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    show(elementIds: string[] | string, modelPart?: string | ModelPart, recursive?: boolean): void;
     /**
      * Shows all elements and model parts
      */
@@ -3175,26 +3196,30 @@ export class Model {
      * Isolate elements of one model part.
      * @param elementIds - An array of model elements or just a single model element.
      * @param modelPart - id of the model part that contains the model element id. By default uses the initial model part loaded into the scene.
+     * @param {boolean} recursive - add child elements to isolated. True by default.
      */
-    isolate(elementIds: string[], modelPart: string | ModelPart): void;
+    isolate(elementIds: string[], modelPart: string | ModelPart, recursive?: boolean): void;
     /**
      * Isolate group of elements.
      * @param elements - Array of grouped model elements to isolate.
+     * @param {boolean} recursive - add child elements to isolated. True by default.
      */
-    isolateMultiple(elements: ModelElementIds[]): void;
+    isolateMultiple(elements: ModelElementIds[], recursive?: boolean): 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.
+     * @param {boolean} recursive - add child elements to selection. False by default.
      */
-    select(elementIds: string[] | string, modelPart: string | ModelPart, selectionMode: SelectionMode): void;
+    select(elementIds: string[] | string, modelPart: string | ModelPart, selectionMode: SelectionMode, recursive?: boolean): void;
     /**
      * Deselects 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.
+     * @param {boolean} recursive - deselect child elements. False by default.
      */
-    deselect(elementIds: string[] | string, modelPart?: string | ModelPart): void;
+    deselect(elementIds: string[] | string, modelPart?: string | ModelPart, recursive?: boolean): void;
     /**
      * Unselect all model elements in all model parts
      */
@@ -3324,7 +3349,7 @@ export interface INavigation {
      * @param {CameraOrientation} cameraOrientation - final orientation of the camera after fitting.
      * @returns
      */
-    fitToView(elementIds?: string[] | string, modelPart?: string | ModelPart, immediate?: boolean, cameraOrientation?: CameraOrientation): void;
+    fitToView(elementIds?: string[] | string | ModelElementIds[], modelPart?: string | ModelPart, immediate?: boolean, cameraOrientation?: CameraOrientation): void;
     /**
      * Sets the camera pivot point.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-3d",
-  "version": "24.20.0",
+  "version": "24.22.0",
   "description": "TypeScript definitions for ASCON PilotWeb3D component",
   "main": "",
   "types": "index.d.ts",
@@ -9,7 +9,7 @@
   "license": "MIT",
   "typeScriptVersion": "4.9.4",
   "dependencies": {
-    "@types/three": "0.148.0"
+    "@types/three": "0.161.0"
   },
   "keywords": [
     "pilotdev",