vim-web 0.5.0-dev.2 → 0.5.0-dev.20

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

@@ -27,7 +27,12 @@ export declare class InstancedMesh {
      * Returns all submeshes for given index.
      */
     getSubmeshes(): InstancedSubmesh[];
+    /**
+       * Sets the material for this mesh.
+       * Set to undefined to reset to original materials.
+       */
     setMaterial(value: ModelMaterial): void;
+    private _mergeMaterials;
     private computeBoundingBoxes;
     private importBoundingBoxes;
     computeBoundingBox(boxes: THREE.Box3[]): THREE.Box3;

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

@@ -18,6 +18,11 @@ type VimFormat = 'vim' | 'vimx';
  * Facilitates high-level scene manipulation by providing access to objects.
  */
 export declare class Vim implements IVim<Element3D> {
+    /**
+     * The type of the viewer, indicating it is a WebGL viewer.
+     * Useful for distinguishing between different viewer types in a multi-viewer application.
+     */
+    readonly type = "webgl";
     /**
      * Indicates whether the vim was opened from a vim or vimx file.
      */

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

@@ -32,6 +32,7 @@ export declare class Marker implements IVimElement {
      * The index of the marker in the marker collection.
      */
     get index(): number;
+    get isRoom(): boolean;
     private _outlineAttribute;
     private _visibleAttribute;
     private _coloredAttribute;

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

@@ -62,8 +62,15 @@ export declare class Renderer implements IRenderer {
      */
     get background(): THREE.Color | THREE.Texture;
     set background(color: THREE.Color | THREE.Texture);
+    /**
+     * Sets the material used to render models. If set to undefined, the default model or mesh material is used.
+     */
     get modelMaterial(): ModelMaterial;
     set modelMaterial(material: ModelMaterial);
+    /**
+     * The material that will be used when setting model material to undefined.
+     */
+    defaultModelMaterial: ModelMaterial;
     /**
      * Signal dispatched at the end of each frame if the scene was updated, such as visibility changes.
      */

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

@@ -17,6 +17,11 @@ import { Renderer } from './rendering/renderer';
  * Viewer and loader for vim files.
  */
 export declare class Viewer {
+    /**
+     * The type of the viewer, indicating it is a WebGL viewer.
+     * Useful for distinguishing between different viewer types in a multi-viewer application.
+     */
+    readonly type = "webgl";
     /**
      * The settings configuration used by the viewer.
      */

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

@@ -62,7 +62,7 @@ export declare class Viewport {
     /**
      * Resizes the canvas and updates the camera to match new parent dimensions.
      */
-    ResizeToParent(): void;
+    resizeToParent(): void;
     /**
      * Set a callback for canvas resize with debouncing
      * https://stackoverflow.com/questions/5825447/javascript-event-for-canvas-resize/30688151

package/dist/types/react-viewers/bim/bimPanel.d.ts

@@ -3,19 +3,19 @@
  */
 import React from 'react';
 import * as Core from '../../core-viewers';
-import { Settings } from '../settings';
 import { CameraRef } from '../state/cameraState';
 import { IsolationRef } from '../state/sharedIsolation';
 import { ViewerState } from '../webgl/viewerState';
 import { BimInfoPanelRef } from './bimInfoData';
 import { TreeActionRef } from './bimTree';
+import { WebglSettings } from '../webgl/settings';
 export declare function OptionalBimPanel(props: {
     viewer: Core.Webgl.Viewer;
     camera: CameraRef;
     viewerState: ViewerState;
     isolation: IsolationRef;
     visible: boolean;
-    settings: Settings;
+    settings: WebglSettings;
     treeRef: React.MutableRefObject<TreeActionRef | undefined>;
     bimInfoRef: BimInfoPanelRef;
 }): JSX.Element;
@@ -34,7 +34,7 @@ export declare function BimPanel(props: {
     viewerState: ViewerState;
     isolation: IsolationRef;
     visible: boolean;
-    settings: Settings;
+    settings: WebglSettings;
     treeRef: React.MutableRefObject<TreeActionRef | undefined>;
     bimInfoRef: BimInfoPanelRef;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -4,7 +4,7 @@ export declare const vcColorLink = "vc-text-[#0590CC]";
 export declare const vcLink = "vc-text-[#0590CC] vc-underline";
 export declare const vcLabel = "vc-text-[#3F444F]";
 export declare const vcRoboto = "vc-font-['Roboto',sans-serif]";
-export declare function footer(url: string): import("react/jsx-runtime").JSX.Element;
+export declare function footer(): import("react/jsx-runtime").JSX.Element;
 export declare function mainText(text: JSX.Element): import("react/jsx-runtime").JSX.Element;
 export declare function detailText(text: string): import("react/jsx-runtime").JSX.Element;
 export declare function bold(text: string): import("react/jsx-runtime").JSX.Element;

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

@@ -55,9 +55,10 @@ export declare function useRefresher(): StateRefresher;
  * The reference provides access to the state, along with event dispatching, validation, and confirmation logic.
  *
  * @param initialValue - The initial state value.
+ * @param isLazy - Whether to treat the initialValue as a lazy initializer function.
  * @returns An object implementing StateRef along with additional helper hooks.
  */
-export declare function useStateRef<T>(initialValue: T | (() => T)): {
+export declare function useStateRef<T>(initialValue: T | (() => T), isLazy?: boolean): {
     /**
      * Returns the current state value.
      */

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

@@ -5,3 +5,11 @@ export declare function whenAllTrue(value: (UserBoolean | boolean)[], element: J
 export declare function whenAllFalse(value: (UserBoolean | boolean)[], element: JSX.Element): JSX.Element;
 export declare function whenSomeTrue(value: (UserBoolean | boolean)[], element: JSX.Element): JSX.Element;
 export declare function whenSomeFalse(value: (UserBoolean | boolean)[], element: JSX.Element): JSX.Element;
+/**
+ * Makes all fields optional recursively
+ * @template T - The type to make recursively partial
+ * @returns A type with all nested properties made optional
+ */
+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/react-viewers/panels/axesPanel.d.ts

@@ -5,6 +5,7 @@ import React from 'react';
 import * as Core from '../../core-viewers';
 import { CameraRef } from '../state/cameraState';
 import { SettingsState } from '../settings/settingsState';
+import { WebglSettings } from '../webgl/settings';
 /**
  * Memoized version of the AxesPanelMemo.
  */
@@ -15,6 +16,6 @@ export declare const AxesPanelMemo: React.MemoExoticComponent<typeof AxesPanel>;
 declare function AxesPanel(props: {
     viewer: Core.Webgl.Viewer;
     camera: CameraRef;
-    settings: SettingsState;
+    settings: SettingsState<WebglSettings>;
 }): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/react-viewers/panels/index.d.ts

@@ -3,6 +3,7 @@ export declare const SectionBoxPanel: {
     Ids: {
         showGhost: string;
         ghostOpacity: string;
+        transparency: string;
     };
 };
 export declare const IsolationPanel: {

package/dist/types/react-viewers/panels/isolationPanel.d.ts

@@ -3,7 +3,9 @@ import { GenericPanelHandle } from "../generic/genericPanel";
 export declare const Ids: {
     showGhost: string;
     ghostOpacity: string;
+    transparency: string;
 };
 export declare const IsolationPanel: import("react").ForwardRefExoticComponent<{
     state: IsolationRef;
+    transparency: boolean;
 } & import("react").RefAttributes<GenericPanelHandle>>;

package/dist/types/react-viewers/panels/messageBox.d.ts

@@ -1,8 +1,10 @@
 export type MessageBoxProps = {
     title: string;
     body: string | JSX.Element;
+    icon?: JSX.Element;
     footer?: string | JSX.Element;
     canClose?: boolean;
+    minimize?: boolean;
     onClose?: () => void;
 };
 export type MessageBoxPropsTyped = MessageBoxProps & {

package/dist/types/react-viewers/panels/sidePanel.d.ts

@@ -15,6 +15,6 @@ export declare const SidePanelMemo: React.MemoExoticComponent<typeof SidePanel>;
 export declare function SidePanel(props: {
     container: Container;
     side: SideState;
-    viewer: Core.Webgl.Viewer;
+    viewer: Core.Webgl.Viewer | Core.Ultra.Viewer;
     content: () => JSX.Element;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,7 @@
+/**
+ * @module viw-webgl-react
+ * Contains settings and type definitions for the Vim web viewer
+ */
+import { UltraSettings } from "../ultra/settings";
+import { WebglSettings } from "../webgl/settings";
+export type AnySettings = WebglSettings | UltraSettings;

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

@@ -1,4 +1,4 @@
-export * from './settings';
+export * from './anySettings';
 export * from './settingsStorage';
 export * from './userBoolean';
 export type * from './settingsPanel';

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

@@ -0,0 +1,4 @@
+import { SettingsBox } from './settingsItem';
+import { SettingsState } from './settingsState';
+import { AnySettings } from './anySettings';
+export declare function renderSettingsInputBox(settings: SettingsState<AnySettings>, item: SettingsBox<AnySettings>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,30 @@
+import { AnySettings } from './anySettings';
+import { UserBoolean } from './userBoolean';
+export type SettingsCustomizer<T extends AnySettings> = (items: SettingsItem<T>[]) => SettingsItem<T>[];
+export type SettingsItem<T extends AnySettings> = SettingsSubtitle | SettingsToggle<T> | SettingsBox<T> | SettingsElement;
+export type BaseSettingsItem = {
+    type: string;
+    key: string;
+};
+export type SettingsSubtitle = BaseSettingsItem & {
+    type: 'subtitle';
+    title: string;
+};
+export type SettingsToggle<T extends AnySettings> = BaseSettingsItem & {
+    type: 'toggle';
+    label: string;
+    getter: (settings: T) => UserBoolean;
+    setter: (settings: T, b: boolean) => void;
+};
+export type SettingsBox<T extends AnySettings> = BaseSettingsItem & {
+    type: 'box';
+    label: string;
+    info: string;
+    transform: (value: number) => number;
+    getter: (settings: T) => number;
+    setter: (settings: T, b: number) => void;
+};
+export type SettingsElement = BaseSettingsItem & {
+    type: 'element';
+    element: JSX.Element;
+};

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

@@ -0,0 +1,46 @@
+export declare class SettingsPanelKeys {
+    static InputsSubtitle: string;
+    static InputsScrollSpeedBox: string;
+    static PanelsSubtitle: string;
+    static PanelsShowLogoToggle: string;
+    static PanelsShowBimTreeToggle: string;
+    static PanelsShowBimInfoToggle: string;
+    static PanelsShowAxesPanelToggle: string;
+    static PanelsShowPerformancePanelToggle: string;
+    static AxesSubtitle: string;
+    static AxesShowOrthographicButtonToggle: string;
+    static AxesShowResetCameraButtonToggle: string;
+    static ControlBarSubtitle: string;
+    static ControlBarShowControlBarToggle: string;
+    static ControlBarCursorsSubtitle: string;
+    static ControlBarCursorsShowOrbitButtonToggle: string;
+    static ControlBarCursorsShowLookAroundButtonToggle: string;
+    static ControlBarCursorsShowPanButtonToggle: string;
+    static ControlBarCursorsShowZoomButtonToggle: string;
+    static ControlBarCursorsShowZoomWindowButtonToggle: string;
+    static ControlBarToolsSubtitle: string;
+    static ControlBarToolsShowMeasuringModeButtonToggle: string;
+    static ControlBarCameraSubtitle: string;
+    static ControlBarAutoCamera: string;
+    static ControlBarFrameSelection: string;
+    static ControlBarFrameAll: string;
+    static ControlBarSectioningSubtitle: string;
+    static ControlBarSectioningEnable: string;
+    static ControlBarSectioningFitToSelection: string;
+    static ControlBarSectioningReset: string;
+    static ControlBarSectioningShow: string;
+    static ControlBarSectioningAuto: string;
+    static ControlBarSectioningSettings: string;
+    static ControlBarVisibilitySubtitle: string;
+    static ControlBarVisibilityClearSelection: string;
+    static ControlBarVisibilityShowAll: string;
+    static ControlBarVisibilityToggle: string;
+    static ControlBarVisibilityIsolate: string;
+    static ControlBarVisibilityAutoIsolate: string;
+    static ControlBarVisibilitySettings: string;
+    static ControlBarSettingsSubtitle: string;
+    static ControlBarSettingsShowProjectInspectorButtonToggle: string;
+    static ControlBarSettingsShowSettingsButtonToggle: string;
+    static ControlBarSettingsShowHelpButtonToggle: string;
+    static ControlBarSettingsShowMaximiseButtonToggle: string;
+}

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

@@ -1,8 +1,9 @@
 /**
  * @module viw-webgl-react
  */
-import * as Core from '../../core-viewers';
 import { SettingsState } from './settingsState';
+import { SettingsItem } from './settingsItem';
+import { AnySettings } from './anySettings';
 /**
  * JSX Component to interact with settings.
  * @param viewer current viewer
@@ -10,8 +11,8 @@ import { SettingsState } from './settingsState';
  * @param visible will return null if this is false.
  * @returns
  */
-export declare function SettingsPanel(props: {
-    viewer: Core.Webgl.Viewer;
-    settings: SettingsState;
+export declare function SettingsPanel<T extends AnySettings>(props: {
+    content: SettingsItem<T>[];
+    settings: SettingsState<T>;
     visible: boolean;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,6 @@
+import { SettingsItem } from './settingsItem';
+import { AnySettings } from './anySettings';
+export declare function getControlBarCursorSettings(): SettingsItem<AnySettings>[];
+export declare function getControlBarCameraSettings(): SettingsItem<AnySettings>[];
+export declare function getControlBarSectionBoxSettings(): SettingsItem<AnySettings>[];
+export declare function getControlBarVisibilitySettings(): SettingsItem<AnySettings>[];

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

@@ -1,18 +1,18 @@
 /**
  * @module viw-webgl-react
  */
-import * as Core from '../../core-viewers';
-import { Settings, PartialSettings } from './settings';
-export type SettingsState = {
-    value: Settings;
-    update: (updater: (s: Settings) => void) => void;
-    register: (action: (s: Settings) => void) => void;
+import { StateRef } from '../helpers/reactUtils';
+import { SettingsCustomizer } from './settingsItem';
+import { AnySettings } from './anySettings';
+import { RecursivePartial } from '../../utils';
+export type SettingsState<T extends AnySettings> = {
+    value: T;
+    update: (updater: (s: T) => void) => void;
+    register: (action: (s: T) => void) => void;
+    customizer: StateRef<SettingsCustomizer<T>>;
 };
 /**
  * Returns a new state closure for settings.
  */
-export declare function useSettings(viewer: Core.Webgl.Viewer, value: PartialSettings): SettingsState;
-/**
- * Apply given vim viewer settings to the given viewer.
- */
-export declare function applySettings(viewer: Core.Webgl.Viewer, settings: Settings): void;
+export declare function useSettings<T extends AnySettings>(value: RecursivePartial<T>, defaultSettings: T, applySettings?: (settings: T) => void): SettingsState<T>;
+export declare function createSettings<T extends AnySettings>(settings: RecursivePartial<T>, defaultSettings: T): T;

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

@@ -1,15 +1,15 @@
 /**
  * @module viw-webgl-react
  */
-import { Settings, PartialSettings } from './settings';
+import { AnySettings } from './anySettings';
 /**
  * Retrieves viewer settings from localStorage and applies permissions
  * @param settings - Partial viewer settings to apply permissions from
  * @returns The stored settings with applied permissions, or empty object if retrieval fails
  */
-export declare function getLocalSettings(settings?: PartialSettings): {};
+export declare function getLocalSettings(settings?: Partial<AnySettings>): {};
 /**
  * Saves viewer settings to localStorage after removing permissions
  * @param value - Component settings to save
  */
-export declare function saveSettingsToLocal(value: Settings): void;
+export declare function saveSettingsToLocal(value: AnySettings): void;

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

@@ -0,0 +1,2 @@
+import { SettingsSubtitle } from './settingsItem';
+export declare function renderSettingsSubtitle(item: SettingsSubtitle): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,11 @@
+import { SettingsToggle } from './settingsItem';
+import { SettingsState } from './settingsState';
+import { AnySettings } from './anySettings';
+/**
+ * Renders a toggle (checkbox) UI element for a given SettingsToggle item.
+ * @param viewer   The WebGL viewer instance (for future consistency).
+ * @param settings The current settings state object.
+ * @param item     The SettingsToggle configuration.
+ * @returns JSX.Element | null
+ */
+export declare function renderSettingsToggle(settings: SettingsState<AnySettings>, item: SettingsToggle<AnySettings>): JSX.Element | null;

package/dist/types/react-viewers/state/controlBarState.d.ts

@@ -1,7 +1,6 @@
 import * as Core from "../../core-viewers";
 import { CameraRef } from './cameraState';
 import { CursorManager } from '../helpers/cursor';
-import { Settings } from '../settings';
 import { SideState } from './sideState';
 import * as Icons from '../icons';
 import { SectionBoxRef } from './sectionBoxState';
@@ -9,11 +8,31 @@ import { getMeasureState } from './measureState';
 import { ModalHandle } from '../panels/modal';
 import { IsolationRef } from './sharedIsolation';
 import * as ControlBar from '../controlbar';
+import { UserBoolean } from "../settings/userBoolean";
+import { UltraSettings } from "../ultra/settings";
+import { WebglSettings } from "../webgl/settings";
+export type ControlBarSectionBoxSettings = {
+    sectioningEnable: UserBoolean;
+    sectioningFitToSelection: UserBoolean;
+    sectioningReset: UserBoolean;
+    sectioningShow: UserBoolean;
+    sectioningAuto: UserBoolean;
+    sectioningSettings: UserBoolean;
+};
 /**
  * Returns a control bar section for the section box.
  */
-export declare function controlBarSectionBox(section: SectionBoxRef, hasSelection: boolean): ControlBar.IControlBarSection;
-export declare function controlBarMeasure(settings: Settings, measure: ReturnType<typeof getMeasureState>): {
+export declare function controlBarSectionBox(section: SectionBoxRef, hasSelection: boolean, settings: ControlBarSectionBoxSettings): ControlBar.IControlBarSection;
+export type ControlBarCursorSettings = {
+    cursorOrbit: UserBoolean;
+    cursorLookAround: UserBoolean;
+    cursorPan: UserBoolean;
+    cursorZoom: UserBoolean;
+};
+export type ControlBarMeasureSettings = {
+    measureEnable: UserBoolean;
+};
+export declare function controlBarMeasure(measure: ReturnType<typeof getMeasureState>, settings: ControlBarMeasureSettings): {
     id: string;
     enable: () => boolean;
     style: string;
@@ -27,12 +46,26 @@ export declare function controlBarMeasure(settings: Settings, measure: ReturnTyp
         style: typeof ControlBar.Style.buttonDefaultStyle;
     }[];
 };
-export declare function controlBarCamera(camera: CameraRef): ControlBar.IControlBarSection;
-export declare function controlBarSelection(isolation: IsolationRef): ControlBar.IControlBarSection;
+export declare function controlBarSettingsUltra(side: SideState, settings: UltraSettings): ControlBar.IControlBarSection;
+export type ControlBarCameraSettings = {
+    cameraAuto: UserBoolean;
+    cameraFrameSelection: UserBoolean;
+    cameraFrameScene: UserBoolean;
+};
+export declare function controlBarCamera(camera: CameraRef, settings: ControlBarCameraSettings): ControlBar.IControlBarSection;
+export type ControlBarVisibilitySettings = {
+    visibilityClearSelection: UserBoolean;
+    visibilityShowAll: UserBoolean;
+    visibilityToggle: UserBoolean;
+    visibilityIsolate: UserBoolean;
+    visibilityAutoIsolate: UserBoolean;
+    visibilitySettings: UserBoolean;
+};
+export declare function controlBarVisibility(isolation: IsolationRef, settings: ControlBarVisibilitySettings): ControlBar.IControlBarSection;
 /**
  * Combines all control bar sections into one control bar.
  */
-export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraRef, modal: ModalHandle, side: SideState, cursor: CursorManager, settings: Settings, section: SectionBoxRef, isolationRef: IsolationRef, customization: ControlBar.ControlBarCustomization | undefined): (ControlBar.IControlBarSection | {
+export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraRef, modal: ModalHandle, side: SideState, cursor: CursorManager, settings: WebglSettings, section: SectionBoxRef, isolationRef: IsolationRef, customization: ControlBar.ControlBarCustomization | undefined): (ControlBar.IControlBarSection | {
     id: string;
     enable: () => boolean;
     style: string;
@@ -51,4 +84,4 @@ export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraR
  * @param {Settings} settings - The viewer settings to check
  * @returns {boolean} True if any settings buttons are enabled
  */
-export declare function anyUiSettingButton(settings: Settings): boolean;
+export declare function anyUiSettingButton(settings: WebglSettings): boolean;

package/dist/types/react-viewers/state/sharedIsolation.d.ts

@@ -9,6 +9,7 @@ export interface IsolationRef {
     showPanel: StateRef<boolean>;
     showGhost: StateRef<boolean>;
     ghostOpacity: StateRef<number>;
+    transparency: StateRef<boolean>;
     showRooms: StateRef<boolean>;
     onAutoIsolate: FuncRef<void>;
     onVisibilityChange: FuncRef<void>;
@@ -32,6 +33,7 @@ export interface IsolationAdapter {
     showGhost(show: boolean): void;
     getGhostOpacity(): number;
     setGhostOpacity(opacity: number): void;
+    enableTransparency(enable: boolean): void;
     getShowRooms(): boolean;
     setShowRooms(show: boolean): void;
 }

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

@@ -3,4 +3,6 @@ import { ControlBarCustomization } from '../controlbar/controlBar';
 import { CameraRef } from '../state/cameraState';
 import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
-export declare function useUltraControlBar(viewer: Core.Viewer, section: SectionBoxRef, isolation: IsolationRef, camera: CameraRef, customization: ControlBarCustomization | undefined): import("../controlbar").IControlBarSection[];
+import { SideState } from '../state/sideState';
+import { UltraSettings } from './settings';
+export declare function useUltraControlBar(viewer: Core.Viewer, section: SectionBoxRef, isolation: IsolationRef, camera: CameraRef, settings: UltraSettings, side: SideState, customization: ControlBarCustomization | undefined): import("../controlbar").IControlBarSection[];

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

@@ -1,2 +1,3 @@
 export * from './viewer';
 export * from './viewerRef';
+export * from './settings';

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

@@ -0,0 +1,10 @@
+import { RecursivePartial } from "../helpers/utils";
+import { UserBoolean } from "../settings/userBoolean";
+import { ControlBarCameraSettings, ControlBarCursorSettings, ControlBarSectionBoxSettings, ControlBarVisibilitySettings } from "../state/controlBarState";
+export type PartialUltraSettings = RecursivePartial<UltraSettings>;
+export type UltraSettings = {
+    ui: ControlBarCameraSettings & ControlBarCursorSettings & ControlBarSectionBoxSettings & ControlBarVisibilitySettings & {
+        settings: UserBoolean;
+    };
+};
+export declare function getDefaultUltraSettings(): UltraSettings;

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

@@ -0,0 +1,5 @@
+import { Viewer } from "../../core-viewers/ultra";
+import { SettingsItem } from "../settings/settingsItem";
+import { UltraSettings } from "./settings";
+export declare function getControlBarUltraSettings(): SettingsItem<UltraSettings>[];
+export declare function getUltraSettingsContent(viewer: Viewer): SettingsItem<UltraSettings>[];

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

@@ -1,12 +1,13 @@
 import * as Core from '../../core-viewers';
 import { Container } from '../container';
 import { ViewerRef } from './viewerRef';
+import { PartialUltraSettings } 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.
  * @returns An object containing the resulting container, reactRoot, and viewer.
  */
-export declare function createViewer(container?: Container | HTMLElement): Promise<ViewerRef>;
+export declare function createViewer(container?: Container | HTMLElement, settings?: PartialUltraSettings): 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.
@@ -17,5 +18,6 @@ export declare function createViewer(container?: Container | HTMLElement): Promi
 export declare function Viewer(props: {
     container: Container;
     core: Core.Ultra.Viewer;
+    settings?: PartialUltraSettings;
     onMount: (viewer: ViewerRef) => void;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -5,6 +5,8 @@ import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
 import { ControlBarRef } from '../controlbar';
 import { GenericPanelHandle } from '../generic/';
+import { SettingsRef } from '../webgl';
+import { UltraSettings } from './settings';
 export type ViewerRef = {
     /**
      * The Vim viewer instance associated with the viewer.
@@ -27,6 +29,7 @@ export type ViewerRef = {
      */
     camera: CameraRef;
     isolation: IsolationRef;
+    settings: SettingsRef<UltraSettings>;
     /**
      * API to interact with the isolation panel.
      */

package/dist/types/react-viewers/urls.d.ts

@@ -1,3 +1,2 @@
-export declare const support = "https://docs.vimaec.com";
 export declare const supportUltra = "https://docs.vimaec.com/docs/vim-for-windows/configuring-vim-ultra";
 export declare const supportControls = "https://docs.vimaec.com/docs/vim-cloud/webgl-navigation-and-controls-guide";

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

@@ -1,3 +1,4 @@
 export * from './viewer';
 export * from './viewerRef';
+export * from './settings';
 export type * from './loading';

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

@@ -4,7 +4,7 @@
 import * as Core from '../../core-viewers';
 import { LoadRequest } from '../helpers/loadRequest';
 import { ModalHandle } from '../panels/modal';
-import { Settings } from '../settings';
+import { WebglSettings } from './settings';
 type AddSettings = {
     /**
      * Controls whether to frame the camera on a vim everytime it is updated.
@@ -30,7 +30,7 @@ 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.
      */

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 & {
+        logo: UserBoolean;
+        bimTreePanel: UserBoolean;
+        bimInfoPanel: UserBoolean;
+        performance: UserBoolean;
+        axesPanel: UserBoolean;
+        controlBar: UserBoolean;
+        orthographic: UserBoolean;
+        resetCamera: 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;