bimatter-viewer-react 1.0.0 → 1.0.2

package/lib/Model.d.ts

@@ -1,11 +1,12 @@
 import type { BmtModelData } from "./Loaders/BmtLoader";
-import { Matrix4, type DataTexture } from "three";
+import { Matrix4, type DataTexture, type Plane } from "three";
 import type { ViewerMaterialMode } from "./types";
 type ModelProps = {
     colorPaletteTexture: DataTexture;
     coordinationMatrix?: Matrix4 | null;
     modelID: number;
     data: BmtModelData;
+    getClippingPlanes?: () => Plane[];
     loadGeneration: number;
     materialMode?: ViewerMaterialMode;
     onUploadComplete?: (modelID: number, uploadedItemCount: number) => void;
@@ -16,6 +17,6 @@ type ModelProps = {
 export declare function parseModelMatrix(matrix?: string): Matrix4 | null;
 export declare function getModelCoordinationMatrix(data: BmtModelData): Matrix4 | null;
 export declare function getModelCoordinationMatrixSource(data: BmtModelData): string | undefined;
-declare function Model({ colorPaletteTexture, coordinationMatrix, modelID, data, loadGeneration, materialMode: materialModeOverride, onUploadComplete, onUploadProgress, trueNorthEnabled, useWebGPU, }: ModelProps): import("react/jsx-runtime").JSX.Element;
+declare function Model({ colorPaletteTexture, coordinationMatrix, modelID, data, getClippingPlanes, loadGeneration, materialMode: materialModeOverride, onUploadComplete, onUploadProgress, trueNorthEnabled, useWebGPU, }: ModelProps): import("react/jsx-runtime").JSX.Element;
 declare const _default: import("react").MemoExoticComponent<typeof Model>;
 export default _default;

package/lib/SelectableMesh.d.ts

@@ -1,12 +1,17 @@
 import React from "react";
-import { Matrix4, MeshBasicMaterial, MeshLambertMaterial, type ColorRepresentation, type DataTexture, type Material } from "three";
+import { Matrix4, MeshBasicMaterial, MeshLambertMaterial, type ColorRepresentation, type DataTexture, type Material, type Plane } from "three";
 import type { BmtGeomData, BmtMaterialData } from "./Loaders/BmtLoader";
 import type { ViewerMaterialMode } from "./types";
+import { type SharedMeshMaterials } from "./sharedMeshMaterials";
 export type SelectableMeshProps = {
     colorPaletteTexture: DataTexture;
     data: BmtGeomData;
+    /** Current section planes, applied before the mesh is first rendered. */
+    getClippingPlanes?: () => Plane[];
     isIfcSpace?: boolean;
     material: BmtMaterialData;
+    /** Model-wide cache; without it the mesh owns its material. */
+    materialCache?: SharedMeshMaterials;
     materialMode?: ViewerMaterialMode;
     meshMatrix: Matrix4;
     onReady?: (readyKey: string) => void;
@@ -18,4 +23,4 @@ export declare function createSelectableMaterial({ colorPaletteTexture, material
     preselectionColor: ColorRepresentation;
 }): MeshBasicMaterial | MeshLambertMaterial;
 export declare function updateSelectableMaterialPreselectionColor(material: Material, preselectionColor: ColorRepresentation): void;
-export declare const SelectableMesh: React.MemoExoticComponent<({ colorPaletteTexture, material, materialMode, data, isIfcSpace, meshMatrix, onReady, readyKey, useDoubleSideMaterial, }: SelectableMeshProps) => import("react/jsx-runtime").JSX.Element>;
+export declare const SelectableMesh: React.MemoExoticComponent<({ colorPaletteTexture, material, materialCache, materialMode, data, getClippingPlanes, isIfcSpace, meshMatrix, onReady, readyKey, useDoubleSideMaterial, }: SelectableMeshProps) => import("react/jsx-runtime").JSX.Element>;

package/lib/ViewerComponents/ViewerScene.d.ts

@@ -1,11 +1,13 @@
 import { Object3D, Plane } from "three";
 import type { BmtModelData } from "../Loaders/BmtLoader";
 import type { ViewerCameraRef, ViewerControlsRef, ViewerLightRef, ViewerMaterialMode, ViewerModelRef } from "../types";
+import { type CreatedBmtElement } from "../utils/GeometryUtils/createElements";
 import { type ViewerNotesApi } from "../utils/NotesUtils";
 import { type ViewerApi, type ViewerSceneApi } from "../api/ViewerApi";
 export type ModelsData = Record<number, BmtModelData>;
 export type CameraDprMode = "wake" | "move" | "sleep";
-export declare const ViewerScene: import("react").MemoExoticComponent<({ autoFitCamera, cameraRef, controlRef, fitToView, loadGeneration, lightRef, materialMode, modelRef, modelsData, modelsLoading, initialPlanPlane, createPlanComment, createPlanMarkupCloud, deleteAllPlanNotes, onReady, onModelsReady, onCameraDprModeChange, publicApi, invalidatePlanViews, setPlanPreselectionHandler, setPlanVisualObjectsGetter, setSceneApi, setPlanNotesModeActive, usePerformanceMoving, useWebGPU, }: {
+type ElementCreatedHandler = (modelID: number, elementID: number, element: CreatedBmtElement) => void;
+export declare const ViewerScene: import("react").MemoExoticComponent<({ autoFitCamera, cameraRef, controlRef, fitToView, loadGeneration, lightRef, materialMode, modelRef, modelsData, modelsLoading, initialPlanPlane, createPlanComment, createPlanMarkupCloud, deleteAllPlanNotes, onElementCreated, onReady, onModelsReady, onCameraDprModeChange, publicApi, invalidatePlanViews, setPlanPreselectionHandler, setPlanVisualObjectsGetter, setSceneApi, setPlanNotesModeActive, usePerformanceMoving, useWebGPU, }: {
     autoFitCamera: boolean;
     cameraRef: ViewerCameraRef;
     controlRef: ViewerControlsRef;
@@ -18,6 +20,7 @@ export declare const ViewerScene: import("react").MemoExoticComponent<({ autoFit
     modelsLoading: boolean;
     initialPlanPlane?: Plane | null;
     deleteAllPlanNotes: () => void;
+    onElementCreated: ElementCreatedHandler;
     onReady?: (api: ViewerApi) => void;
     onModelsReady: (loadGeneration: number) => void;
     onCameraDprModeChange: (mode: CameraDprMode) => void;
@@ -35,3 +38,4 @@ export declare const ViewerScene: import("react").MemoExoticComponent<({ autoFit
     usePerformanceMoving: boolean;
     useWebGPU: boolean;
 }) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/lib/WebGpuSelectableMesh.d.ts

@@ -15,5 +15,5 @@ export declare function updateWebGpuSelectableMaterialColors(material: Material,
     preselectionColor: ColorRepresentation;
     selectionColor: ColorRepresentation;
 }): void;
-export declare const WebGpuSelectableMesh: React.MemoExoticComponent<({ colorPaletteTexture, material, materialMode, data, isIfcSpace, meshMatrix, onReady, readyKey, useDoubleSideMaterial, }: SelectableMeshProps) => import("react/jsx-runtime").JSX.Element>;
+export declare const WebGpuSelectableMesh: React.MemoExoticComponent<({ colorPaletteTexture, material, materialCache, materialMode, data, getClippingPlanes, isIfcSpace, meshMatrix, onReady, readyKey, useDoubleSideMaterial, }: SelectableMeshProps) => import("react/jsx-runtime").JSX.Element>;
 export {};

package/lib/api/ViewerApi.d.ts

@@ -1,4 +1,4 @@
-import type { ColorRepresentation, Group } from "three";
+import type { BufferGeometry, ColorRepresentation, Group } from "three";
 import type { SelectedStore, UserDevice, ViewerGridAxesVisibility, ViewerGridAxisSide, ViewerLightingSettings, ViewerLightingSettingsUpdate, ViewerPostproductionActivePassFilter, ViewerStoreApi } from "../store/ViewerStore";
 import type { ViewerCameraProjection, ViewerFirstPersonControlSettings, ViewerPostproductionPassType } from "../types";
 import { type ViewerPropertiesApi } from "./ViewerPropertiesApi";
@@ -11,6 +11,7 @@ import type { BmtConversionResult, BmtConverterOptions, BmtConverterSource } fro
 import { FilteredElementsCollector } from "../Selector/FilteredElementsCollector";
 import type { ViewerLoadedModels, ViewerLoadModelOptions, ViewerModelSource } from "./loader";
 import type { GeometryIndex } from "../utils/GeometryUtils/useGeometryIndex";
+import type { IfcElementType } from "../utils/GeometryUtils/createElements";
 import type { WorkerProgressEvent } from "../workers";
 import { type ViewerPlansApi, type ViewerPlansContainerFactory, type ViewerPlansSceneApi } from "./ViewerPlansApi";
 export type { ViewerClippingApi, ViewerClippingVector3Input, } from "../utils/ClippingUtils";
@@ -23,6 +24,11 @@ export type { ViewerPlanHandle, ViewerPlansApi, ViewerPlanVector3Input, } from "
 export type ViewerSelection = Record<number, number[]>;
 export type ViewerGeometryUtilsApi = {
     readonly indexesState: GeometryIndex | null;
+    cancelElementCreation: () => void;
+    createElement: (geometry: BufferGeometry, type: IfcElementType) => number;
+    createElementByGeometry: (geometry: BufferGeometry) => number;
+    createSlab: (thicknessMm?: number) => Promise<number>;
+    createWall: (heightMm?: number, widthMm?: number) => Promise<number>;
     getAllIds: () => number[];
     getIfcSpacesVisibility: () => boolean;
     getModelGeometry: (modelID: number) => Group | null;
@@ -133,6 +139,7 @@ export type ViewerLoadModelsOptions = ViewerLoadModelOptions & {
     onModelsDataChange?: (modelsData: ViewerLoadedModels | undefined) => void;
 };
 export type ViewerModelsApi = {
+    createEmptyModel: (name?: string) => number;
     getData: () => ViewerLoadedModels | undefined;
     getLoading: () => boolean;
     getProgress: () => WorkerProgressEvent | null;

package/lib/api/loader.d.ts

@@ -41,6 +41,7 @@ declare class ViewerLoaderApi {
     private resetCoordinationMatrixState;
     private applyRenderSettings;
     resetCoordinationMatrix(): void;
+    allocateModelID(usedModelIDs?: number[]): number;
     loadModel(sources: ViewerModelSource | ViewerModelSource[], options?: ViewerLoadModelOptions): Promise<ViewerLoadedModels>;
 }
 export declare const loader: ViewerLoaderApi;

package/lib/index.d.ts

@@ -2,6 +2,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, ViewerDetectedGpuInfo, ViewerGpuInfo, ViewerHardwareInfo, ViewerLoadModelsOptions, ViewerModelsApi, ViewerPlanHandle, ViewerPlansApi, ViewerPlanVector3Input, ViewerPostproductionApi, ViewerSelection, ViewerSelectorApi, ViewerUtilsApi, } from "./api/ViewerApi";
+export type { BmtElementType, IfcElementType, } from "./utils/GeometryUtils/createElements";
 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";