vim-web 0.5.0-dev.17 → 0.5.0-dev.19

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;
+        projectInspector: UserBoolean;
+        settings: UserBoolean;
+        help: UserBoolean;
+        maximise: 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,7 +3,7 @@
  */
 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';
@@ -13,20 +13,27 @@ 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';
 /**
 * 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.
@@ -79,7 +86,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.
      */