vim-web 0.3.44-dev.2 → 0.3.44-dev.21

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

@@ -0,0 +1,64 @@
+import * as VIM from '../../core-viewers/webgl/index';
+import { CameraRef } from './cameraState';
+import { CursorManager } from '../helpers/cursor';
+import { Isolation } from '../helpers/isolation';
+import { ComponentSettings } from '../settings/settings';
+import { SideState } from '../sidePanel/sideState';
+import * as Icons from '../panels/icons';
+import { SectionBoxRef } from './sectionBoxState';
+import { ModalRef } from '../panels/modal';
+import * as ControlBar from '../controlbar/controlBar';
+/**
+ * Returns a control bar section for the section box.
+ */
+export declare function controlBarSectionBox(section: SectionBoxRef, hasSelection: boolean): ControlBar.IControlBarSection;
+export declare function controlBarCamera(camera: CameraRef): {
+    id: string;
+    enable: () => boolean;
+    style: string;
+    buttons: {
+        id: string;
+        tip: string;
+        isOn: () => boolean;
+        action: () => void;
+        icon: typeof Icons.autoCamera;
+        style: typeof ControlBar.buttonDefaultStyle;
+    }[];
+};
+/**
+ * Combines all control bar sections into one control bar.
+ */
+export declare function useControlBar(viewer: VIM.Viewer, camera: CameraRef, modal: ModalRef, side: SideState, isolation: Isolation, cursor: CursorManager, settings: ComponentSettings, section: SectionBoxRef, customization: ControlBar.ControlBarCustomization | undefined): (ControlBar.IControlBarSection | {
+    id: string;
+    enable: () => boolean;
+    style: string;
+    buttons: ({
+        id: string;
+        enabled: () => boolean;
+        tip: string;
+        action: () => void;
+        icon: typeof Icons.toggleIsolation;
+        style: typeof ControlBar.buttonDefaultStyle;
+        isOn?: undefined;
+    } | {
+        id: string;
+        enabled: () => boolean;
+        isOn: () => boolean;
+        tip: string;
+        action: () => void;
+        icon: typeof Icons.measure;
+        style: typeof ControlBar.buttonDefaultStyle;
+    })[];
+} | {
+    id: string;
+    enable: () => boolean;
+    style: string;
+    buttons: {
+        id: string;
+        tip: string;
+        isOn: () => boolean;
+        action: () => void;
+        icon: typeof Icons.autoCamera;
+        style: typeof ControlBar.buttonDefaultStyle;
+    }[];
+})[];

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

@@ -0,0 +1,30 @@
+import * as THREE from 'three';
+import { ISignal } from 'ste-signals';
+import { ArgActionRef, AsyncFuncRef, StateRef } from '../helpers/reactUtils';
+export type Offsets = {
+    topOffset: string;
+    sideOffset: string;
+    bottomOffset: string;
+};
+export type OffsetField = keyof Offsets;
+export interface SectionBoxRef {
+    enable: StateRef<boolean>;
+    visible: StateRef<boolean>;
+    auto: StateRef<boolean>;
+    sectionSelection: AsyncFuncRef<void>;
+    sectionReset: AsyncFuncRef<void>;
+    section: ArgActionRef<THREE.Box3>;
+    showOffsetPanel: StateRef<boolean>;
+    topOffset: StateRef<string>;
+    sideOffset: StateRef<string>;
+    bottomOffset: StateRef<string>;
+}
+export interface SectionBoxAdapter {
+    setVisible: (visible: boolean) => void;
+    getBox: () => THREE.Box3;
+    fitBox: (box: THREE.Box3) => void;
+    getSelectionBox: () => Promise<THREE.Box3 | undefined>;
+    getRendererBox: () => Promise<THREE.Box3>;
+    onSelectionChanged: ISignal;
+}
+export declare function useSectionBox(adapter: SectionBoxAdapter): SectionBoxRef;

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

@@ -1 +1,2 @@
 export * from './ultraComponent';
+export * from './ultraComponentRef';

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

@@ -0,0 +1,2 @@
+import { UltraViewer } from "../..";
+export declare function useUltraCamera(viewer: UltraViewer.Viewer): import("../..").CameraRef;

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

@@ -1,12 +1,6 @@
 import * as Ultra from '../../core-viewers/ultra/index';
 import { Container } from '../container';
-import { ModalRef } from '../panels/modal';
-export type UltraComponentRef = {
-    viewer: Ultra.Viewer;
-    modal: ModalRef;
-    dispose: () => void;
-    load(url: Ultra.VimSource): Ultra.ILoadRequest;
-};
+import { UltraComponentRef } from './ultraComponentRef';
 /**
  * Creates a UI container along with a VIM.Viewer and its associated React component.
  * @param container An optional container object. If none is provided, a container will be created.

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

@@ -0,0 +1,36 @@
+import * as Ultra from '../../core-viewers/ultra';
+import { ModalRef } from '../panels/modal';
+import { CameraRef } from '../state/cameraState';
+import { SectionBoxRef } from '../state/sectionBoxState';
+import { ControlBarRef } from '../webgl/webglComponentRef';
+export type UltraComponentRef = {
+    /**
+     * The Vim viewer instance associated with the component.
+     */
+    viewer: Ultra.Viewer;
+    /**
+     * API to manage the modal dialog.
+     */
+    modal: ModalRef;
+    /**
+     * API to manage the section box.
+     */
+    sectionBox: SectionBoxRef;
+    /**
+     * API to customize the control.
+     */
+    controlBar: ControlBarRef;
+    /**
+     * Camera API to interact with the viewer camera at a higher level.
+     */
+    camera: CameraRef;
+    /**
+     * Disposes of the component and its resources.
+     */
+    dispose: () => void;
+    /**
+     * Loads a file into the viewer.
+     * @param url The URL of the file to load.
+     */
+    load(url: Ultra.VimSource): Ultra.ILoadRequest;
+};

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

@@ -0,0 +1,19 @@
+import { ControlBarCustomization } from '../controlbar/controlBar';
+import { SectionBoxRef } from '../state/sectionBoxState';
+import * as Ultra from '../../core-viewers/ultra/index';
+import { CameraRef } from '../state/cameraState';
+export { buttonDefaultStyle, buttonBlueStyle } from '../controlbar/controlBarButton';
+export { sectionDefaultStyle, sectionBlueStyle } from '../controlbar/controlBarSection';
+export declare function useUltraControlBar(viewer: Ultra.Viewer, section: SectionBoxRef, camera: CameraRef, customization: ControlBarCustomization | undefined): (import("../controlbar/controlBarSection").IControlBarSection | {
+    id: string;
+    enable: () => boolean;
+    style: string;
+    buttons: {
+        id: string;
+        tip: string;
+        isOn: () => boolean;
+        action: () => void;
+        icon: typeof import("../panels/icons").autoCamera;
+        style: typeof import("../controlbar/controlBarButton").buttonDefaultStyle;
+    }[];
+})[];

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

@@ -0,0 +1,4 @@
+import { ModalRef } from "../panels/modal";
+import * as Ultra from '../../core-viewers/ultra/index';
+export declare function updateModal(modal: ModalRef, state: Ultra.ClientState): void;
+export declare function updateProgress(request: Ultra.ILoadRequest, modal: ModalRef): Promise<void>;

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

@@ -0,0 +1,3 @@
+import * as Ultra from '../../core-viewers/ultra/index';
+import { SectionBoxRef } from '../state/sectionBoxState';
+export declare function useUltraSectionBox(viewer: Ultra.Viewer): SectionBoxRef;

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

@@ -1,4 +1,3 @@
-import '../style.css';
 export * from './webglComponent';
 export * as ContextMenu from '../panels/contextMenu';
 export * as BimInfo from '../bim/bimInfoData';

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

@@ -0,0 +1,2 @@
+import { WebglViewer } from "../..";
+export declare function useWebglCamera(viewer: WebglViewer.Viewer): import("../..").CameraRef;

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

@@ -5,12 +5,13 @@ import * as VIM from '../../core-viewers/webgl/index';
 import { ContextMenuCustomization } from '../panels/contextMenu';
 import { ComponentSettings } from '../settings/settings';
 import { Isolation } from '../helpers/isolation';
-import { ComponentCamera } from '../helpers/camera';
+import { CameraRef } from '../state/cameraState';
 import { Container } from '../container';
 import { BimInfoPanelRef } from '../bim/bimInfoData';
 import { ControlBarCustomization } from '../controlbar/controlBar';
 import { ComponentLoader } from './webglLoading';
 import { ModalRef } from '../panels/modal';
+import { SectionBoxRef } from '../state/sectionBoxState';
 /**
 * Settings API managing settings applied to the component.
 */
@@ -82,6 +83,10 @@ export type VimComponentRef = {
      * Isolation API managing isolation state in the component.
      */
     isolation: Isolation;
+    /**
+     * Section box API managing the section box in the component.
+     */
+    sectionBox: SectionBoxRef;
     /**
      * Context menu API managing the content and behavior of the context menu.
      */
@@ -101,7 +106,7 @@ export type VimComponentRef = {
     /**
      * Camera API to interact with the viewer camera at a higher level.
      */
-    camera: ComponentCamera;
+    camera: CameraRef;
     /**
      * API To interact with the BIM info panel.
      */

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

@@ -0,0 +1,3 @@
+import * as VIM from '../../core-viewers/webgl/index';
+import { SectionBoxRef } from '../state/sectionBoxState';
+export declare function useWebglSectionBox(viewer: VIM.Viewer): SectionBoxRef;