vim-web 0.3.44-dev.9 → 0.4.0

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

@@ -2,20 +2,20 @@
  * @module viw-webgl-react
  */
 import React from 'react';
-import * as VIM from '../../core-viewers/webgl/index';
-import { TreeActionRef } from './bimTree';
-import { Isolation } from '../helpers/isolation';
-import { ComponentCamera } from '../helpers/camera';
+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 { ComponentSettings } from '../settings/settings';
 import { BimInfoPanelRef } from './bimInfoData';
+import { TreeActionRef } from './bimTree';
 export declare function OptionalBimPanel(props: {
-    viewer: VIM.Viewer;
-    camera: ComponentCamera;
+    viewer: Core.Webgl.Viewer;
+    camera: CameraRef;
     viewerState: ViewerState;
-    isolation: Isolation;
+    isolation: IsolationRef;
     visible: boolean;
-    settings: ComponentSettings;
+    settings: Settings;
     treeRef: React.MutableRefObject<TreeActionRef | undefined>;
     bimInfoRef: BimInfoPanelRef;
 }): JSX.Element;
@@ -29,12 +29,12 @@ export declare function OptionalBimPanel(props: {
  * @returns
  */
 export declare function BimPanel(props: {
-    viewer: VIM.Viewer;
-    camera: ComponentCamera;
+    viewer: Core.Webgl.Viewer;
+    camera: CameraRef;
     viewerState: ViewerState;
-    isolation: Isolation;
+    isolation: IsolationRef;
     visible: boolean;
-    settings: ComponentSettings;
+    settings: Settings;
     treeRef: React.MutableRefObject<TreeActionRef | undefined>;
     bimInfoRef: BimInfoPanelRef;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -1,7 +1,7 @@
 /**
  * @module viw-webgl-react
  */
-import { WebglViewer } from '../..';
+import * as Core from '../../core-viewers';
 /**
  * Returns a jsx component of a search bar to search and filter bim data.
  * @param viewer viewer helper.
@@ -10,7 +10,7 @@ import { WebglViewer } from '../..';
  * @param count current search result count.
  */
 export declare function BimSearch(props: {
-    viewer: WebglViewer.Viewer;
+    viewer: Core.Webgl.Viewer;
     filter: string;
     setFilter: (s: string) => void;
     count: number;

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

@@ -3,15 +3,17 @@
  */
 import React from 'react';
 import 'react-complex-tree/lib/style.css';
-import * as VIM from '../../core-viewers/webgl/index';
-import { ComponentCamera as CameraHelpers } from '../helpers/camera';
-import { Isolation } from '../helpers/isolation';
+import * as Core from '../../core-viewers';
+import { CameraRef } from '../state/cameraState';
 import { BimTreeData } from './bimTreeData';
+import { IsolationRef } from '../state/sharedIsolation';
+import Element3D = Core.Webgl.Element3D;
+import Viewer = Core.Webgl.Viewer;
 export type TreeActionRef = {
     showAll: () => void;
     hideAll: () => void;
     collapseAll: () => void;
-    selectSiblings: (element: VIM.Object3D) => void;
+    selectSiblings: (element: Element3D) => void;
 };
 /**
  * Treeview component reprentation of current vim document bim data.
@@ -22,10 +24,10 @@ export type TreeActionRef = {
  */
 export declare function BimTree(props: {
     actionRef: React.MutableRefObject<TreeActionRef>;
-    viewer: VIM.Viewer;
-    camera: CameraHelpers;
-    objects: VIM.Object3D[];
-    isolation: Isolation;
+    viewer: Viewer;
+    camera: CameraRef;
+    objects: Element3D[];
+    isolation: IsolationRef;
     treeData: BimTreeData;
 }): import("react/jsx-runtime").JSX.Element;
 export declare const isControlKey: (e: React.MouseEvent<any, any>) => boolean;

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

@@ -1,7 +1,7 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import { TreeItem } from 'react-complex-tree';
 import { MapTree } from '../helpers/data';
 import { AugmentedElement } from '../helpers/element';
@@ -24,12 +24,13 @@ export type VimTreeNode = TreeItem<AugmentedElement> & {
  * @param elements elements to include in the treeview.
  * @returns
  */
-export declare function toTreeData(vim: VIM.Vim, elements: AugmentedElement[], grouping: Grouping): BimTreeData;
+export declare function toTreeData(vim: Core.Webgl.Vim, elements: AugmentedElement[], grouping: Grouping): BimTreeData;
 export declare class BimTreeData {
+    vim: Core.Webgl.Vim;
     nodes: Record<number, VimTreeNode>;
     elementToNode: Map<number, number>;
-    constructor(map: MapTree<string, AugmentedElement>);
-    updateVisibility(vim: VIM.Vim): void;
+    constructor(vim: Core.Webgl.Vim, map: MapTree<string, AugmentedElement>);
+    updateVisibility(): void;
     getRange(start: number, end: number): number[];
     getNodeFromElement(element: number): number;
     getLeafs(node: number, result?: number[]): number[];

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

@@ -0,0 +1,8 @@
+export type * from './bimInfoBody';
+export type * from './bimInfoHeader';
+export type * from './bimInfoPanel';
+export type * from './bimPanel';
+export type * from './bimSearch';
+export type * from './bimTree';
+export type * from './bimTreeData';
+export type * as BimInfo from './bimInfoData';

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

@@ -2,11 +2,11 @@
  * @module public-api
  */
 /**
- * Basic HTML structure that the webgl component expects
+ * Basic HTML structure that the webgl viewer expects
  */
 export type Container = {
     /**
-     * Root of the viewer, all component ui should have this as an acestor.
+     * Root of the viewer, all viewer ui should have this as an acestor.
      */
     root: HTMLElement;
     /**
@@ -20,7 +20,7 @@ export type Container = {
     dispose: () => void;
 };
 /**
- * Creates a default container for the vim component around a vim viewer
+ * Creates a default container for the vim viewer around a vim viewer
  * The element is created if not provided. The element will be made position:absolute.
  * @element optional HTML element to use as root
  */

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

@@ -2,10 +2,16 @@
  * @module viw-webgl-react
  */
 import { IControlBarSection } from './controlBarSection';
-export * from './controlBarSection';
-export * from './controlBarButton';
-export * from './controlBarSection';
-export * from './controlBarIds';
+/**
+ * Reference to manage control bar functionality in the viewer.
+ */
+export type ControlBarRef = {
+    /**
+     * Defines a callback function to dynamically customize the control bar.
+     * @param customization The configuration object specifying the customization options for the control bar.
+     */
+    customize: (customization: ControlBarCustomization) => void;
+};
 /**
  * A map function that changes the context menu.
  */

package/dist/types/react-viewers/controlbar/controlBarButton.d.ts

@@ -1,7 +1,3 @@
-export declare function buttonDefaultStyle(on: boolean): string;
-export declare function buttonExpandStyle(on: boolean): string;
-export declare function buttonDisableStyle(on: boolean): string;
-export declare function buttonBlueStyle(on: boolean): string;
 export interface IControlBarButtonItem {
     id: string;
     enabled?: (() => boolean) | undefined;

package/dist/types/react-viewers/controlbar/controlBarIds.d.ts

@@ -1,27 +1,36 @@
-export declare const elementIds: {
-    sectionCamera: string;
-    sectionActions: string;
-    sectionTools: string;
-    sectionSettings: string;
-    sectionMeasure: string;
-    sectionSectionBox: string;
-    buttonCameraOrbit: string;
-    buttonCameraLook: string;
-    buttonCameraPan: string;
-    buttonCameraZoom: string;
-    buttonCameraZoomWindow: string;
-    buttonProjectInspector: string;
-    buttonSettings: string;
-    buttonHelp: string;
-    buttonMaximize: string;
-    buttonToggleIsolation: string;
-    buttonZoomToFit: string;
-    buttonSectionBox: string;
-    buttonMeasure: string;
-    buttonSectionBoxEnable: string;
-    buttonSectionBoxVisible: string;
-    buttonSectionBoxShrinkToSelection: string;
-    buttonSectionBoxAuto: string;
-    buttonSectionBoxClip: string;
-    buttonSectionBoxSettings: string;
-};
+export declare const sectionSelection = "controlBar.sectionSelection";
+export declare const sectionCamera = "controlBar.sectionCamera";
+export declare const sectionInputs = "controlBar.sectionInputs";
+export declare const sectionActions = "controlBar.sectionActions";
+export declare const sectionTools = "controlBar.sectionTools";
+export declare const sectionSettings = "controlBar.sectionSettings";
+export declare const sectionMeasure = "controlBar.sectionMeasure";
+export declare const sectionSectionBox = "controlBar.sectionSectionBox";
+export declare const buttonCameraFrameSelection = "controlBar.camera.frameSelection";
+export declare const buttonCameraFrameScene = "controlBar.camera.frameScene";
+export declare const buttonCameraAuto = "controlBar.camera.auto";
+export declare const buttonCameraOrbit = "controlBar.camera.orbit";
+export declare const buttonCameraLook = "controlBarcamera.look";
+export declare const buttonCameraPan = "controlBar.camera.pan";
+export declare const buttonCameraZoom = "controlBar.camera.zoom";
+export declare const buttonCameraZoomWindow = "controlBar.camera.zoomWindow";
+export declare const buttonProjectInspector = "controlBar.projectInspector";
+export declare const buttonSettings = "controlBar.settings";
+export declare const buttonHelp = "controlBar.help";
+export declare const buttonMaximize = "controlBar.maximize";
+export declare const buttonClearSelection = "controlBar.action.clearSelection";
+export declare const buttonShowAll = "controlBar.selection.showAll";
+export declare const buttonIsolateSelection = "controlBar.selection.isolate";
+export declare const buttonHideSelection = "controlBar.selection.hide";
+export declare const buttonShowSelection = "controlBar.selection.show";
+export declare const buttonAutoIsolate = "controlBar.selection.autoIsolate";
+export declare const buttonIsolationSettings = "controlBar.selection.isolationSettings";
+export declare const buttonRenderSettings = "controlBar.action.renderSettings";
+export declare const buttonSectionBox = "controlBar.sectionBox";
+export declare const buttonMeasure = "controlBar.measure";
+export declare const buttonSectionBoxEnable = "controlBar.sectionBox.enable";
+export declare const buttonSectionBoxVisible = "controlBar.sectionBox.visible";
+export declare const buttonSectionBoxToSelection = "controlBar.sectionBox.sectionSelection";
+export declare const buttonSectionBoxToScene = "controlBar.sectionBox.sectionScene";
+export declare const buttonSectionBoxAuto = "controlBar.sectionBox.auto";
+export declare const buttonSectionBoxSettings = "controlBar.sectionBox.settings";

package/dist/types/react-viewers/controlbar/controlBarSection.d.ts

@@ -1,11 +1,8 @@
 import { IControlBarButtonItem } from './controlBarButton';
-export declare const sectionDefaultStyle: string;
-export declare const sectionBlueStyle: string;
-export declare const sectionNoPadStyle: string;
 export interface IControlBarSection {
     id: string;
     enable?: (() => boolean) | undefined;
-    buttons: IControlBarButtonItem[];
+    buttons: (IControlBarButtonItem)[];
     style?: string;
 }
 export declare function createSection(section: IControlBarSection): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,5 @@
+export * as Ids from './controlBarIds';
+export * as Style from './style';
+export type * from './controlBarButton';
+export type * from './controlBar';
+export type * from './controlBarSection';

package/dist/types/react-viewers/controlbar/style.d.ts

@@ -0,0 +1,10 @@
+export declare const baseSectionStyle = "vc-flex vc-items-center vc-rounded-full vc-mb-2 vc-shadow-md";
+export declare const sectionDefaultStyle: string;
+export declare const sectionBlueStyle: string;
+export declare const sectionNoPadStyle: string;
+export declare const buttonBaseStyle = "vim-control-bar-button vc-rounded-full vc-items-center vc-justify-center vc-flex vc-transition-all hover:vc-scale-110";
+export declare function buttonDefaultStyle(on: boolean): string;
+export declare function buttonExpandStyle(on: boolean): string;
+export declare function buttonDisableStyle(on: boolean): string;
+export declare function buttonDisableDefaultStyle(on: boolean): string;
+export declare function buttonBlueStyle(on: boolean): string;

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

@@ -0,0 +1,2 @@
+export * from './errors';
+export * as Style from './errorStyle';

package/dist/types/react-viewers/generic/genericField.d.ts

@@ -0,0 +1,31 @@
+import React from "react";
+import { StateRef } from "../helpers/reactUtils";
+interface BaseGenericEntry {
+    id: string;
+    label: string;
+    enabled?: () => boolean;
+    visible?: () => boolean;
+}
+export interface GenericTextEntry extends BaseGenericEntry {
+    type: "text";
+    state: StateRef<string>;
+}
+export interface GenericNumberEntry extends BaseGenericEntry {
+    type: "number";
+    state: StateRef<number>;
+    min?: number;
+    max?: number;
+    step?: number;
+}
+export interface GenericBoolEntry extends BaseGenericEntry {
+    type: "bool";
+    state: StateRef<boolean>;
+}
+export type GenericEntryType = GenericTextEntry | GenericBoolEntry | GenericNumberEntry;
+/**
+ * Renders a panel field based on its type.
+ * @param field - The panel field to render.
+ * @returns The rendered field element.
+ */
+export declare function GenericEntry(field: GenericEntryType): React.ReactNode;
+export {};

package/dist/types/react-viewers/generic/genericPanel.d.ts

@@ -0,0 +1,12 @@
+import { StateRef } from "../helpers/reactUtils";
+import { GenericEntryType } from "./genericField";
+import { Customizer } from "../helpers/customizer";
+export interface GenericPanelProps {
+    showPanel: StateRef<boolean>;
+    header?: React.ReactNode;
+    entries: GenericEntryType[];
+    onClose?: () => void;
+    anchorElement: HTMLElement | null;
+}
+export type GenericPanelHandle = Customizer<GenericEntryType[]>;
+export declare const GenericPanel: import("react").ForwardRefExoticComponent<GenericPanelProps & import("react").RefAttributes<GenericPanelHandle>>;

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

@@ -0,0 +1,2 @@
+export type * from './genericField';
+export { type GenericPanelHandle } from './genericPanel';

package/dist/types/react-viewers/generic/inputNumber.d.ts

@@ -0,0 +1,4 @@
+import { GenericNumberEntry } from "./genericField";
+export declare function InputNumber(props: {
+    entry: GenericNumberEntry;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,8 @@
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 export declare class CameraObserver {
     onChange: ((moving: boolean) => void) | undefined;
     private _timeOut;
     private _sub;
-    constructor(viewer: VIM.Viewer, delay: number);
+    constructor(viewer: Core.Webgl.Viewer, delay: number);
     dispose(): void;
 }

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

@@ -1,7 +1,9 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
+import PointerMode = Core.PointerMode;
+import Viewer = Core.Webgl.Viewer;
 /**
  * Css classes for custom cursors.
  */
@@ -9,7 +11,7 @@ export type Cursor = 'cursor-regular' | 'cursor-orbit' | 'cursor-look' | 'cursor
 /**
  * Maps between viewer pointers and cursor css classes
  */
-export declare function pointerToCursor(pointer: VIM.PointerMode): Cursor;
+export declare function pointerToCursor(pointer: PointerMode): Cursor;
 /**
  * Listens to the vim viewer and updates css cursors classes on the canvas accordingly.
  */
@@ -18,7 +20,7 @@ export declare class CursorManager {
     private cursor;
     private _boxHover;
     private _subscriptions;
-    constructor(viewer: VIM.Viewer);
+    constructor(viewer: Viewer);
     /**
      * Register to viewer events
      */

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

@@ -0,0 +1,4 @@
+export interface Customizer<TData> {
+    customize(fn: (entries: TData) => TData): any;
+}
+export declare function useCustomizer<TData>(baseEntries: TData, ref: React.Ref<Customizer<TData>>): TData;

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

@@ -1,7 +1,7 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import * as BIM from 'vim-format';
 export type AugmentedElement = BIM.IElement & {
     bimDocumentName: string;
@@ -10,4 +10,5 @@ export type AugmentedElement = BIM.IElement & {
     levelName: string;
     worksetName: string;
 };
-export declare function getElements(vim: VIM.Vim): Promise<AugmentedElement[]>;
+export declare function getElements(vim: Core.Webgl.Vim): Promise<AugmentedElement[]>;
+export declare function filterElements(elements: AugmentedElement[], filter: string): AugmentedElement[];

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

@@ -0,0 +1,6 @@
+export * as ReactUtils from './reactUtils';
+export type * from './cursor';
+export type * from './data';
+export type * from './element';
+export type * from './loadRequest';
+export type * from './requestResult';

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

@@ -0,0 +1,24 @@
+/**
+ * Computes a position for a floating element relative to a target, with smart fallback
+ * if it overflows the top or sides of the screen.
+ *
+ * @param originRect - The bounding rect of the origin element.
+ * @param panelRect - The bounding rect of the panel to position.
+ * @returns The top-left position for the panel.
+ */
+export declare function computeFloatingPosition(originRect: DOMRect, panelRect: DOMRect): {
+    top: number;
+    left: number;
+};
+/**
+ * Tracks and computes the screen position of a floating panel relative to a given anchor element.
+ *
+ * @param panelRef - Ref to the panel element to position
+ * @param anchorElement - The element the panel should be positioned relative to
+ * @param enabled - Whether the positioning logic is active
+ * @returns The top-left screen position for the panel
+ */
+export declare function useFloatingPanelPosition(panelRef: React.RefObject<HTMLElement>, anchorElement: HTMLElement | null, enabled: boolean): {
+    top: number;
+    left: number;
+};

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

@@ -1,7 +1,7 @@
-import * as VIM from '../../core-viewers/webgl/index';
-import { LoadingError } from '../webgl/webglLoading';
+import * as Core from '../../core-viewers';
+import { LoadingError } from '../webgl/loading';
 type RequestCallbacks = {
-    onProgress: (p: VIM.IProgressLogs) => void;
+    onProgress: (p: Core.Webgl.IProgressLogs) => void;
     onError: (e: LoadingError) => void;
     onDone: () => void;
 };
@@ -16,14 +16,14 @@ export declare class LoadRequest {
     private _progressPromise;
     private _isDone;
     private _completionPromise;
-    constructor(callbacks: RequestCallbacks, source: VIM.RequestSource, settings?: VIM.VimPartialSettings);
+    constructor(callbacks: RequestCallbacks, source: Core.Webgl.RequestSource, settings?: Core.Webgl.VimPartialSettings);
     private startRequest;
     private onProgress;
     private onSuccess;
     private onError;
     private end;
-    getProgress(): AsyncGenerator<VIM.IProgressLogs, void, void>;
-    getResult(): Promise<import("../../core-viewers/webgl/utils/requestResult").RequestResult<VIM.Vim>>;
+    getProgress(): AsyncGenerator<Core.Webgl.IProgressLogs, void, void>;
+    getResult(): Promise<import("../../utils").Result<Core.Webgl.Vim>>;
     abort(): void;
 }
 export {};