vim-web 0.3.44-dev.9 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vim-web",
-  "version": "0.3.44-dev.9",
+  "version": "0.4.0", 
   "description": "A demonstration app built on top of the vim-webgl-viewer",
   "type": "module",
   "files": [

package/dist/types/core-viewers/ultra/utils/debounce.d.ts

@@ -1 +0,0 @@
-export declare function debounce<T extends (...args: any[]) => void>(func: T, delay: number): [(...args: Parameters<T>) => void, () => void];

package/dist/types/core-viewers/ultra/utils/deferredPromise.d.ts

@@ -1,8 +0,0 @@
-export declare class DeferredPromise<T> extends Promise<T> {
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason: T | Error) => void;
-    initialCallStack: Error['stack'];
-    constructor(executor?: ConstructorParameters<typeof Promise<T>>[0]);
-    /** @throws error with amended call stack */
-    rejectWithError(error: Error): void;
-}

package/dist/types/core-viewers/ultra/utils/result.d.ts

@@ -1,11 +0,0 @@
-export declare class Result<T, E> {
-    private readonly value;
-    private readonly error;
-    private constructor();
-    static ok<T, E>(value: T): Result<T, E>;
-    static error<T, E>(error: E): Result<T, E>;
-    isOk(): this is Result<T, undefined>;
-    isError(): this is Result<undefined, string>;
-    getValue(): T;
-    getError(): E;
-}

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

@@ -1,25 +0,0 @@
-import { InputHandler } from "./inputHandler";
-import { RpcSafeClient } from "../rpcSafeClient";
-export declare class InputTouch extends InputHandler {
-    private readonly _rpc;
-    private readonly _canvas;
-    private _lastTouchStartPosition;
-    private _initialTouchDistance;
-    constructor(canvas: HTMLCanvasElement, rpc: RpcSafeClient);
-    register(): void;
-    dispose(): void;
-    private handleTouchStart;
-    private handleSingleTouchStart;
-    private handleDoubleTouchStart;
-    private handleTouchMove;
-    private handleSingleTouchMove;
-    private handleDoubleTouchMove;
-    private handlePinch;
-    private handleTouchEnd;
-    private handleSingleTouchEnd;
-    private handleDoubleTouchEnd;
-    private handleTouchCancel;
-    private handleTouchClick;
-    private hasMoved;
-    private relativeTouchPosition;
-}

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

@@ -1,7 +0,0 @@
-export declare abstract class InputHandler {
-    private readonly _disconnect;
-    register(): void;
-    dispose(): void;
-    unregister(): void;
-    protected reg<T extends Event>(element: HTMLElement | Window, eventType: string, callback: (event: T) => void): void;
-}

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

@@ -1,20 +0,0 @@
-import { ICamera } from "../camera";
-import { RpcSafeClient } from "../rpcSafeClient";
-import { ViewerSelection } from "../selection";
-import { InputHandler } from "./inputHandler";
-import { Inputs } from "./inputs";
-export declare class InputKeyboard extends InputHandler {
-    private readonly _rpc;
-    private readonly _selection;
-    private _camera;
-    private _inputs;
-    constructor(rpc: RpcSafeClient, selection: ViewerSelection, camera: ICamera, inputs: Inputs);
-    register(): void;
-    dispose(): void;
-    private handleKeyDown;
-    private handleKeyUp;
-    private handleServerKeys;
-    private handleClientKeys;
-    private frameContext;
-    private frameSelection;
-}

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

@@ -1,21 +0,0 @@
-import { InputHandler } from "./inputHandler";
-import { RpcSafeClient } from "../rpcSafeClient";
-import { ViewerSelection } from "../selection";
-import { ICamera } from "../camera";
-export declare class InputMouse extends InputHandler {
-    private readonly _rpc;
-    private readonly _canvas;
-    private _lastMouseDownPosition;
-    private _selection;
-    private _camera;
-    constructor(canvas: HTMLCanvasElement, rpc: RpcSafeClient, selection: ViewerSelection, camera: ICamera);
-    register(): void;
-    dispose(): void;
-    private handlePointerDown;
-    private handlePointerUp;
-    private handleMouseClick;
-    private handlePointerMove;
-    private handleDoubleClick;
-    private handleMouseScroll;
-    private relativePosition;
-}

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

@@ -1,27 +0,0 @@
-import { InputMode, RpcSafeClient } from '../rpcSafeClient';
-import { InputHandler } from './inputHandler';
-import { ViewerSelection } from '../selection';
-import { ICamera } from '../camera';
-import { IRenderer } from '../renderer';
-export interface IInputs {
-    moveSpeed: number;
-    mode: InputMode;
-}
-export declare class Inputs extends InputHandler implements IInputs {
-    private readonly _rpc;
-    private readonly _canvas;
-    private _inputsMouse;
-    private _inputsTouch;
-    private _keyboard;
-    private _renderer;
-    private _moveSpeed;
-    private _mode;
-    constructor(canvas: HTMLCanvasElement, rpc: RpcSafeClient, selection: ViewerSelection, camera: ICamera, renderer: IRenderer);
-    onConnect(): void;
-    register(): void;
-    get moveSpeed(): number;
-    set moveSpeed(value: number);
-    get mode(): InputMode;
-    set mode(value: InputMode);
-    dispose(): void;
-}

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

@@ -1,86 +0,0 @@
-/**
- * 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";
-export type HitCheckResult = {
-    vimHandle: number;
-    nodeIndex: number;
-    worldPosition: Vector3;
-    worldNormal: Vector3;
-};
-export type VimStatus = {
-    status: number;
-    progress: number;
-};
-export type SectionBoxState = {
-    visible: boolean;
-    interactible: boolean;
-    clip: boolean;
-    box: Box3;
-};
-export type Vector4 = {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-};
-export declare class Marshal {
-    private buffer;
-    private _dataView;
-    private _offset;
-    constructor(initialSize?: number);
-    getBuffer(): ArrayBuffer;
-    private ensureCapacity;
-    writeData(data: ArrayBuffer): void;
-    writeMatrix44(data: Matrix44): void;
-    writeBoolean(value: boolean): void;
-    writeInt(value: number): void;
-    writeUInt(value: number): void;
-    writeFloat(value: number): void;
-    writeString(value: string): void;
-    writeHitCheckResult(data: HitCheckResult): void;
-    writeVimStatus(data: VimStatus): void;
-    writeVector2(data: Vector2): void;
-    writeVector3(data: Vector3): void;
-    writeVector4(data: Vector4): void;
-    writeRGBA(color: RGBA): void;
-    writeRGB(color: RGBA): void;
-    writeRGBA32(color: RGBA32): void;
-    writeSegment(segment: Segment): void;
-    writeBox3(data: Box3): void;
-    writeSectionBoxState(data: SectionBoxState): void;
-    writeArrayOfInt(values: number[]): void;
-    writeArrayOfUInt(values: number[]): void;
-    writeArrayOfFloat(values: number[]): void;
-    writeArrayOfBool(values: boolean[]): void;
-    writeArrayOfRGBA32(values: RGBA32[]): void;
-    writeArray<T>(data: T[], sizeT: number, write: (data: T) => void): void;
-}
-export declare class ReadMarshal {
-    private _dataView;
-    private _offset;
-    constructor(buffer: ArrayBuffer);
-    readMatrix44(): Matrix44;
-    readInt(): number;
-    readUInt(): number;
-    readFloat(): number;
-    readBoolean(): boolean;
-    readString(): string;
-    readHitCheckResult(): HitCheckResult;
-    readVimStatus(): VimStatus;
-    readVector2(): Vector2;
-    readVector3(): Vector3;
-    readVector4(): Vector4;
-    readRGBA(): RGBA;
-    readRGB(): RGB;
-    readRGBA32(): RGBA32;
-    readBox3(): Box3;
-    readSegment(): Segment;
-    readSectionBoxState(): SectionBoxState;
-    readArrayOfInt(): number[];
-    readArrayOfUInt(): number[];
-    readArrayOfFloat(): number[];
-    readArrayOfBool(): boolean[];
-    readArrayOfRGBA32(): RGBA32[];
-    readArray<T>(read: () => T): T[];
-}

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

@@ -1,96 +0,0 @@
-import { Box3, Vector2, Vector3 } from "../utils/math3d";
-import { RpcSafeClient } from "./rpcSafeClient";
-import { Vim } from "./vim";
-import { IReadonlyVimCollection } from "./vimCollection";
-export interface IViewerSelection {
-    hitTest(pos: Vector2): Promise<HitTestResult | undefined>;
-    select(vim: Vim, node: number | number[]): void;
-    toggle(vim: Vim, node: number | number[]): void;
-    add(vim: Vim, node: number | number[]): void;
-    remove(vim: Vim, node: number | number[]): void;
-    clear(vim?: Vim): void;
-}
-/**
- * Represents the result of a hit test operation.
- */
-export type HitTestResult = {
-    /** The Vim instance that was hit */
-    vim: Vim;
-    /** The index of the node that was hit */
-    nodeIndex: number;
-    /** The 3D world position of the hit point */
-    worldPosition: Vector3;
-    /** The surface normal at the hit point */
-    worldNormal: Vector3;
-};
-/**
- * Manages selection state of nodes across multiple VIM instances.
- */
-export declare class ViewerSelection implements IViewerSelection {
-    private _rpc;
-    private _vims;
-    private _selectedNodes;
-    private _onValueChanged;
-    get onValueChanged(): import("ste-signals").ISignal;
-    /**
-     * Creates a new ViewerSelection instance.
-     * @param rpc - RPC client for communication with the viewer.
-     * @param vims - Collection of VIM instances to manage.
-     */
-    constructor(rpc: RpcSafeClient, vims: IReadonlyVimCollection);
-    /**
-     * Gets the total number of selected nodes across all VIMs.
-     * @returns The total count of selected nodes.
-     */
-    get count(): number;
-    /**
-     * Performs a hit test at the specified screen position.
-     * @param pos - The screen position in 2D coordinates.
-     * @returns Promise resolving to hit test result or undefined if no hit.
-     */
-    hitTest(pos: Vector2): Promise<HitTestResult | undefined>;
-    /**
-     * Replaces the current selection with the specified node(s).
-     * Clears all previous selections across all VIMs.
-     * @param vim - The Vim instance to select nodes from.
-     * @param node - A single node index or array of node indices to select.
-     */
-    select(vim: Vim, node: number | number[]): void;
-    /**
-     * Toggles the selection state of the specified node(s).
-     * If a node is currently selected, it will be deselected, and vice versa.
-     * @param vim - The Vim instance containing the nodes.
-     * @param node - A single node index or array of node indices to toggle.
-     */
-    toggle(vim: Vim, node: number | number[]): void;
-    /**
-     * Adds the specified node(s) to the current selection.
-     * If a node is already selected, it remains selected.
-     * @param vim - The Vim instance containing the nodes.
-     * @param node - A single node index or array of node indices to add.
-     */
-    add(vim: Vim, node: number | number[]): void;
-    /**
-     * Removes the specified node(s) from the current selection.
-     * If a node is not selected, no action is taken for that node.
-     * @param vim - The Vim instance containing the nodes.
-     * @param node - A single node index or array of node indices to remove.
-     */
-    remove(vim: Vim, node: number | number[]): void;
-    /**
-     * Clears all selections across all VIMs or for a specific VIM.
-     * @param vim - Optional. If provided, only clears selections for the specified VIM.
-     */
-    clear(vim?: Vim): void;
-    /**
-     * Calculates the bounding box encompassing all selected nodes.
-     * @returns Promise resolving to a Box3 representing the bounds of all selected nodes,
-     *          or undefined if no nodes are selected or bounds cannot be calculated.
-     */
-    getBoundingBox(): Promise<Box3 | undefined>;
-    /**
-     * Cleans up resources and releases memory.
-     * Should be called when the selection manager is no longer needed.
-     */
-    dispose(): void;
-}

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

@@ -1,111 +0,0 @@
-import { ColorHandle } from './color';
-import { ColorManager } from './colorManager';
-import { LoadRequest } from './loadRequest';
-import { RpcSafeClient, VimSource } from './rpcSafeClient';
-import { ILogger } from './logger';
-import { Box3 } from '../utils/math3d';
-type NodeState = 'visible' | 'hidden' | 'ghosted' | 'highlighted';
-export declare class Vim {
-    readonly source: VimSource;
-    private _handle;
-    private _request;
-    private readonly _rpc;
-    private _colors;
-    private _logger;
-    private _nodeStates;
-    private _allNodeState;
-    private _nodeColors;
-    private _pendingNodeStateChanges;
-    private _updateScheduled;
-    /**
-     * Creates an instance of the Vim class.
-     * @param rpc - The RPC client used for communication.
-     * @param color - The color manager for handling colors.
-     * @param source - The source URL or file path of the Vim.
-     * @param logger - The logger for logging messages.
-     */
-    constructor(rpc: RpcSafeClient, color: ColorManager, source: VimSource, logger: ILogger);
-    get handle(): number;
-    /**
-     * Indicates whether the Vim is connected.
-     * @returns True if connected; otherwise, false.
-     */
-    get connected(): boolean;
-    /**
-     * Connects to the Vim and initiates loading.
-     * @returns The load request associated with this operation.
-     */
-    connect(): LoadRequest;
-    private reapplyNodes;
-    private reapplyColors;
-    /**
-     * Disconnects the Vim and unloads it from the server.
-     */
-    disconnect(): void;
-    /**
-     * Requests for the server to load the given URL or file path.
-     * @param source - The URL or file path to load.
-     * @param result - The load request object to update.
-     * @returns The updated load request.
-     */
-    private _load;
-    private getErrorType;
-    private _getHandle;
-    /**
-     * Shows the given nodes.
-     * @param nodes - The nodes to show. If 'all' is passed, all nodes will be shown.
-     */
-    show(nodes: number[] | 'all'): void;
-    /**
-     * Hides the given nodes.
-     * @param nodes - The nodes to hide. If 'all' is passed, all nodes will be hidden.
-     */
-    hide(nodes: number[] | 'all'): void;
-    /**
-     * Ghosts the given nodes.
-     * @param nodes - The nodes to ghost. If 'all' is passed, all nodes will be ghosted.
-     */
-    ghost(nodes: number[] | 'all'): void;
-    /**
-     * Highlights the given nodes.
-     * @param nodes - The nodes to highlight. If 'all' is passed, all nodes will be highlighted.
-     */
-    highlight(nodes: number[] | 'all'): void;
-    /**
-     * Removes the highlight from the given nodes and reverts them to a fallback state.
-     * @param nodes - The nodes to remove the highlight from.
-     * @param fallback - The state to revert the nodes to.
-     */
-    removeHighlight(nodes: number[], fallback: NodeState): void;
-    /**
-     * Retrieves the bounding box of the given nodes.
-     * @param nodes - The nodes to get the bounding box for.
-     * @returns A Promise that resolves to the bounding box, or undefined if not connected or nodes are empty.
-     * @throws Error if 'all' is passed, as this feature is not supported yet.
-     */
-    getBoundingBox(nodes: number[] | 'all'): Promise<Box3 | undefined>;
-    /**
-     * Applies a color to the given nodes.
-     * @param color - The color to apply.
-     * @param nodes - The nodes to apply the color to.
-     */
-    applyColor(color: ColorHandle | undefined, nodes: number[]): void;
-    /**
-     * Applies an array of colors to the given nodes.
-     * @param color - An array of colors to apply, corresponding to each node.
-     * @param nodes - The nodes to apply the colors to.
-     * @throws Will throw an error if the lengths of the colors and nodes arrays do not match.
-     */
-    applyColors(color: (ColorHandle | undefined)[], nodes: number[]): void;
-    /**
-     * Clears the color from the given nodes.
-     * @param nodes - The nodes to clear the color from.
-     */
-    clearColor(nodes: number[] | 'all'): void;
-    private updateMap;
-    private scheduleNodeStateChange;
-    private scheduleUpdate;
-    private update;
-    private callRPCForState;
-}
-export {};

package/dist/types/core-viewers/webgl/utils/deferredPromise.d.ts

@@ -1,8 +0,0 @@
-export declare class DeferredPromise<T> extends Promise<T> {
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason: T | Error) => void;
-    initialCallStack: Error['stack'];
-    constructor(executor?: ConstructorParameters<typeof Promise<T>>[0]);
-    /** @throws error with amended call stack */
-    rejectWithError(error: Error): void;
-}

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

@@ -1,51 +0,0 @@
-/**
- * @module viw-webgl-viewer/gizmos
- */
-import * as THREE from 'three';
-import { Viewer } from '../viewer';
-/**
- * Rectangle Gizmo used for rectangle selection.
- */
-export declare class GizmoRectangle {
-    private line;
-    private viewer;
-    private points;
-    constructor(viewer: Viewer);
-    /**
-     * Removes the object from rendering and dispose resources from memory
-     */
-    dispose(): void;
-    /**
-     * Indicates whether the gizmo is visible.
-     */
-    get visible(): boolean;
-    set visible(value: boolean);
-    /**
-     * Sets the two corner points defining the rectangle.
-     * @param {THREE.Vector2} posA - The position of the first corner.
-     * @param {THREE.Vector2} posB - The position of the second corner.
-     */
-    setCorners(posA: THREE.Vector2, posB: THREE.Vector2): void;
-    private getIntersection;
-    private updateRect;
-    private getBoxSize;
-    /**
-     * Returns the bounding box of the selection.
-     * The bounding box is the projection of the selection rectangle
-     * onto the plane coplanar to the closest hit of 5 raycasts: one in each corner and one in the center.
-     * X-----X
-     * |  X  |
-     * X-----X
-     * @returns {THREE.Box3} The bounding box of the selection.
-     */
-    getBoundingBox(target?: THREE.Box3): THREE.Box3;
-    /**
-     * Performs a raycast from the camera through the five interest points and returns the closest hit position.
-     * @returns {THREE.Vector3} The position of the closest hit.
-     */
-    getClosestHit(): THREE.Vector3;
-    /**
-     * Projects all points on a plane the coplanar to position.
-     */
-    private projectPoints;
-}

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

@@ -1,36 +0,0 @@
-/**
- @module viw-webgl-viewer/gizmos/measure
-*/
-import { InputScheme } from '../../inputs/input';
-import { InputAction } from '../../raycaster';
-import { Measure } from './measure';
-export type MeasureStage = 'ready' | 'active' | 'done' | 'failed';
-/**
- * Inputs scheme for measuring as a small state machine.
- */
-export declare class MeasureFlow implements InputScheme {
-    private readonly _gizmoMeasure;
-    private _stage;
-    private removeMouseListener;
-    constructor(gizmoMeasure: Measure);
-    onProgress: ((stage: MeasureStage) => void) | undefined;
-    onComplete: ((success: boolean) => void) | undefined;
-    get stage(): MeasureStage;
-    private unregister;
-    /**
-     * Cancels current measuring flow.
-     */
-    abort(): void;
-    /**
-     * Implementation for InputScheme onMainAction
-     */
-    onMainAction(action: InputAction): void;
-    /**
-     * Implementation for InputScheme onIdleAction
-     */
-    onIdleAction(action: InputAction): void;
-    /**
-     * Implementation for InputScheme onKeyAction
-     */
-    onKeyAction(key: number): boolean;
-}

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

@@ -1,128 +0,0 @@
-/**
- * @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 */
-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;
-}
-/**
- * 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;
-}
-/**
- * Manages and registers all viewer user inputs for mouse, keyboard and touch
- */
-export declare class Input {
-    private _viewer;
-    /**
-     * Touch input handler
-     */
-    touch: TouchHandler;
-    /**
-     * Mouse input handler
-     */
-    mouse: MouseHandler;
-    /**
-     * Keyboard input handler
-     */
-    keyboard: KeyboardHandler;
-    private _pointerActive;
-    private _pointerFallback;
-    private _pointerOverride;
-    constructor(viewer: Viewer);
-    /**
-     * Returns the last main mode (orbit, look) that was active.
-     */
-    get pointerFallback(): PointerMode;
-    /**
-     * Returns current pointer mode.
-     */
-    get pointerActive(): PointerMode;
-    /**
-     * A temporary pointer mode used for temporary icons.
-     */
-    get pointerOverride(): PointerMode | undefined;
-    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.
-     */
-    get onPointerOverrideChanged(): import("ste-signals").ISignal;
-    private _onContextMenu;
-    /**
-     * 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
-     */
-    registerAll(): void;
-    /**
-     * Unregisters all input handlers
-     */
-    unregisterAll: () => void;
-    /**
-     * Resets all input state
-     */
-    resetAll(): void;
-}