vim-web 0.5.0-dev.9 → 0.6.0-dev.0

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

@@ -4,18 +4,14 @@
 import * as Core from '../../core-viewers';
 import { LoadRequest } from '../helpers/loadRequest';
 import { ModalHandle } from '../panels/modal';
-import { Settings } from '../settings';
+import { WebglSettings } from './settings';
+import { IProgress } from '../../core-viewers/shared/loadResult';
 type AddSettings = {
     /**
      * Controls whether to frame the camera on a vim everytime it is updated.
      * Default: true
      */
     autoFrame?: boolean;
-    /**
-     * Controls whether to initially load the vim content or not.
-     * Default: false
-     */
-    loadEmpty?: boolean;
 };
 export type OpenSettings = Core.Webgl.VimPartialSettings & AddSettings;
 export type LoadingError = {
@@ -30,13 +26,13 @@ export declare class ComponentLoader {
     private _viewer;
     private _modal;
     private _addLink;
-    constructor(viewer: Core.Webgl.Viewer, modal: React.RefObject<ModalHandle>, settings: Settings);
+    constructor(viewer: Core.Webgl.Viewer, modal: React.RefObject<ModalHandle>, settings: WebglSettings);
     /**
      * Event emitter for progress updates.
      */
-    onProgress(p: Core.Webgl.IProgressLogs): void;
+    onProgress(p: IProgress): void;
     /**
-       * Event emitter for completion notifications.
+      * Event emitter for completion notifications.
      */
     onDone(): void;
     /**
@@ -44,26 +40,25 @@ export declare class ComponentLoader {
      */
     onError(e: LoadingError): void;
     /**
-     * Asynchronously opens a vim at source, applying the provided settings.
-     * @param source The source to open, either as a string or ArrayBuffer.
-     * @param settings Partial settings to apply to the opened source.
-     * @param onProgress Optional callback function to track progress during opening.
-     * Receives progress logs as input.
-     */
-    open(source: Core.Webgl.RequestSource, settings: OpenSettings, onProgress?: (p: Core.Webgl.IProgressLogs) => void): Promise<Core.Webgl.Vim>;
-    /**
-     * Creates a new load request for the provided source and settings.
+     * Opens a vim file without loading geometry.
+     * Use this for querying BIM data or selective loading.
+     * Call vim.loadAll() or vim.loadSubset() to load geometry later.
      * @param source The url to the vim file or a buffer of the file.
      * @param settings Settings to apply to vim file.
-     * @returns A new load request instance to track progress and get result.
+     * @returns A LoadRequest to track progress and get result. The vim is auto-added on success.
+     * @throws Error if the viewer has reached maximum capacity (256 vims)
      */
-    request(source: Core.Webgl.RequestSource, settings?: Core.Webgl.VimPartialSettings): LoadRequest;
-    add(vim: Core.Webgl.Vim, settings?: AddSettings): void;
+    open(source: Core.Webgl.RequestSource, settings?: OpenSettings): LoadRequest;
     /**
-     * Removes the vim from the viewer and disposes it.
-     * @param vim Vim to remove from the viewer.
+     * Loads a vim file with all geometry.
+     * Use this for immediate viewing.
+     * @param source The url to the vim file or a buffer of the file.
+     * @param settings Settings to apply to vim file.
+     * @returns A LoadRequest to track progress and get result. The vim is auto-added on success.
+     * @throws Error if the viewer has reached maximum capacity (256 vims)
      */
-    remove(vim: Core.Webgl.Vim): void;
+    load(source: Core.Webgl.RequestSource, settings?: OpenSettings): LoadRequest;
+    private loadInternal;
     private initVim;
 }
 export {};

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

@@ -0,0 +1,36 @@
+import { RecursivePartial } from "../../utils";
+import { UserBoolean } from "../settings/userBoolean";
+import { ControlBarCameraSettings, ControlBarCursorSettings, ControlBarMeasureSettings, ControlBarSectionBoxSettings, ControlBarVisibilitySettings } from "../state/controlBarState";
+export type PartialWebglSettings = RecursivePartial<WebglSettings>;
+/**
+ * Complete settings configuration for the Vim viewer
+ * @interface Settings
+ */
+export type WebglSettings = {
+    capacity: {
+        canFollowUrl: boolean;
+        canGoFullScreen: boolean;
+        canDownload: boolean;
+        canReadLocalStorage: boolean;
+    };
+    ui: ControlBarCameraSettings & ControlBarCursorSettings & ControlBarSectionBoxSettings & ControlBarVisibilitySettings & ControlBarMeasureSettings & {
+        panelLogo: UserBoolean;
+        panelBimTree: UserBoolean;
+        panelBimInfo: UserBoolean;
+        panelPerformance: UserBoolean;
+        panelAxes: UserBoolean;
+        panelControlBar: UserBoolean;
+        axesOrthographic: UserBoolean;
+        axesHome: UserBoolean;
+        miscProjectInspector: UserBoolean;
+        miscSettings: UserBoolean;
+        miscHelp: UserBoolean;
+        miscMaximise: UserBoolean;
+    };
+};
+/**
+ * Default settings configuration for the React Webgl Vim viewer
+ * @constant
+ * @type {WebglSettings}
+ */
+export declare function getDefaultSettings(): WebglSettings;

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

@@ -0,0 +1,12 @@
+import { Viewer } from "../../core-viewers/webgl";
+import { SettingsItem } from "../settings/settingsItem";
+import { WebglSettings } from "./settings";
+export declare function getControlBarVariousSettings(): SettingsItem<WebglSettings>[];
+export declare function getPanelsVisibilitySettings(): SettingsItem<WebglSettings>[];
+export declare function getInputsSettings(viewer: Viewer): SettingsItem<WebglSettings>[];
+export declare function getControlBarMeasureSettings(): SettingsItem<WebglSettings>[];
+export declare function getWebglSettingsContent(viewer: Viewer): SettingsItem<WebglSettings>[];
+/**
+ * Apply given vim viewer settings to the given viewer.
+ */
+export declare function applyWebglSettings(settings: WebglSettings): void;

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

@@ -2,9 +2,9 @@
  * @module public-api
  */
 import * as Core from '../../core-viewers';
-import { PartialSettings } from '../settings';
 import { Container } from '../container';
 import { ViewerRef } from './viewerRef';
+import { PartialWebglSettings } from './settings';
 /**
  * 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.
@@ -12,7 +12,7 @@ import { ViewerRef } from './viewerRef';
 *  @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>;
+export declare function createViewer(container?: Container | HTMLElement, settings?: PartialWebglSettings, 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.
@@ -24,5 +24,5 @@ export declare function Viewer(props: {
     container: Container;
     viewer: Core.Webgl.Viewer;
     onMount: (viewer: ViewerRef) => void;
-    settings?: PartialSettings;
+    settings?: PartialWebglSettings;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -3,30 +3,38 @@
  */
 import * as Core from '../../core-viewers';
 import { ContextMenuRef } from '../panels/contextMenu';
-import { Settings } from '../settings/settings';
+import { AnySettings } from '../settings/anySettings';
 import { CameraRef } from '../state/cameraState';
 import { Container } from '../container';
 import { BimInfoPanelRef } from '../bim/bimInfoData';
 import { ControlBarRef } from '../controlbar';
-import { ComponentLoader } from './loading';
+import { OpenSettings } from './loading';
 import { ModalHandle } from '../panels/modal';
 import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
 import { GenericPanelHandle } from '../generic';
+import { SettingsItem } from '../settings/settingsItem';
+import { WebglSettings } from './settings';
+export type { OpenSettings } from './loading';
 /**
 * Settings API managing settings applied to the viewer.
 */
-export type SettingsRef = {
+export type SettingsRef<T extends AnySettings> = {
     /**
      * Allows updating settings by providing a callback function.
      * @param updater A function that updates the current settings.
      */
-    update: (updater: (settings: Settings) => void) => void;
+    update: (updater: (settings: T) => 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;
+    register: (callback: (settings: T) => void) => void;
+    /**
+     * Customizes the settings panel by providing a customizer function.
+     * @param customizer A function that modifies the settings items.
+     */
+    customize: (customizer: (items: SettingsItem<T>[]) => SettingsItem<T>[]) => void;
 };
 /**
  * Reference to manage help message functionality in the viewer.
@@ -57,9 +65,25 @@ export type ViewerRef = {
      */
     core: Core.Webgl.Viewer;
     /**
-     * Vim WebGL loader to download VIMs.
+     * Loads a vim file with all geometry for immediate viewing.
+     * @param source The url or buffer of the vim file
+     * @param settings Optional settings
+     * @returns LoadRequest to track progress and get result
+     */
+    load: (source: Core.Webgl.RequestSource, settings?: OpenSettings) => Core.Webgl.ILoadRequest;
+    /**
+     * Opens a vim file without loading geometry.
+     * Use for BIM queries or selective loading via vim.loadAll()/loadSubset().
+     * @param source The url or buffer of the vim file
+     * @param settings Optional settings
+     * @returns LoadRequest to track progress and get result
+     */
+    open: (source: Core.Webgl.RequestSource, settings?: OpenSettings) => Core.Webgl.ILoadRequest;
+    /**
+     * Removes a vim from the viewer and disposes it.
+     * @param vim The vim to remove
      */
-    loader: ComponentLoader;
+    remove: (vim: Core.Webgl.Vim) => void;
     /**
      * Isolation API managing isolation state in the viewer.
      */
@@ -79,7 +103,7 @@ export type ViewerRef = {
     /**
      * Settings API managing settings applied to the viewer.
      */
-    settings: SettingsRef;
+    settings: SettingsRef<WebglSettings>;
     /**
      * Message API to interact with the loading box.
      */

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

@@ -0,0 +1,15 @@
+/**
+ * A queue that converts push-based callbacks into an async iterator.
+ * Use this to bridge callback-based APIs with async/await consumers.
+ */
+export declare class AsyncQueue<T> {
+    private _queue;
+    private _waiters;
+    private _closed;
+    /** Push a value to the queue. Wakes up one waiting consumer. */
+    push(value: T): void;
+    /** Close the queue. No more values can be pushed. */
+    close(): void;
+    /** Async iterator that yields queued values until closed. */
+    [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
+}

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

@@ -1,10 +1,10 @@
 export * from './array';
+export * from './asyncQueue';
 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';