bimatter-viewer-react 0.8.1 → 0.8.3

package/lib/api/ViewerApi.d.ts

@@ -10,11 +10,13 @@ import type { BmtConversionResult, BmtConverterOptions, BmtConverterSource } fro
 import { FilteredElementsCollector } from "../Selector/FilteredElementsCollector";
 import type { ViewerLoadedModels, ViewerLoadModelOptions, ViewerModelSource } from "./loader";
 import type { WorkerProgressEvent } from "../workers";
+import { type ViewerPlansApi, type ViewerPlansContainerFactory, type ViewerPlansSceneApi } from "./ViewerPlansApi";
 export type { ViewerClippingApi, ViewerClippingVector3Input, } from "../utils/ClippingUtils";
 export type { ViewerColorConfigByModel, ViewerModelColorConfig, } from "../utils/ColorsUtils/useElementColors";
 export type { ViewerDimensionsApi } from "../utils/DimentionsUtils";
 export type { ViewerCameraGetIntersection } from "../Camera/useCameraUtils";
 export type { ViewerCameraProjection } from "../types";
+export type { ViewerPlanHandle, ViewerPlansApi, ViewerPlanVector3Input, } from "./ViewerPlansApi";
 export type ViewerSelection = Record<number, number[]>;
 export type ViewerGeometryUtilsApi = {
     getAllIds: () => number[];
@@ -34,14 +36,17 @@ export type ViewerGeometryUtilsApi = {
 export type ViewerSelectorApi = {
     addSelected: (modelID: number, ids: number[], setTarget?: boolean, fitTarget?: boolean) => void;
     collector: () => FilteredElementsCollector;
+    getPreselectionEnabled: () => boolean;
     getPreselectionColor: () => ColorRepresentation;
     getSelectionColor: () => ColorRepresentation;
     getSelected: () => ViewerSelection;
     removeSelected: (modelID: number, ids: number[]) => void;
     resetSelection: (modelID?: number) => void;
     setPreselectionColor: (color: ColorRepresentation) => void;
+    setPreselectionEnabled: (enabled: boolean) => void;
     setSelectionColor: (color: ColorRepresentation) => void;
     setSelected: (modelID: number, ids: number[], reset?: boolean, setTarget?: boolean, fitTarget?: boolean) => void;
+    togglePreselection: () => void;
 };
 export type ViewerSceneSelectorApi = {
     setTargetToSelection: (selection: ViewerSelection, fitTarget?: boolean) => void;
@@ -57,6 +62,7 @@ export type ViewerColorsApi = {
 export type ViewerUtilsApi = {
     getDefaultHotkeysEnabled: () => boolean;
     getGridAxesVisibility: () => ViewerGridAxesVisibility;
+    getPreselectionEnabled: () => boolean;
     getShowNavCube: () => boolean;
     getShowGridAxes: () => boolean;
     getShowStats: () => boolean;
@@ -67,7 +73,9 @@ export type ViewerUtilsApi = {
     setGridAxisVisibility: (side: ViewerGridAxisSide, visible: boolean) => void;
     setPerformaneMovingFactor: (factor: number) => void;
     setPerformanceMovingFactor: (factor: number) => void;
+    setPreselectionEnabled: (enabled: boolean) => void;
     toggleDefaultHotkeys: () => void;
+    togglePreselection: () => void;
     setShowNavCube: (showNavCube: boolean) => void;
     setShowGridAxes: (showGridAxes: boolean) => void;
     setShowStats: (showStats: boolean) => void;
@@ -124,6 +132,7 @@ export type ViewerApi = {
     dimensions: ViewerDimensionsApi;
     geometryUtils: ViewerGeometryUtilsApi;
     models: ViewerModelsApi;
+    plans: ViewerPlansApi;
     postproduction: ViewerPostproductionApi;
     properties: ViewerPropertiesApi;
     selector: ViewerSelectorApi;
@@ -136,8 +145,9 @@ export type ViewerSceneApi = {
     converter: ViewerConverterApi;
     dimensions: ViewerDimensionsApi;
     geometryUtils: ViewerGeometryUtilsApi;
+    plans: ViewerPlansSceneApi;
     selector: ViewerSceneSelectorApi;
 };
 export declare function serializeSelected(selected: SelectedStore): ViewerSelection;
 export declare function createSelectedStore(selection: ViewerSelection): SelectedStore;
-export declare function createPublicViewerApi(viewerStore: ViewerStoreApi, getSceneApi: () => ViewerSceneApi | null, getModelsApi: () => ViewerModelsApi | null): ViewerApi;
+export declare function createPublicViewerApi(viewerStore: ViewerStoreApi, getSceneApi: () => ViewerSceneApi | null, getModelsApi: () => ViewerModelsApi | null, getPlansContainerFactory?: () => ViewerPlansContainerFactory | null): ViewerApi;

package/lib/api/ViewerPlansApi.d.ts

@@ -0,0 +1,24 @@
+import { Plane, Vector3 } from "three";
+import type { ViewerApi, ViewerSceneApi } from "./ViewerApi";
+export type ViewerPlanVector3Input = Vector3 | [number, number, number] | {
+    x: number;
+    y: number;
+    z: number;
+};
+export type ViewerPlanHandle = {
+    container?: HTMLElement;
+    dispose: () => void;
+    plane: Plane;
+    viewer?: ViewerApi | null;
+};
+export type ViewerPlansSceneApi = {
+    createPlan: (plane: Plane) => ViewerPlanHandle | null;
+};
+export type ViewerPlansContainerFactory = (plane: Plane, container: HTMLElement) => ViewerPlanHandle | null;
+export type ViewerPlansApi = {
+    createPlan: ((plane: Plane, container?: HTMLElement) => ViewerPlanHandle | null) & ((point: ViewerPlanVector3Input, normal: ViewerPlanVector3Input, container?: HTMLElement) => ViewerPlanHandle | null) & ((zCord: number, normal: ViewerPlanVector3Input, container?: HTMLElement) => ViewerPlanHandle | null);
+};
+export declare function createViewerPlanPlane(plane: Plane): Plane;
+export declare function createViewerPlanPlane(point: ViewerPlanVector3Input, normal: ViewerPlanVector3Input): Plane;
+export declare function createViewerPlanPlane(zCord: number, normal: ViewerPlanVector3Input): Plane;
+export declare function createViewerPlansApi(getSceneApi: () => ViewerSceneApi | null, getContainerFactory?: () => ViewerPlansContainerFactory | null): ViewerPlansApi;

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 export { default as Viewer } from "./Viewer";
 export type { ViewerModelsData, ViewerProps } from "./Viewer";
 export type { ViewerCameraProjection, ViewerMaterialMode, ViewerPostproductionPassType, ViewerUploadMode, } from "./types";
-export type { ViewerApi, ViewerCameraApi, ViewerCameraGetIntersection, ViewerClippingApi, ViewerClippingVector3Input, ViewerColorsApi, ViewerBmtConverterOptions, ViewerConverterApi, ViewerDimensionsApi, ViewerGeometryUtilsApi, ViewerLoadModelsOptions, ViewerModelsApi, ViewerPostproductionApi, ViewerSelection, ViewerSelectorApi, ViewerUtilsApi, } from "./api/ViewerApi";
+export type { ViewerApi, ViewerCameraApi, ViewerCameraGetIntersection, ViewerClippingApi, ViewerClippingVector3Input, ViewerColorsApi, ViewerBmtConverterOptions, ViewerConverterApi, ViewerDimensionsApi, ViewerGeometryUtilsApi, ViewerLoadModelsOptions, ViewerModelsApi, ViewerPlanHandle, ViewerPlansApi, ViewerPlanVector3Input, ViewerPostproductionApi, ViewerSelection, ViewerSelectorApi, ViewerUtilsApi, } from "./api/ViewerApi";
 export type { ViewerModelLevel, ViewerModelLevelsByModel, ViewerPropertiesApi, ViewerPropertiesExcelOptions, } from "./api/ViewerPropertiesApi";
 export { BMTLoader } from "./Loaders/BmtLoader";
 export type { BmtGeometryChunkData, BmtParseCallbacks, BmtParseProgressData, BmtModelGeometryData, BmtGeomData, BmtIndexArray, BmtMaterialData, BmtElementProps, BmtModelData, BmtModelProps, BmtModelStructure, BmtModelStructureNode, BmtPropertyRecord, BmtPropertySet, BmtPropertyValue, } from "./Loaders/BmtLoader";