vim-web 0.3.44-dev.39 → 0.3.44-dev.40

package/dist/types/core-viewers/{webgl/viewer/inputs/input.d.ts → shared/coreInputHandler.d.ts}

@@ -1,48 +1,36 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-import * as THREE from 'three';
-import { Viewer } from '../viewer';
-import { KeyboardHandler } from './keyboardHandler';
 import { TouchHandler } from './touchHandler';
 import { MouseHandler } from './mouseHandler';
-import { InputAction } from '../raycaster';
-export { KEYS } from './keyboardHandler';
-/** Pointers mode supported by the viewer */
+import { KeyboardHandler } from './keyboardHandler';
+import * as THREE from 'three';
+import { InputHandler } from './inputHandler';
 export type PointerMode = 'orbit' | 'look' | 'pan' | 'zoom' | 'rect';
-/**
- * Defines an input scheme for the viewer.
- */
-export interface InputScheme {
-    /**
-     * Called when mouse clicked or mobile tap.
-     */
-    onMainAction(hit: InputAction): void;
-    /**
-     * Called once when mouse and camera have been idle for some time with the position where it stopped.
-     * Called once when the mouse moves again with undefined
-     */
-    onIdleAction(hit: InputAction | undefined): void;
-    /**
-     * Called when a key is pressed and released.
-     */
-    onKeyAction(key: number): boolean;
+export interface InputAdapter {
+    init: () => void;
+    toggleOrthographic: () => void;
+    resetCamera: () => void;
+    clearSelection: () => void;
+    frameCamera: () => void;
+    moveCamera: (value: THREE.Vector3) => void;
+    orbitCamera: (value: THREE.Vector2) => void;
+    rotateCamera: (value: THREE.Vector2) => void;
+    panCamera: (value: THREE.Vector2) => void;
+    keyDown: (keyCode: string) => boolean;
+    keyUp: (keyCode: string) => boolean;
+    mouseDown: (pos: THREE.Vector2, button: number) => void;
+    mouseUp: (pos: THREE.Vector2, button: number) => void;
+    mouseMove: (pos: THREE.Vector2) => void;
+    selectAtPointer: (pos: THREE.Vector2, add: boolean) => void;
+    frameAtPointer: (pos: THREE.Vector2) => void;
+    zoom: (value: number) => void;
 }
-/**
- * Vim viewer default input scheme
- */
-export declare class DefaultInputScheme implements InputScheme {
-    private _viewer;
-    constructor(viewer: Viewer);
-    onMainAction(action: InputAction): void;
-    onIdleAction(hit: InputAction): void;
-    onKeyAction(key: number): boolean;
+interface InputSettings {
+    orbit: boolean;
+    scrollSpeed: number;
+    moveSpeed: number;
+    rotateSpeed: number;
+    orbitSpeed: number;
 }
-/**
- * Manages and registers all viewer user inputs for mouse, keyboard and touch
- */
-export declare class Input {
-    private _viewer;
+export declare class CoreInputHandler extends InputHandler {
     /**
      * Touch input handler
      */
@@ -55,10 +43,22 @@ export declare class Input {
      * Keyboard input handler
      */
     keyboard: KeyboardHandler;
+    scrollSpeed: number;
+    private _moveSpeed;
+    rotateSpeed: number;
+    orbitSpeed: number;
     private _pointerActive;
     private _pointerFallback;
     private _pointerOverride;
-    constructor(viewer: Viewer);
+    private _onPointerOverrideChanged;
+    private _onPointerModeChanged;
+    private _onSettingsChanged;
+    private _adapter;
+    constructor(canvas: HTMLCanvasElement, adapter: InputAdapter, settings?: Partial<InputSettings>);
+    init(): void;
+    get moveSpeed(): number;
+    set moveSpeed(value: number);
+    get onSettingsChanged(): import("ste-signals").ISignal;
     /**
      * Returns the last main mode (orbit, look) that was active.
      */
@@ -70,18 +70,16 @@ export declare class Input {
     /**
      * A temporary pointer mode used for temporary icons.
      */
-    get pointerOverride(): PointerMode | undefined;
+    get pointerOverride(): PointerMode;
     set pointerOverride(value: PointerMode | undefined);
     /**
      * Changes pointer interaction mode. Look mode will set camera orbitMode to false.
      */
     set pointerActive(value: PointerMode);
-    private _onPointerModeChanged;
     /**
      * Event called when pointer interaction mode changes.
      */
     get onPointerModeChanged(): import("ste-signals").ISignal;
-    private _onPointerOverrideChanged;
     /**
      * Event called when the pointer is temporarily overriden.
      */
@@ -91,31 +89,13 @@ export declare class Input {
      * Event called when when context menu could be displayed
      */
     get onContextMenu(): import("ste-simple-events").ISimpleEvent<THREE.Vector2>;
-    private _scheme;
-    /**
-     * Get or set the current viewer input scheme, set undefined to revert to default.
-     */
-    get scheme(): InputScheme | undefined;
-    set scheme(value: InputScheme | undefined);
-    /**
-     * Calls main action on the current input scheme
-     */
-    MainAction(action: InputAction): void;
-    /**
-     * Calls idle action on the current input scheme
-     */
-    IdleAction(action: InputAction | undefined): void;
-    /**
-     * Calls key action on the current input scheme
-     */
-    KeyAction(key: number): boolean;
     /**
      * Calls context menu action
      */
     ContextMenu(position: THREE.Vector2 | undefined): void;
     /**
-     * Register inputs handlers for default viewer behavior
-     */
+   * Register inputs handlers for default viewer behavior
+   */
     registerAll(): void;
     /**
      * Unregisters all input handlers
@@ -125,4 +105,6 @@ export declare class Input {
      * Resets all input state
      */
     resetAll(): void;
+    dispose(): void;
 }
+export {};

package/dist/types/core-viewers/{webgl/viewer/inputs → shared}/inputHandler.d.ts

@@ -1,17 +1,16 @@
 /**
  * @module viw-webgl-viewer/inputs
  */
-import { Viewer } from '../viewer';
 /**
  * TODO: Use the same code for ULTRA and webgl.
  * Base class for various input handlers.
  * It provides convenience to register to and unregister from events.
  */
 export declare class InputHandler {
-    protected _viewer: Viewer;
-    protected _unregisters: Function[];
-    constructor(viewer: Viewer);
-    protected reg: (handler: Document | HTMLElement | Window, type: string, listener: (event: any) => void) => void;
+    protected _canvas: HTMLCanvasElement;
+    protected _disconnect: Function[];
+    constructor(canvas: HTMLCanvasElement);
+    protected reg<T extends Event>(element: Document | HTMLElement | Window, eventType: string, callback: (event: T) => void): void;
     /**
      * Register handler to related browser events
      * Prevents double registrations

package/dist/types/core-viewers/shared/keyboardHandler.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @module viw-webgl-viewer/inputs
+ */
+import * as THREE from 'three';
+import { InputHandler } from './inputHandler';
+type CallbackMode = 'replace' | 'append' | 'prepend';
+/**
+ * KeyboardHandler
+ *
+ * A modern keyboard handler that manages keyboard events using a stateful pattern.
+ * It supports separate handlers for key down, key up, and continuous key pressed events.
+ * The handler calculates a movement vector based on currently pressed keys.
+ */
+export declare class KeyboardHandler extends InputHandler {
+    /**
+     * Callback invoked whenever the calculated movement vector is updated.
+     */
+    onMove: (value: THREE.Vector3) => void;
+    onKeyUp: (code: string) => boolean;
+    onKeyDown: (code: string) => boolean;
+    /**
+     * Speed multiplier applied when the Shift key is held.
+     * @private
+     */
+    private readonly SHIFT_MULTIPLIER;
+    /**
+     * Set of currently pressed key codes.
+     * @private
+     */
+    private pressedKeys;
+    /**
+     * Map of key down event handlers (invoked once on key down).
+     * @private
+     */
+    private keyDownHandlers;
+    /**
+     * Map of key up event handlers (invoked once on key up).
+     * @private
+     */
+    private keyUpHandlers;
+    /**
+     * Creates an instance of KeyboardHandler.
+     * @param canvas The HTMLCanvasElement to attach keyboard events to.
+     */
+    constructor(canvas: HTMLCanvasElement);
+    /**
+     * Registers the necessary keyboard event listeners.
+     * @protected
+     */
+    protected addListeners(): void;
+    private registerMovementHandlers;
+    /**
+     * Checks if a key is currently pressed.
+     * @param key The event.code of the key.
+     * @returns {boolean} True if the key is pressed, false otherwise.
+     * @private
+     */
+    isKeyPressed(key: string): boolean;
+    /**
+     * Resets the handler state by clearing all pressed keys and recalculating movement.
+     * @override
+     */
+    reset(): void;
+    /**
+     * Registers a handler for a key down event.
+     * @param code The event.code of the key.
+     * @param handler Callback invoked on key down.
+     */
+    registerKeyDown(code: string, mode: CallbackMode, handler: () => void): void;
+    /**
+     * Registers a handler for a key up event.
+     * @param code The event.code of the key.
+     * @param handler Callback invoked on key up.
+     */
+    registerKeyUp(code: string, mode: CallbackMode, handler: () => void): void;
+    private registerKey;
+    /**
+     * Internal key down event handler.
+     * @param event The KeyboardEvent object.
+     * @private
+     */
+    private _onKeyDown;
+    /**
+     * Internal key up event handler.
+     * @param event The KeyboardEvent object.
+     * @private
+     */
+    private _onKeyUp;
+    /**
+     * Calculates and applies the movement vector based on currently pressed keys.
+     * Also calls any continuous key pressed handlers for keys that are held down.
+     * @private
+     */
+    private applyMove;
+}
+export {};

package/dist/types/core-viewers/shared/mouseHandler.d.ts

@@ -0,0 +1,26 @@
+import { InputHandler } from "./inputHandler";
+import { Vector2 } from "../utils/math3d";
+type DragCallback = (delta: Vector2, button: number) => void;
+export declare class MouseHandler extends InputHandler {
+    private _lastMouseDownPosition;
+    private _capture;
+    private _dragHandler;
+    onButtonDown: (pos: Vector2, button: number) => void;
+    onButtonUp: (pos: Vector2, button: number) => void;
+    onMouseMove: (event: Vector2) => void;
+    onDrag: DragCallback;
+    onClick: (position: Vector2, ctrl: boolean) => void;
+    onDoubleClick: (position: Vector2) => void;
+    onWheel: (value: number, ctrl: boolean) => void;
+    constructor(canvas: HTMLCanvasElement);
+    register(): void;
+    dispose(): void;
+    private onPointerDown;
+    private onPointerUp;
+    private handleMouseClick;
+    private onPointerMove;
+    private _onDoubleClick;
+    private onMouseScroll;
+    private relativePosition;
+}
+export {};

package/dist/types/core-viewers/{webgl/viewer/inputs → shared}/touchHandler.d.ts

@@ -1,8 +1,8 @@
 /**
  * @module viw-webgl-viewer/inputs
  */
+import * as THREE from 'three';
 import { InputHandler } from './inputHandler';
-import { Viewer } from '../viewer';
 /**
  * Manages user touch inputs.
  */
@@ -12,17 +12,12 @@ export declare class TouchHandler extends InputHandler {
     private readonly TAP_MAX_MOVE_PIXEL;
     private readonly ZOOM_SPEED;
     private readonly MOVE_SPEED;
-    /**
-     * Speed factor for rotation movements
-     */
-    rotateSpeed: number;
-    /**
-     * Speed factor for orbit movements
-     */
-    orbitSpeed: number;
-    constructor(viewer: Viewer);
-    private get camera();
-    private get viewport();
+    onTap: (position: THREE.Vector2) => void;
+    onDoubleTap: (position: THREE.Vector2) => void;
+    onDrag: (delta: THREE.Vector2) => void;
+    onDoubleDrag: (delta: THREE.Vector2) => void;
+    onPinchOrSpread: (delta: number) => void;
+    constructor(canvas: HTMLCanvasElement);
     private _touch;
     private _touch1;
     private _touch2;
@@ -31,15 +26,17 @@ export declare class TouchHandler extends InputHandler {
     private _touchStart;
     protected addListeners(): void;
     reset: () => void;
-    private onTap;
+    private _onTap;
     private onTouchStart;
     private toRotation;
-    private onDrag;
-    private onDoubleDrag;
-    private onPinchOrSpread;
     private onTouchMove;
     private onTouchEnd;
     private isSingleTouch;
     private touchToVector;
     private average;
+    /**
+     * Returns the pixel size of the canvas.
+     * @returns {THREE.Vector2} The pixel size of the canvas.
+     */
+    getCanvasSize(): THREE.Vector2;
 }

package/dist/types/core-viewers/ultra/index.d.ts

@@ -1,8 +1,8 @@
 import "./style.css";
-export * from './viewer/viewer';
-export * as utils from './utils/promise';
+export * from './viewer/ultraCoreViewer';
+export * as utils from '../utils/promise';
+export * from '../utils/math3d';
 export * from './viewer/vim';
-export * from './utils/math3d';
 export * from './viewer/color';
 export type { ILoadRequest, VimRequestErrorType } from './viewer/loadRequest';
 export type { ClientState, ConnectionSettings } from './viewer/socketClient';

package/dist/types/core-viewers/ultra/viewer/camera.d.ts

@@ -1,4 +1,4 @@
-import { Box3, Segment, Vector3 } from '../utils/math3d';
+import { Box3, Segment, Vector3 } from '../../utils/math3d';
 import { RpcSafeClient } from './rpcSafeClient';
 import { Vim } from './vim';
 /**

package/dist/types/core-viewers/ultra/viewer/color.d.ts

@@ -1,4 +1,4 @@
-import { RGBA32 } from "../utils/math3d";
+import { RGBA32 } from "../../utils/math3d";
 import { ColorManager } from "./colorManager";
 /**
  * Represents a handle to a color in the color management system.

package/dist/types/core-viewers/ultra/viewer/colorManager.d.ts

@@ -1,6 +1,6 @@
 import { RpcSafeClient } from './rpcSafeClient';
 import { ColorHandle } from './color';
-import { RGBA32 } from '../utils/math3d';
+import { RGBA32 } from '../../utils/math3d';
 /**
  * Manages the creation, caching, and deletion of color instances.
  * Handles batched deletion of colors to optimize RPC calls.

package/dist/types/core-viewers/ultra/viewer/marshal.d.ts

@@ -1,7 +1,7 @@
 /**
  * Don't modify this file, the RPC generated code depends on its interface.
  */
-import { Box3, RGB, RGBA, RGBA32, Segment, Vector2, Vector3, Matrix44 } from "../utils/math3d";
+import { Box3, RGB, RGBA, RGBA32, Segment, Vector2, Vector3, Matrix44 } from "../../utils/math3d";
 export type HitCheckResult = {
     vimHandle: number;
     nodeIndex: number;

package/dist/types/core-viewers/ultra/viewer/renderer.d.ts

@@ -1,4 +1,4 @@
-import { Box3, RGBA } from "../utils/math3d";
+import { Box3, RGBA } from "../../utils/math3d";
 import { ILogger } from "./logger";
 import { RpcSafeClient, SceneSettings } from "./rpcSafeClient";
 import { ClientStreamError } from "./socketClient";

package/dist/types/core-viewers/ultra/viewer/rpcClient.d.ts

@@ -1,6 +1,6 @@
 import type { SocketClient } from './socketClient';
 import { HitCheckResult, VimStatus, SectionBoxState } from './marshal';
-import { Box3, RGBA, RGBA32, Segment, Vector2, Vector3, Matrix44 } from '../utils/math3d';
+import { Box3, RGBA, RGBA32, Segment, Vector2, Vector3, Matrix44 } from '../../utils/math3d';
 export type MaterialHandle = 4294967295 | 6 | 2 | 0 | 1 | 3 | 4 | 5 | 7 | 8;
 export declare class MaterialHandles {
     static readonly Invalid: MaterialHandle;

package/dist/types/core-viewers/ultra/viewer/rpcSafeClient.d.ts

@@ -1,4 +1,4 @@
-import { Box3, RGBA, RGBA32, Segment, Vector2, Vector3 } from "../utils/math3d";
+import { Box3, RGBA, RGBA32, Segment, Vector2, Vector3 } from "../../utils/math3d";
 import { HitCheckResult, SectionBoxState } from "./marshal";
 import { MaterialHandle, RpcClient } from "./rpcClient";
 export type VimSource = {

package/dist/types/core-viewers/ultra/viewer/sectionBox.d.ts

@@ -1,4 +1,4 @@
-import { Box3 } from "../utils/math3d";
+import { Box3 } from "../../utils/math3d";
 import { RpcSafeClient } from "./rpcSafeClient";
 export declare class SectionBox {
     private _visible;

package/dist/types/core-viewers/ultra/viewer/selection.d.ts

@@ -1,4 +1,4 @@
-import { Box3, Vector2, Vector3 } from "../utils/math3d";
+import { Box3, Vector2, Vector3 } from "../../utils/math3d";
 import { RpcSafeClient } from "./rpcSafeClient";
 import { Vim } from "./vim";
 import { IReadonlyVimCollection } from "./vimCollection";

package/dist/types/core-viewers/ultra/viewer/socketClient.d.ts

@@ -1,7 +1,7 @@
 import * as Protocol from './protocol';
 import { Marshal, ReadMarshal } from './marshal';
 import { ILogger } from './logger';
-import { Segment } from '../utils/math3d';
+import { Segment } from '../../utils/math3d';
 export declare const DEFAULT_LOCAL_ULTRA_SERVER_URL = "ws://localhost:8123";
 export type ConnectionSettings = {
     url?: string;

package/dist/types/core-viewers/ultra/viewer/{viewer.d.ts → ultraCoreViewer.d.ts}

@@ -1,4 +1,3 @@
-import { IInputs } from './inputs/inputs';
 import { ClientState, ConnectionSettings } from './socketClient';
 import { IDecoder } from './decoder';
 import { Vim } from './vim';
@@ -13,12 +12,13 @@ import { ViewerSelection } from './selection';
 import { IReadonlyVimCollection } from './vimCollection';
 import { IRenderer } from './renderer';
 import { SectionBox } from './sectionBox';
+import { CoreInputHandler } from '../../shared/coreInputHandler';
 export declare const INVALID_HANDLE = 4294967295;
 /**
  * The main Viewer class responsible for managing VIM files,
  * handling connections, and coordinating various components like the camera, decoder, and inputs.
  */
-export declare class Viewer {
+export declare class UltraCoreViewer {
     private readonly _decoder;
     private readonly _socketClient;
     private readonly _input;
@@ -41,7 +41,7 @@ export declare class Viewer {
     /**
      * The input API for handling user input events.
      */
-    get inputs(): IInputs;
+    get inputs(): CoreInputHandler;
     get vims(): IReadonlyVimCollection;
     /**
      * The viewport API for managing the rendering viewport.
@@ -79,7 +79,7 @@ export declare class Viewer {
      * @param logger - Optional logger for logging messages.
      * @returns A new instance of the Viewer class.
      */
-    static createWithCanvas(parent: HTMLElement, logger?: ILogger): Viewer;
+    static createWithCanvas(parent: HTMLElement, logger?: ILogger): UltraCoreViewer;
     /**
      * Constructs a new Viewer instance.
      * @param canvas - The HTML canvas element for rendering.

package/dist/types/core-viewers/ultra/viewer/ultraInputsAdapter.d.ts

@@ -0,0 +1,5 @@
+import { CoreInputHandler } from "../../shared/coreInputHandler";
+import { UltraCoreViewer } from "./ultraCoreViewer";
+declare const CODE_TO_KEYCODE: Record<string, number>;
+export default CODE_TO_KEYCODE;
+export declare function ultraInputAdapter(viewer: UltraCoreViewer): CoreInputHandler;

package/dist/types/core-viewers/ultra/{utils → viewer}/validation.d.ts

@@ -1,4 +1,4 @@
-import { Box3, RGB, RGBA, Segment, Vector2, Vector3 } from './math3d';
+import { Box3, RGB, RGBA, Segment, Vector2, Vector3 } from '../../utils/math3d';
 export declare class Validation {
     static isNumber(value: number): boolean;
     static isPositiveNumber(value: number): boolean;

package/dist/types/core-viewers/ultra/viewer/vim.d.ts

@@ -3,7 +3,7 @@ import { ColorManager } from './colorManager';
 import { LoadRequest } from './loadRequest';
 import { RpcSafeClient, VimSource } from './rpcSafeClient';
 import { ILogger } from './logger';
-import { Box3 } from '../utils/math3d';
+import { Box3 } from '../../utils/math3d';
 type NodeState = 'visible' | 'hidden' | 'ghosted' | 'highlighted';
 export declare class Vim {
     readonly source: VimSource;

package/dist/types/core-viewers/webgl/index.d.ts

@@ -7,13 +7,12 @@ export * from './loader/progressive/vimRequest';
 export * from './loader/progressive/vimx';
 export * from './viewer/viewer';
 export * from './loader/geometry';
-export type { PointerMode, InputScheme } from './viewer/inputs/input';
-export { DefaultInputScheme, KEYS } from './viewer/inputs/input';
+export * from '../shared/coreInputHandler';
 export * from './viewer/settings/viewerSettings';
 export * from './viewer/settings/viewerSettingsParsing';
 export * from './viewer/settings/defaultViewerSettings';
 export { RaycastResult as HitTestResult, InputAction } from './viewer/raycaster';
-export { type SelectableObject } from './viewer/selection';
+export { type SelectableObject, Selection } from './viewer/selection';
 export * from './loader/progressive/insertableMesh';
 export * from './loader/progressive/g3dSubset';
 export * from './loader/geometry';

package/dist/types/core-viewers/webgl/loader/progressive/vimRequest.d.ts

@@ -1,6 +1,6 @@
 import { VimPartialSettings } from '../vimSettings';
 import { Vim } from '../vim';
-import { RequestResult } from '../../utils/requestResult';
+import { RequestResult } from '../../../utils/requestResult';
 import { VimSource } from '../..';
 import { IProgressLogs } from 'vim-format';
 export type RequestSource = {

package/dist/types/core-viewers/webgl/viewer/camera/ICamera.d.ts

@@ -71,10 +71,6 @@ export interface ICamera {
      */
     get forward(): THREE.Vector3;
     get isLerping(): boolean;
-    /**
-     * The camera speed factor.
-     */
-    speed: number;
     /**
      * The current or target velocity of the camera.
      */

package/dist/types/core-viewers/webgl/viewer/camera/camera.d.ts

@@ -79,10 +79,6 @@ export interface ICamera {
      */
     get forward(): THREE.Vector3;
     get isLerping(): boolean;
-    /**
-     * The camera speed factor.
-     */
-    speed: number;
     /**
      * The current or target velocity of the camera.
      */
@@ -120,7 +116,6 @@ export declare class Camera implements ICamera {
     private _movement;
     private _inputVelocity;
     private _velocity;
-    private _speed;
     private _orthographic;
     private _target;
     private _lastPosition;
@@ -169,7 +164,6 @@ export declare class Camera implements ICamera {
     get defaultForward(): THREE.Vector3;
     set defaultForward(value: THREE.Vector3);
     private _velocityBlendFactor;
-    private _moveSpeed;
     constructor(scene: RenderScene, viewport: Viewport, settings: ViewerSettings);
     /**
      * Interface for instantaneously moving the camera.
@@ -210,11 +204,6 @@ export declare class Camera implements ICamera {
      * The forward direction of the camera.
      */
     get forward(): THREE.Vector3;
-    /**
-     * The camera speed factor.
-     */
-    get speed(): number;
-    set speed(value: number);
     /**
      * The current or target velocity of the camera.
      */

package/dist/types/core-viewers/webgl/viewer/gizmos/gizmoOrbit.d.ts

@@ -5,7 +5,7 @@ import * as THREE from 'three';
 import { Renderer } from '../rendering/renderer';
 import { Camera } from '../camera/camera';
 import { ViewerSettings } from '../settings/viewerSettings';
-import { Input } from '../inputs/input';
+import { CoreInputHandler } from '../../../shared/coreInputHandler';
 /**
  * Manages the camera target gizmo
  */
@@ -27,7 +27,7 @@ export declare class GizmoOrbit {
     private _timeout;
     private _active;
     private _animation;
-    constructor(renderer: Renderer, camera: Camera, input: Input, settings: ViewerSettings);
+    constructor(renderer: Renderer, camera: Camera, input: CoreInputHandler, settings: ViewerSettings);
     private connect;
     private onUpdate;
     /**