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

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

@@ -0,0 +1,28 @@
+/**
+ * @module public-api
+ */
+import * as Core from '../../core-viewers';
+import { PartialSettings } from '../settings';
+import { Container } from '../container';
+import { ViewerRef } from './viewerRef';
+/**
+ * Creates a UI container along with a VIM.Viewer and its associated React viewer.
+ * @param container An optional container object. If none is provided, a container will be created.
+ * @param settings UI Component settings.
+*  @param coreSettings Viewer settings.
+ * @returns An object containing the resulting container, reactRoot, and viewer.
+ */
+export declare function createViewer(container?: Container | HTMLElement, settings?: PartialSettings, coreSettings?: Core.Webgl.PartialViewerSettings): Promise<ViewerRef>;
+/**
+ * Represents a React viewer 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 viewer is mounted. Receives a reference to the Vim viewer.
+ * @param settings Optional settings for configuring the Vim viewer's behavior.
+ */
+export declare function Viewer(props: {
+    container: Container;
+    viewer: Core.Webgl.Viewer;
+    onMount: (viewer: ViewerRef) => void;
+    settings?: PartialSettings;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,107 @@
+/**
+ * @module public-api
+ */
+import * as Core from '../../core-viewers';
+import { ContextMenuRef } from '../panels/contextMenu';
+import { Settings } from '../settings/settings';
+import { CameraRef } from '../state/cameraState';
+import { Container } from '../container';
+import { BimInfoPanelRef } from '../bim/bimInfoData';
+import { ControlBarRef } from '../controlbar';
+import { ComponentLoader } from './loading';
+import { ModalHandle } from '../panels/modal';
+import { SectionBoxRef } from '../state/sectionBoxState';
+import { IsolationRef } from '../state/sharedIsolation';
+import { GenericPanelHandle } from '../generic';
+/**
+* Settings API managing settings applied to the viewer.
+*/
+export type SettingsRef = {
+    /**
+     * Allows updating settings by providing a callback function.
+     * @param updater A function that updates the current settings.
+     */
+    update: (updater: (settings: Settings) => 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: Settings) => void) => void;
+};
+/**
+ * Reference to manage help message functionality in the viewer.
+ */
+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 viewer.
+ */
+export type ViewerRef = {
+    /**
+     * HTML structure containing the viewer.
+     */
+    container: Container;
+    /**
+     * Vim WebGL viewer around which the WebGL viewer is built.
+     */
+    core: Core.Webgl.Viewer;
+    /**
+     * Vim WebGL loader to download VIMs.
+     */
+    loader: ComponentLoader;
+    /**
+     * Isolation API managing isolation state in the viewer.
+     */
+    isolation: IsolationRef;
+    /**
+     * Section box API managing the section box in the viewer.
+     */
+    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 viewer.
+     */
+    settings: SettingsRef;
+    /**
+     * Message API to interact with the loading box.
+     */
+    modal: ModalHandle;
+    /**
+     * Camera API to interact with the viewer camera at a higher level.
+     */
+    camera: CameraRef;
+    /**
+     * API To interact with the BIM info panel.
+     */
+    bimInfo: BimInfoPanelRef;
+    /**
+     * API to interact with the isolation panel.
+     */
+    isolationPanel: GenericPanelHandle;
+    /**
+     * API to interact with the isolation panel.
+     */
+    sectionBoxPanel: GenericPanelHandle;
+    /**
+     * Cleans up and releases resources used by the viewer.
+     */
+    dispose: () => void;
+};

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

@@ -1,11 +1,13 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import { AugmentedElement } from '../helpers/element';
+import { StateRef } from '../helpers/reactUtils';
 export type ViewerState = {
-    vim: VIM.Vim;
-    selection: VIM.Object3D[];
-    elements: AugmentedElement[];
+    vim: StateRef<Core.Webgl.Vim>;
+    selection: StateRef<Core.Webgl.Element3D[]>;
+    elements: StateRef<AugmentedElement[]>;
+    filter: StateRef<string>;
 };
-export declare function useViewerState(viewer: VIM.Viewer): ViewerState;
+export declare function useViewerState(viewer: Core.Webgl.Viewer): ViewerState;

package/dist/types/utils/debounce.d.ts

@@ -0,0 +1,30 @@
+import { ISignal } from 'ste-signals';
+export declare function debounce<T extends (...args: any[]) => void>(func: T, delay: number): [(...args: Parameters<T>) => void, () => void];
+/**
+ * A debounced signal that dispatches at most once per animation frame.
+ */
+export declare class DebouncedSignal {
+    private _dispatcher;
+    private _frameRequestId;
+    /**
+     * Indicates whether a dispatch is currently scheduled.
+     *
+     * @returns `true` if a dispatch is scheduled; otherwise `false`.
+     */
+    get isScheduled(): boolean;
+    /**
+     * Returns the signal interface that subscribers can listen to.
+     *
+     * @returns An `ISignal` that is dispatched once per frame when requested.
+     */
+    get signal(): ISignal;
+    /**
+     * Schedules the signal to be dispatched on the next animation frame.
+     * Has no effect if a dispatch is already scheduled.
+     */
+    requestDispatch(): void;
+    /**
+     * Cancels a scheduled signal dispatch if one exists.
+     */
+    cancel(): void;
+}

package/dist/types/utils/index.d.ts

@@ -0,0 +1,10 @@
+export * from './array';
+export * from './debounce';
+export * from './interfaces';
+export * from './math3d';
+export * from './partial';
+export * from './promise';
+export * from './result';
+export * from './threeUtils';
+export * from './url';
+export * from './validation';

package/dist/types/utils/interfaces.d.ts

@@ -0,0 +1,3 @@
+export interface ForEachable<T> {
+    forEach(callback: (value: T) => void): void;
+}

package/dist/types/utils/math3d.d.ts

@@ -0,0 +1,19 @@
+export { Matrix4 as Matrix44, } from 'three';
+export { Vector2, Vector3, Box3 } from 'three';
+import { Vector2 } from 'three';
+/**
+ * Checks if two Vector2 objects are approximately equal.
+ * @param v1 - First Vector2.
+ * @param v2 - Second Vector2.
+ * @param epsilon - Tolerance for floating-point comparisons.
+ * @returns True if vectors are almost equal, false otherwise.
+ */
+export declare function almostEqual(v1: Vector2, v2: Vector2, epsilon?: number): boolean;
+/**
+ * Remaps the given value from the range [0-1] to [0-max].
+ */
+export declare function remap(value: number, max: number): number;
+/**
+ * Clamps the given value between the given min and max.
+ */
+export declare function clamp(value: number, min: number, max: number): number;

package/dist/types/utils/partial.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Makes all field optional recursively
+ * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};

package/dist/types/{core-viewers/webgl/utils/requestResult.d.ts → utils/result.d.ts}

@@ -10,4 +10,4 @@ export declare class ErrorResult {
     isSuccess(): false;
     isError(): this is ErrorResult;
 }
-export type RequestResult<T> = SuccessResult<T> | ErrorResult;
+export type Result<T> = SuccessResult<T> | ErrorResult;

package/dist/types/{core-viewers/webgl/utils → utils}/threeUtils.d.ts

@@ -1,3 +1,4 @@
 import * as THREE from 'three';
 export declare function addBox(b1: THREE.Box3, b2: THREE.Box3): THREE.Box3;
 export declare function subBox(b1: THREE.Box3, b2: THREE.Box3): THREE.Box3;
+export declare function safeBox(b1: THREE.Box3): THREE.Box3;

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

@@ -6,3 +6,5 @@
 export declare function isURL(str: string): boolean;
 export declare function isFileURI(inputString: string | null | undefined): boolean;
 export declare function isWebSocketUrl(input: string): boolean;
+export declare function isLocalUrl(url: string): boolean;
+export declare function isFilePathOrUri(input: string): boolean;

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

@@ -1,4 +1,5 @@
-import { Box3, RGB, RGBA, Segment, Vector2, Vector3 } from './math3d';
+import * as THREE from 'three';
+import * as Core from '../core-viewers';
 export declare class Validation {
     static isNumber(value: number): boolean;
     static isPositiveNumber(value: number): boolean;
@@ -9,13 +10,13 @@ export declare class Validation {
     static isComponentHandle(handle: number): boolean;
     static areComponentHandles(handles: number[]): boolean;
     static isMaterialHandle(handle: number): boolean;
-    static isValidVector2(value: Vector2): boolean;
-    static isRelativeVector2(value: Vector2): boolean;
-    static isValidVector3(value: Vector3): boolean;
-    static isValidBox(box: Box3): boolean;
-    static isValidSegment(segment: Segment): boolean;
-    static isRelativeRGBA(color: RGBA): boolean;
-    static isRelativeRGB(color: RGB): boolean;
+    static isValidVector2(value: THREE.Vector2): boolean;
+    static isRelativeVector2(value: THREE.Vector2): boolean;
+    static isValidVector3(value: THREE.Vector3): boolean;
+    static isValidBox(box: THREE.Box3): boolean;
+    static isValidSegment(segment: Core.Ultra.Segment): boolean;
+    static isRelativeRGBA(color: Core.Ultra.RGBA): boolean;
+    static isRelativeRGB(color: Core.Ultra.RGB): boolean;
     static isNonEmptyString(value: string): boolean;
     static isURL(value: string): boolean;
     static areSameLength<T1, T2>(array: T1[], array2: T2[]): boolean;
@@ -23,6 +24,6 @@ export declare class Validation {
     static clamp(min: number, max: number, value: number): number;
     static clamp01(value: number): number;
     static min0(value: number): number;
-    static clampRGBA01(value: RGBA): RGBA;
-    static clampRGB01(value: RGBA): RGBA;
+    static clampRGBA01(value: Core.Ultra.RGBA): Core.Ultra.RGBA;
+    static clampRGB01(value: Core.Ultra.RGBA): Core.Ultra.RGBA;
 }