@inweb/viewer-three 25.12.0 → 26.1.0

package/lib/Viewer/Viewer.d.ts

@@ -2,7 +2,7 @@ import { Box3, Object3D, PerspectiveCamera, Scene, Vector3, WebGLRenderer } from
 import { GLTF } from "three/examples/jsm/loaders/GLTFLoader.js";
 import { EventEmitter2 } from "@inweb/eventemitter2";
 import { Assembly, Client, Model, File } from "@inweb/client";
-import { CanvasEventMap, IDragger, IOptions, IViewer, IViewpoint, Options, OptionsEventMap, ViewerEventMap } from "@inweb/viewer-core";
+import { CanvasEventMap, IComponent, IDragger, IOptions, IViewer, IViewpoint, Options, OptionsEventMap, ViewerEventMap } from "@inweb/viewer-core";
 import { IMarkup, IWorldTransform } from "@inweb/markup";
 /**
  * 3D viewer powered by {@link https://threejs.org/ | Three.js}.
@@ -21,9 +21,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     selected: Array<Object3D>;
     extents: Box3;
     target: Vector3;
-    private draggerFactory;
     private _activeDragger;
-    private components;
+    private _components;
     private renderNeeded;
     private renderTime;
     private _markup;
@@ -35,6 +34,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     constructor(client?: Client);
     get options(): IOptions;
     get draggers(): string[];
+    get components(): string[];
     /**
      * 2D markup core instance used to create markups.
      *
@@ -191,7 +191,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
         z: number;
     };
     executeCommand(id: string, ...args: any[]): any;
-    getComponent(type: any): any;
+    getComponent(name: string): IComponent;
     drawViewpoint(viewpoint: IViewpoint): void;
     createViewpoint(): IViewpoint;
 }

package/lib/Viewer/commands/ApplyModelTransform.d.ts

@@ -1 +1,3 @@
-export {};
+import type { Model, File, Assembly } from "@inweb/client";
+import type { Viewer } from "../Viewer";
+export declare function applyModelTransform(viewer: Viewer, model: Model | File | Assembly): void;

package/lib/Viewer/commands/ClearMarkup.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function clearMarkup(viewer: Viewer): void;

package/lib/Viewer/commands/ClearSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function clearSelected(viewer: Viewer): void;

package/lib/Viewer/commands/ClearSlices.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function clearSlices(viewer: Viewer): void;

package/lib/Viewer/commands/CreatePreview.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function createPreview(viewer: Viewer, type?: string, encoderOptions?: number): string;

package/lib/Viewer/commands/Explode.d.ts

@@ -1 +1,3 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function explode(viewer: Viewer, index?: number): void;
+export declare function collect(viewer: Viewer): void;

package/lib/Viewer/commands/GetDefaultViewPositions.d.ts

@@ -1 +1 @@
-export {};
+export declare function getDefaultViewPositions(): string[];

package/lib/Viewer/commands/GetModels.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function getModels(viewer: Viewer): string[];

package/lib/Viewer/commands/GetSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function getSelected(viewer: Viewer): string[];

package/lib/Viewer/commands/HideSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function hideSelected(viewer: Viewer): void;

package/lib/Viewer/commands/IsolateSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function isolateSelected(viewer: Viewer): void;

package/lib/Viewer/commands/RegenerateAll.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function regenerateAll(viewer: Viewer): void;

package/lib/Viewer/commands/ResetView.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function resetView(viewer: Viewer): void;

package/lib/Viewer/commands/SelectModel.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function selectModel(viewer: Viewer, handle: string): void;

package/lib/Viewer/commands/SetActiveDragger.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function setActiveDragger(viewer: Viewer, dragger?: string): void;

package/lib/Viewer/commands/SetDefaultViewPosition.d.ts

@@ -1,4 +1,5 @@
 import { Vector3 } from "three";
+import type { Viewer } from "../Viewer";
 export declare const defaultViewPositions: {
     top: Vector3;
     bottom: Vector3;
@@ -11,3 +12,4 @@ export declare const defaultViewPositions: {
     ne: Vector3;
     nw: Vector3;
 };
+export declare function setDefaultViewPosition(viewer: Viewer, position: string): void;

package/lib/Viewer/commands/SetMarkupColor.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function setMarkupColor(viewer: Viewer, r?: number, g?: number, b?: number): void;

package/lib/Viewer/commands/SetSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function setSelected(viewer: Viewer, handles?: string[]): void;

package/lib/Viewer/commands/ShowAll.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function showAll(viewer: Viewer): void;

package/lib/Viewer/commands/ZoomToExtents.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function zoomToExtents(viewer: Viewer): void;

package/lib/Viewer/commands/ZoomToObjects.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function zoomToObjects(viewer: Viewer, handles?: string[]): void;

package/lib/Viewer/commands/ZoomToSelected.d.ts

@@ -1 +1,2 @@
-export {};
+import type { Viewer } from "../Viewer";
+export declare function zoomToSelected(viewer: Viewer): void;

package/lib/Viewer/commands/index.d.ts

@@ -1,22 +1,22 @@
-import "./ApplyModelTransform";
-import "./ClearMarkup";
-import "./ClearSelected";
-import "./ClearSlices";
-import "./CreatePreview";
-import "./Explode";
-import "./GetDefaultViewPositions";
-import "./GetModels";
-import "./GetSelected";
-import "./HideSelected";
-import "./IsolateSelected";
-import "./RegenerateAll";
-import "./ResetView";
-import "./SelectModel";
-import "./SetActiveDragger";
-import "./SetDefaultViewPosition";
-import "./SetMarkupColor";
-import "./SetSelected";
-import "./ShowAll";
-import "./ZoomToExtents";
-import "./ZoomToObjects";
-import "./ZoomToSelected";
+import { ICommandsRegistry } from "@inweb/viewer-core";
+/**
+ * A commands registry. Use this registry to register custom commands.
+ *
+ * To implement custom command:
+ *
+ * 1. Define a command handler with a first `viewer` parameter.
+ * 2. Register command handler in the commands registry by calling the {@link commands.registerCommand}.
+ *
+ * @example <caption>Implementing a custom command.</caption>
+ *   import { commands, Viewer } from "@inweb/viewer-three";
+ *
+ *   function commandHandler(viewer: Viewer, name = "world"): void {
+ *     console.log(`Hello ${name}!!!`);
+ *   }
+ *
+ *   commands.registerCommand("sayHello", commandHandler);
+ *
+ * @example <caption>Calling a custom command.</caption>
+ *   viewer.executeCommand("sayHello", "user");
+ */
+export declare const commands: ICommandsRegistry;

package/lib/Viewer/components/AxesHelperComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class AxesHelperComponent implements IDisposable {
+export declare class AxesHelperComponent implements IComponent {
     private viewer;
     private axesHelper1;
     private axesHelper2;

package/lib/Viewer/components/BackgroundComponent.d.ts

@@ -1,7 +1,7 @@
 import { Color } from "three";
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class BackgroundComponent implements IDisposable {
+export declare class BackgroundComponent implements IComponent {
     protected viewer: Viewer;
     protected backgroundColor: Color;
     constructor(viewer: Viewer);

package/lib/Viewer/components/DefaultPositionComponent.d.ts

@@ -1,7 +1,6 @@
-import { GeometryEndEvent } from "@inweb/viewer-core";
-import { IDisposable } from "../IDisposable";
+import { GeometryEndEvent, IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class DefaultPositionComponent implements IDisposable {
+export declare class DefaultPositionComponent implements IComponent {
     protected viewer: Viewer;
     defaultCameraPositions: any;
     constructor(viewer: Viewer);

package/lib/Viewer/components/ExtentsComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class ExtentsComponent implements IDisposable {
+export declare class ExtentsComponent implements IComponent {
     private viewer;
     constructor(viewer: Viewer);
     dispose(): void;

package/lib/Viewer/components/ExtentsHelperComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class ExtentsHelperComponent implements IDisposable {
+export declare class ExtentsHelperComponent implements IComponent {
     private viewer;
     private boxHelper;
     constructor(viewer: Viewer);

package/lib/Viewer/components/LightComponent.d.ts

@@ -1,7 +1,7 @@
 import { AmbientLight, DirectionalLight } from "three";
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class LightComponent implements IDisposable {
+export declare class LightComponent implements IComponent {
     protected viewer: Viewer;
     protected ambientLight: AmbientLight;
     protected directionalLight: DirectionalLight;

package/lib/Viewer/components/RenderLoopComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class RenderLoopComponent implements IDisposable {
+export declare class RenderLoopComponent implements IComponent {
     protected viewer: Viewer;
     protected requestId: number;
     constructor(viewer: Viewer);

package/lib/Viewer/components/ResizeCanvasComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class ResizeCanvasComponent implements IDisposable {
+export declare class ResizeCanvasComponent implements IComponent {
     protected viewer: Viewer;
     protected resizeObserver: ResizeObserver;
     constructor(viewer: Viewer);

package/lib/Viewer/components/SelectionComponent.d.ts

@@ -1,7 +1,7 @@
 import { Intersection, MeshBasicMaterial, Object3D, Raycaster, Vector2 } from "three";
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class SelectionComponent implements IDisposable {
+export declare class SelectionComponent implements IComponent {
     protected viewer: Viewer;
     protected raycaster: Raycaster;
     protected downPosition: Vector2;

package/lib/Viewer/components/ViewPositionComponent.d.ts

@@ -1,6 +1,5 @@
 import { Vector3 } from "three";
-import { CommandEvent, RenderEvent } from "@inweb/viewer-core";
-import { IDisposable } from "../IDisposable";
+import { CommandEvent, IComponent, RenderEvent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
 export declare const defaultViewPositions: {
     top: Vector3;
@@ -14,7 +13,7 @@ export declare const defaultViewPositions: {
     ne: Vector3;
     nw: Vector3;
 };
-export declare class ViewPositionComponent implements IDisposable {
+export declare class ViewPositionComponent implements IComponent {
     private position;
     private center;
     private targetPosition;

package/lib/Viewer/components/WCSHelperComponent.d.ts

@@ -1,6 +1,6 @@
-import { IDisposable } from "../IDisposable";
+import { IComponent } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
-export declare class WCSHelperComponent implements IDisposable {
+export declare class WCSHelperComponent implements IComponent {
     private wcsHelper;
     private viewer;
     constructor(viewer: Viewer);

package/lib/Viewer/components/index.d.ts

@@ -0,0 +1,40 @@
+import { IComponentsRegistry } from "@inweb/viewer-core";
+/**
+ * Viewer components registry. Use this registry to register custom components.
+ *
+ * To implement custom component:
+ *
+ * 1. Define a component class implements {@link IComponent}.
+ * 2. Define a constructor with a `viewer` parameter and add mouse event listeners for the specified viewer.
+ * 3. Define the component logic in the event listeners. For example, listen for the `mousedown`
+ *    event and select objects when the left mouse button is pressed.
+ * 4. Override {@link IComponent.dispose} and remove mouse event listeners from the viewer.
+ * 5. Register component provider in the components registry by calling the
+ *    {@link components.registerComponent}.
+ *
+ * @example <caption>Implementing a custom component.</caption>
+ *   import { IComponent, components, Viewer } from "@inweb/viewer-three";
+ *
+ *   class MyComponent implements IComponent {
+ *     protected viewer: Viewer;
+ *
+ *     constructor(viewer: Viewer) {
+ *       this.viewer = viewer;
+ *       this.viewer.addEventListener("mousedown", this.onMouseDown);
+ *     }
+ *
+ *     override dispose() {
+ *       this.viewer.removeEventListener("mousedown", this.onMouseDown);
+ *     }
+ *
+ *     onMouseDown = (event: PointerEvent) => {
+ *       // place custom logic here
+ *     };
+ *   }
+ *
+ *   components.registerComponent(
+ *     "MyComponent",
+ *     (viewer): IComponent => new MyComponent(viewer)
+ *   );
+ */
+export declare const components: IComponentsRegistry;

package/lib/Viewer/draggers/OrbitDragger.d.ts

@@ -1,7 +1,7 @@
-import type { IDisposable } from "../IDisposable";
+import { type IDragger } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
 import { OrbitControls } from "../controls/OrbitControls.js";
-export declare class OrbitDragger implements IDisposable {
+export declare class OrbitDragger implements IDragger {
     protected viewer: Viewer;
     protected orbit: OrbitControls;
     protected changed: boolean;

package/lib/Viewer/draggers/WalkDragger.d.ts

@@ -1,6 +1,7 @@
+import { type IDragger } from "@inweb/viewer-core";
 import type { Viewer } from "../Viewer";
 import { WalkControls } from "../controls/WalkControls";
-export declare class WalkDragger {
+export declare class WalkDragger implements IDragger {
     protected viewer: Viewer;
     controls: WalkControls;
     constructor(viewer: Viewer);

package/lib/Viewer/draggers/index.d.ts

@@ -0,0 +1,39 @@
+import { IDraggersRegistry } from "@inweb/viewer-core";
+/**
+ * Viewer draggers registry. Use this registry to register custom draggers.
+ *
+ * To implement custom dragger:
+ *
+ * 1. Define a dragger class implements {@link IDragger}.
+ * 2. Define a constructor with a `viewer` parameter and add mouse event listeners for the specified viewer.
+ * 3. Define the dragger logic in the event listeners. For example, listen for the `mousemove`
+ *    event and zoom in/out when the left mouse button is pressed.
+ * 4. Override {@link IDragger.dispose} and remove mouse event listeners from the viewer.
+ * 5. Register dragger provider in the draggers registry by calling the {@link draggers.registerDragger}.
+ *
+ * @example <caption>Implementing a custom dragger.</caption>
+ *   import { IDragger, draggers, Viewer } from "@inweb/viewer-three";
+ *
+ *   class MyDragger implements IDragger {
+ *     protected viewer: Viewer;
+ *
+ *     constructor(viewer: Viewer) {
+ *       this.viewer = viewer;
+ *       this.viewer.addEventListener("pointermove", this.onPointerMove);
+ *     }
+ *
+ *     override dispose() {
+ *       this.viewer.removeEventListener("pointermove", this.onPointerMove);
+ *     }
+ *
+ *     onPointerMove = (event: PointerEvent) => {
+ *       // place custom logic here
+ *     };
+ *   }
+ *
+ *   draggers.registerDragger("MyDragger", (viewer): IDragger => new MyDragger(viewer));
+ *
+ * @example <caption>Activating a custom dragger.</caption>
+ *   viewer.setActiveDragger("MyDragger");
+ */
+export declare const draggers: IDraggersRegistry;

package/lib/index.d.ts

@@ -1,3 +1,6 @@
-import "./Viewer/commands";
 export * from "@inweb/viewer-core";
+export * from "@inweb/markup";
+export { draggers } from "./Viewer/draggers";
+export { commands } from "./Viewer/commands";
+export { components } from "./Viewer/components";
 export { Viewer } from "./Viewer/Viewer";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-three",
-  "version": "25.12.0",
+  "version": "26.1.0",
   "description": "JavaScript library for rendering CAD and BIM files in a browser using Three.js",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -28,10 +28,10 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~25.12.0",
-    "@inweb/eventemitter2": "~25.12.0",
-    "@inweb/markup": "~25.12.0",
-    "@inweb/viewer-core": "~25.12.0"
+    "@inweb/client": "~26.1.0",
+    "@inweb/eventemitter2": "~26.1.0",
+    "@inweb/markup": "~26.1.0",
+    "@inweb/viewer-core": "~26.1.0"
   },
   "devDependencies": {
     "@types/three": "^0.169.0",