vim-web 0.3.44-dev.8 → 0.3.44-dev.80

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

@@ -1,113 +0,0 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-import { InputHandler } from './inputHandler';
-/**
- * Key values for viewer
- */
-export declare const KEYS: {
-    KEY_0: number;
-    KEY_1: number;
-    KEY_2: number;
-    KEY_3: number;
-    KEY_4: number;
-    KEY_5: number;
-    KEY_6: number;
-    KEY_7: number;
-    KEY_8: number;
-    KEY_9: number;
-    KEY_LEFT: number;
-    KEY_RIGHT: number;
-    KEY_UP: number;
-    KEY_DOWN: number;
-    KEY_CTRL: number;
-    KEY_SHIFT: number;
-    KEY_ENTER: number;
-    KEY_SPACE: number;
-    KEY_TAB: number;
-    KEY_ESCAPE: number;
-    KEY_BACKSPACE: number;
-    KEY_HOME: number;
-    KEY_END: number;
-    KEY_INSERT: number;
-    KEY_DELETE: number;
-    KEY_ALT: number;
-    KEY_F1: number;
-    KEY_F2: number;
-    KEY_F3: number;
-    KEY_F4: number;
-    KEY_F5: number;
-    KEY_F6: number;
-    KEY_F7: number;
-    KEY_F8: number;
-    KEY_F9: number;
-    KEY_F10: number;
-    KEY_F11: number;
-    KEY_F12: number;
-    KEY_NUMPAD0: number;
-    KEY_NUMPAD1: number;
-    KEY_NUMPAD2: number;
-    KEY_NUMPAD3: number;
-    KEY_NUMPAD4: number;
-    KEY_NUMPAD5: number;
-    KEY_NUMPAD6: number;
-    KEY_NUMPAD7: number;
-    KEY_NUMPAD8: number;
-    KEY_NUMPAD9: number;
-    KEY_ADD: number;
-    KEY_SUBTRACT: number;
-    KEY_MULTIPLY: number;
-    KEY_DIVIDE: number;
-    KEY_SEPARATOR: number;
-    KEY_DECIMAL: number;
-    KEY_OEM_PLUS: number;
-    KEY_OEM_MINUS: number;
-    KEY_A: number;
-    KEY_B: number;
-    KEY_C: number;
-    KEY_D: number;
-    KEY_E: number;
-    KEY_F: number;
-    KEY_G: number;
-    KEY_H: number;
-    KEY_I: number;
-    KEY_J: number;
-    KEY_K: number;
-    KEY_L: number;
-    KEY_M: number;
-    KEY_N: number;
-    KEY_O: number;
-    KEY_P: number;
-    KEY_Q: number;
-    KEY_R: number;
-    KEY_S: number;
-    KEY_T: number;
-    KEY_U: number;
-    KEY_V: number;
-    KEY_W: number;
-    KEY_X: number;
-    KEY_Y: number;
-    KEY_Z: number;
-};
-/**
- * Manages keyboard user inputs
- */
-export declare class KeyboardHandler extends InputHandler {
-    private SHIFT_MULTIPLIER;
-    isUpPressed: boolean;
-    isDownPressed: boolean;
-    isLeftPressed: boolean;
-    isRightPressed: boolean;
-    isEPressed: boolean;
-    isQPressed: boolean;
-    isShiftPressed: boolean;
-    isCtrlPressed: boolean;
-    arrowsEnabled: boolean;
-    protected addListeners(): void;
-    reset(): void;
-    private get camera();
-    private onKeyUp;
-    private onKeyDown;
-    private onKey;
-    private applyMove;
-}

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

@@ -1,66 +0,0 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-import { InputHandler } from './inputHandler';
-import { Viewer } from '../viewer';
-/**
- * Manages mouse user inputs
- */
-export declare class MouseHandler extends InputHandler {
-    private readonly _idleDelayMs;
-    /**
-     * The speed factor for zoom movements using the scroll wheel.
-     * Range: [0.1, 10]
-     */
-    get scrollSpeed(): number;
-    set scrollSpeed(value: number);
-    private _scrollSpeed;
-    /**
-     * The speed factor for zoom movements when using zoom mode.
-     */
-    zoomSpeed: number;
-    /**
-     * The speed factor for rotations movements.
-     */
-    rotateSpeed: number;
-    /**
-     * The speed factor for orbit movements.
-     */
-    orbitSpeed: number;
-    private _buttonDown;
-    private _hasMouseMoved;
-    private _hasCameraMoved;
-    private _idleTimeout;
-    private _idlePosition;
-    private _lastPosition;
-    private _downPosition;
-    constructor(viewer: Viewer);
-    private get camera();
-    private get viewport();
-    private get canvas();
-    private get raycaster();
-    private get inputs();
-    private get gizmoRect();
-    protected addListeners(): void;
-    reset: () => void;
-    private resetIdle;
-    private onMouseOut;
-    private onMouseIdle;
-    private onCameraMoved;
-    private onMouseMove;
-    private onMouseDown;
-    private onMouseDrag;
-    private toRotation;
-    private onMouseMainDrag;
-    private onMouseMiddleDrag;
-    private pan;
-    private onMouseRightDrag;
-    private onMouseWheel;
-    private getButton;
-    private onMouseUp;
-    private onRectEnd;
-    private onDoubleClick;
-    private onMouseClick;
-    private getModifier;
-    private updateRectangle;
-}

package/dist/types/react-viewers/errors/errorUtils.d.ts

@@ -1,2 +0,0 @@
-export declare function isLocalUrl(url: string): boolean;
-export declare function isFilePathOrUri(input: string): boolean;

package/dist/types/react-viewers/helpers/camera.d.ts

@@ -1,37 +0,0 @@
-/**
- * @module viw-webgl-react
- */
-import { WebglViewer, THREE } from '../../index';
-/**
- * Wraps the webgl viewer and provide higher level methods
- */
-export declare class ComponentCamera {
-    private _viewer;
-    constructor(viewer: WebglViewer.Viewer);
-    /**
-     * Resets the camera to its initial position.
-     */
-    reset(): void;
-    /**
-     * Frames selected elements if there is an active selection; otherwise, frames all visible objects.
-     * @param duration Optional duration of the camera movement animation (default: 1).
-     */
-    frameContext(duration?: number): void;
-    /**
-     * Frames selected elements if there is an active selection; otherwise, does nothing.
-     * @param duration Optional duration of the camera movement animation (default: 1).
-     */
-    frameSelection(duration?: number): void;
-    /**
-   * Frames all visible objects in the scene.
-   * @param source Optional VIM to specify the source of objects to frame.
-   * @param duration Duration of the camera movement animation (default: 1).
-   */
-    frameVisibleObjects(source?: WebglViewer.Vim, duration?: number): void;
-    /**
-     * Returns the bounding box of all visible objects.
-     * @param source Optional VIM to specify the source of visible objects.
-     * @returns The bounding box of all visible objects.
-     */
-    getVisibleBoundingBox(source?: WebglViewer.Vim): THREE.Box3;
-}

package/dist/types/react-viewers/helpers/inputs.d.ts

@@ -1,22 +0,0 @@
-/**
- * @module viw-webgl-react
- */
-import * as VIM from '../../core-viewers/webgl/index';
-import { SideState } from '../sidePanel/sideState';
-import { ComponentCamera } from './camera';
-import { Isolation } from './isolation';
-/**
- * Custom viewer input scheme for the vim component
- */
-export declare class ComponentInputs implements VIM.InputScheme {
-    private _viewer;
-    private _camera;
-    private _default;
-    private _isolation;
-    private _sideState;
-    constructor(viewer: VIM.Viewer, camera: ComponentCamera, isolation: Isolation, sideState: SideState);
-    private _getSelection;
-    onMainAction(hit: VIM.InputAction): void;
-    onIdleAction(hit: VIM.InputAction): void;
-    onKeyAction(key: number): boolean;
-}

package/dist/types/react-viewers/helpers/isolation.d.ts

@@ -1,128 +0,0 @@
-import * as VIM from '../../core-viewers/webgl/index';
-import { ComponentSettings } from '../settings/settings';
-import { ComponentCamera } from './camera';
-import { ISimpleEvent } from 'ste-simple-events';
-/**
- * Manages the isolation mechanic in the VIM component.
- *
- * **Isolation** determines which objects are visible (isolated) and which are
- * hidden or displayed as ghosted. This class applies materials, updates object
- * visibility, and ensures the camera view is adjusted when isolation changes.
- */
-export declare class Isolation {
-    private _viewer;
-    private _settings;
-    private _isolation;
-    private _camera;
-    private _onChanged;
-    /**
-     * An event that is dispatched whenever the isolation set changes.
-     *
-     * @remarks
-     * This can be used by other parts of the application to react to isolation
-     * updates (for example, updating UI or triggering additional viewport actions).
-     *
-     * @returns {ISimpleEvent<string>} Event interface for subscribing to isolation changes.
-     */
-    get onChanged(): ISimpleEvent<string>;
-    /**
-     * Constructs an IsolationManager.
-     *
-     * @param viewer - The VIM Viewer responsible for managing the 3D scene and objects.
-     * @param camera - A component that handles camera control and framing.
-     * @param settings - The settings that control isolation and material usage.
-     */
-    constructor(viewer: VIM.Viewer, camera: ComponentCamera, settings: ComponentSettings);
-    /**
-     * Applies relevant settings to the isolation behavior.
-     *
-     * @param settings - The new settings to apply.
-     *
-     * @remarks
-     * This updates the internal reference to settings and immediately sets
-     * the material based on whether isolation is currently active.
-     */
-    applySettings(settings: ComponentSettings): void;
-    /**
-     * Checks if isolation is currently active (i.e., any objects are isolated).
-     *
-     * @returns True if isolation is active; otherwise, false.
-     */
-    isActive(): boolean;
-    /**
-     * Retrieves the current array of isolated objects.
-     *
-     * @returns An array of isolated objects, or undefined if isolation is not active.
-     */
-    current(): VIM.Object3D[] | undefined;
-    /**
-     * Sets the specified objects as isolated, hiding or ghosting the rest.
-     *
-     * @param objects - The objects to isolate.
-     * @param source - A label or identifier indicating the source of this action (e.g., "user").
-     */
-    isolate(objects: VIM.Object3D[], source: string): void;
-    /**
-     * Toggles isolation by using the current selection.
-     *
-     * @param source - A label or identifier for the isolation action.
-     *
-     * @remarks
-     * This method replaces the current isolation set with whatever objects are
-     * currently selected. If selection is empty, it effectively clears isolation.
-     */
-    toggle(source: string): void;
-    /**
-     * Hides the specified objects from the isolation set.
-     *
-     * @param objects - The objects to hide.
-     * @param source - A label or identifier for the isolation action.
-     *
-     * @remarks
-     * If there is no active isolation set (i.e., all objects are visible),
-     * the method first treats all objects in the scene as isolated,
-     * and then removes the specified objects. This ensures the specified
-     * objects become hidden.
-     */
-    hide(objects: VIM.Object3D[], source: string): void;
-    /**
-     * Adds the specified objects to the current isolation set (making them visible).
-     *
-     * @param objects - The objects to show.
-     * @param source - A label or identifier for the isolation action.
-     */
-    show(objects: VIM.Object3D[], source: string): void;
-    /**
-     * Clears the current isolation set, making all objects visible.
-     *
-     * @param source - A label or identifier for the isolation action.
-     */
-    clear(source: string): void;
-    /**
-     * Constructs the correct material (or array of materials) based on the given settings.
-     *
-     * @param settings - The current component settings, including isolation rules.
-     * @param isolate - Whether or not isolation is active.
-     * @returns The material(s) to assign to the renderer, or undefined if default materials should be used.
-     *
-     * @remarks
-     * - If isolation is active and `useGhostMaterial` is true, an array containing
-     *   the simple and ghost materials is returned.
-     * - If fast materials are enabled, the simple material is returned.
-     * - Otherwise, defaults to undefined, allowing the system to pick a standard material.
-     */
-    private getMaterial;
-    /**
-     * Applies the current isolation state: sets visibility for objects, updates materials,
-     * and dispatches the changed event.
-     *
-     * @param source - A label or identifier for the isolation action.
-     */
-    private _apply;
-    /**
-     * Gathers all objects from all loaded VIM instances.
-     *
-     * @returns An array of all objects within the loaded VIM scenes.
-     */
-    private getAllObjects;
-}

package/dist/types/react-viewers/ultra/ultraComponent.d.ts

@@ -1,47 +0,0 @@
-import * as Ultra from '../../core-viewers/ultra/index';
-import { Container } from '../container';
-import { ModalRef } from '../panels/modal';
-import { SectionBoxRef } from '../state/sectionBoxState';
-export type UltraComponentRef = {
-    /**
-     * The Vim viewer instance associated with the component.
-     */
-    viewer: Ultra.Viewer;
-    /**
-     * API to manage the modal dialog.
-     */
-    modal: ModalRef;
-    /**
-     * API to manage the section box.
-     */
-    sectionBox: SectionBoxRef;
-    /**
-     * Disposes of the component and its resources.
-     */
-    dispose: () => void;
-    /**
-     * Loads a file into the viewer.
-     * @param url The URL of the file to load.
-     */
-    load(url: Ultra.VimSource): Ultra.ILoadRequest;
-};
-/**
- * Creates a UI container along with a VIM.Viewer and its associated React component.
- * @param container An optional container object. If none is provided, a container will be created.
- * @param componentSettings UI Component settings.
-*  @param viewerSettings Viewer settings.
- * @returns An object containing the resulting container, reactRoot, and viewer.
- */
-export declare function createUltraComponent(container?: Container | HTMLElement): Promise<UltraComponentRef>;
-/**
- * Represents a React component providing UI for the Vim viewer.
- * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
- * @param viewer The Vim viewer instance for which UI is provided.
- * @param onMount A callback function triggered when the component is mounted. Receives a reference to the Vim component.
- * @param settings Optional settings for configuring the Vim component's behavior.
- */
-export declare function UltraComponent(props: {
-    container: Container;
-    viewer: Ultra.Viewer;
-    onMount: (component: UltraComponentRef) => void;
-}): import("react/jsx-runtime").JSX.Element;

package/dist/types/react-viewers/ultra/ultraControlBarState.d.ts

@@ -1,6 +0,0 @@
-import { ControlBarCustomization } from '../controlbar/controlBar';
-import { SectionBoxRef } from '../state/sectionBoxState';
-import * as Ultra from '../../core-viewers/ultra/index';
-export { buttonDefaultStyle, buttonBlueStyle } from '../controlbar/controlBarButton';
-export { sectionDefaultStyle, sectionBlueStyle } from '../controlbar/controlBarSection';
-export declare function useUltraControlBar(viewer: Ultra.Viewer, section: SectionBoxRef, customization: ControlBarCustomization | undefined): import("../controlbar/controlBarSection").IControlBarSection[];

package/dist/types/react-viewers/ultra/ultraModal.d.ts

@@ -1,4 +0,0 @@
-import { ModalRef } from "../panels/modal";
-import * as Ultra from '../../core-viewers/ultra/index';
-export declare function updateModal(modal: ModalRef, state: Ultra.ClientState): void;
-export declare function updateProgress(request: Ultra.ILoadRequest, modal: ModalRef): Promise<void>;

package/dist/types/react-viewers/ultra/ultraSectionBoxState.d.ts

@@ -1,3 +0,0 @@
-import * as Ultra from '../../core-viewers/ultra/index';
-import { SectionBoxRef } from '../state/sectionBoxState';
-export declare function useUltraSectionBox(viewer: Ultra.Viewer): SectionBoxRef;

package/dist/types/react-viewers/webgl/webglComponent.d.ts

@@ -1,28 +0,0 @@
-/**
- * @module public-api
- */
-import * as VIM from '../../core-viewers/webgl/index';
-import { PartialComponentSettings } from '../settings/settings';
-import { Container } from '../container';
-import { VimComponentRef } from './webglComponentRef';
-/**
- * Creates a UI container along with a VIM.Viewer and its associated React component.
- * @param container An optional container object. If none is provided, a container will be created.
- * @param componentSettings UI Component settings.
-*  @param viewerSettings Viewer settings.
- * @returns An object containing the resulting container, reactRoot, and viewer.
- */
-export declare function createWebglComponent(container?: Container | HTMLElement, componentSettings?: PartialComponentSettings, viewerSettings?: VIM.PartialViewerSettings): Promise<VimComponentRef>;
-/**
- * Represents a React component providing UI for the Vim viewer.
- * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
- * @param viewer The Vim viewer instance for which UI is provided.
- * @param onMount A callback function triggered when the component is mounted. Receives a reference to the Vim component.
- * @param settings Optional settings for configuring the Vim component's behavior.
- */
-export declare function VimComponent(props: {
-    container: Container;
-    viewer: VIM.Viewer;
-    onMount: (component: VimComponentRef) => void;
-    settings?: PartialComponentSettings;
-}): import("react/jsx-runtime").JSX.Element;

package/dist/types/react-viewers/webgl/webglComponentRef.d.ts

@@ -1,118 +0,0 @@
-/**
- * @module public-api
- */
-import * as VIM from '../../core-viewers/webgl/index';
-import { ContextMenuCustomization } from '../panels/contextMenu';
-import { ComponentSettings } from '../settings/settings';
-import { Isolation } from '../helpers/isolation';
-import { ComponentCamera } from '../helpers/camera';
-import { Container } from '../container';
-import { BimInfoPanelRef } from '../bim/bimInfoData';
-import { ControlBarCustomization } from '../controlbar/controlBar';
-import { ComponentLoader } from './webglLoading';
-import { ModalRef } from '../panels/modal';
-import { SectionBoxRef } from '../state/sectionBoxState';
-/**
-* Settings API managing settings applied to the component.
-*/
-export type SettingsRef = {
-    /**
-     * Allows updating settings by providing a callback function.
-     * @param updater A function that updates the current settings.
-     */
-    update: (updater: (settings: ComponentSettings) => void) => void;
-    /**
-     * Registers a callback function to be notified when settings are updated.
-     * @param callback A function to be called when settings are updated, receiving the updated settings.
-     */
-    register: (callback: (settings: ComponentSettings) => void) => void;
-};
-/**
- * Reference to manage context menu functionality in the component.
- */
-export type ContextMenuRef = {
-    /**
-     * Defines a callback function to dynamically customize the context menu.
-     * @param customization The configuration object specifying the customization options for the context menu.
-     */
-    customize: (customization: ContextMenuCustomization) => void;
-};
-/**
- * Reference to manage control bar functionality in the component.
- */
-export type ControlBarRef = {
-    /**
-     * Defines a callback function to dynamically customize the control bar.
-     * @param customization The configuration object specifying the customization options for the control bar.
-     */
-    customize: (customization: ControlBarCustomization) => void;
-};
-/**
- * Reference to manage help message functionality in the component.
- */
-export type HelpRef = {
-    /**
-     * Displays the help message.
-     * @param value Boolean value to show or hide the help message.
-     * @returns void
-     */
-    show(value: boolean): void;
-    /**
-     * Returns the current state of the help message.
-     * @returns boolean indicating if help message is currently shown
-     */
-    isShow(): boolean;
-};
-/**
- * Root-level API of the Vim component.
- */
-export type VimComponentRef = {
-    /**
-     * HTML structure containing the component.
-     */
-    container: Container;
-    /**
-     * Vim WebGL viewer around which the WebGL component is built.
-     */
-    viewer: VIM.Viewer;
-    /**
-     * Vim WebGL loader to download VIMs.
-     */
-    loader: ComponentLoader;
-    /**
-     * Isolation API managing isolation state in the component.
-     */
-    isolation: Isolation;
-    /**
-     * Section box API managing the section box in the component.
-     */
-    sectionBox: SectionBoxRef;
-    /**
-     * Context menu API managing the content and behavior of the context menu.
-     */
-    contextMenu: ContextMenuRef;
-    /**
-     * Control bar API managing the content and behavior of the control bar.
-     */
-    controlBar: ControlBarRef;
-    /**
-     * Settings API managing settings applied to the component.
-     */
-    settings: SettingsRef;
-    /**
-     * Message API to interact with the loading box.
-     */
-    modal: ModalRef;
-    /**
-     * Camera API to interact with the viewer camera at a higher level.
-     */
-    camera: ComponentCamera;
-    /**
-     * API To interact with the BIM info panel.
-     */
-    bimInfo: BimInfoPanelRef;
-    /**
-     * Cleans up and releases resources used by the component.
-     */
-    dispose: () => void;
-};

package/dist/types/react-viewers/webgl/webglSectionBoxState.d.ts

@@ -1,3 +0,0 @@
-import * as VIM from '../../core-viewers/webgl/index';
-import { SectionBoxRef } from '../state/sectionBoxState';
-export declare function useWebglSectionBox(viewer: VIM.Viewer): SectionBoxRef;