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

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.
      */

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

@@ -1,5 +1,6 @@
 import * as THREE from 'three';
 import * as Core from '../core-viewers';
+import { RGBA } from '../core-viewers/ultra/rpcTypes';
 export declare class Validation {
     static isNumber(value: number): boolean;
     static isPositiveNumber(value: number): boolean;
@@ -7,16 +8,14 @@ export declare class Validation {
     static isPositiveInteger(value: number): boolean;
     static isInRange01(value: number): boolean;
     static areIntegers(values: number[]): boolean;
-    static isComponentHandle(handle: number): boolean;
-    static areComponentHandles(handles: number[]): boolean;
+    static isIndex(index: number): boolean;
+    static areIndices(indices: number[]): boolean;
     static isMaterialHandle(handle: number): 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;
@@ -24,6 +23,7 @@ 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: Core.Ultra.RGBA): Core.Ultra.RGBA;
-    static clampRGB01(value: Core.Ultra.RGBA): Core.Ultra.RGBA;
+    static clampColor01(value: THREE.Color): THREE.Color;
+    static clampRGBA01(value: RGBA): RGBA;
+    static clampRGB01(value: RGBA): RGBA;
 }