bimatter-viewer-react 0.4.0 → 0.4.1

package/README.md

@@ -238,6 +238,7 @@ viewerRef.current?.selector.addSelected(0, [30]);
 viewerRef.current?.selector.removeSelected(0, [10]);
 viewerRef.current?.selector.resetSelection();
 viewerRef.current?.selector.getSelected();
+viewerRef.current?.selector.collector().ofType("IfcWall").toElements();
 viewerRef.current?.selector.setSelectionColor("#1194bd");
 viewerRef.current?.selector.getSelectionColor();
 viewerRef.current?.selector.setPreselectionColor("#68c6e3");
@@ -282,6 +283,8 @@ viewerRef.current?.dimensions.getDimensions();
 
 viewerRef.current?.properties.getModelProps();
 viewerRef.current?.properties.getModelStructure();
+viewerRef.current?.properties.exportExcel(0);
+viewerRef.current?.properties.exportAllExcel();
 viewerRef.current?.utils.getUserDevice();
 viewerRef.current?.utils.getDefaultHotkeysEnabled();
 viewerRef.current?.utils.setDefaultHotkeysEnabled(false);
@@ -491,6 +494,34 @@ function App() {
 }
 ```
 
+## Filtered Elements Collector
+
+Use `selector.collector()` to query element properties from loaded models:
+
+```tsx
+import type { IfcClass } from "bimatter-viewer-react";
+
+const wallType: IfcClass = "IfcWall";
+
+const walls = viewerRef.current?.selector
+    .collector()
+    .ofType(wallType)
+    .toElements();
+
+const basicWallIds = viewerRef.current?.selector
+    .collector()
+    .ofModel(0)
+    .ofType("IfcWall")
+    .Where((element) => element.props.Name.startsWith("basic wall"))
+    .toElementsIds();
+```
+
+Without `ofModel()`, `toElements()` returns `{ [modelID]: { elementID, props }[] }` and `toElementsIds()` returns `{ [modelID]: number[] }`.
+
+With `ofModel(0)`, `toElements()` returns `{ elementID, props }[]` and `toElementsIds()` returns `number[]`.
+
+`ofType()` accepts `IfcClass | string`, so TypeScript suggests IFC classes like `"IfcWall"` while still allowing custom type strings.
+
 ## Stats And Profiling
 
 Enable FPS stats and console timing logs:

package/lib/Loaders/BmtLoader.d.ts

@@ -55,6 +55,7 @@ export interface BmtModelData {
     coordinationMatrix?: string;
     data: BmtModelGeometryData;
     grids?: ModelGridsData;
+    name?: string;
     props: BmtModelProps;
     structure: BmtModelStructure;
 }
@@ -91,6 +92,7 @@ export declare class BMTLoader {
     parseMesh(data: Uint8Array): BmtMeshData;
     private getExternalMetadataPath;
     private loadExternalMetadata;
+    private getModelNameFromPath;
     loadModel(path: string): Promise<BmtModelData>;
     parseBinaryFile(data: ArrayBuffer): BmtModelData;
 }

package/lib/Selector/FilteredElementsCollector.d.ts

@@ -0,0 +1,38 @@
+import type * as WebIfc from "web-ifc";
+import type { BmtElementProps, BmtModelData, BmtModelProps } from "../Loaders/BmtLoader";
+type IfcClassConstructor = abstract new (...args: never[]) => unknown;
+type IfcNamespaceClassNames<TNamespace> = Extract<{
+    [Key in keyof TNamespace]: TNamespace[Key] extends IfcClassConstructor ? Key : never;
+}[keyof TNamespace], `Ifc${string}`>;
+export type IfcClass = IfcNamespaceClassNames<typeof WebIfc.IFC2X3> | IfcNamespaceClassNames<typeof WebIfc.IFC4> | IfcNamespaceClassNames<typeof WebIfc.IFC4X3>;
+export type IfcClassName = IfcClass | (string & {});
+export type FilteredElement = {
+    elementID: number;
+    props: BmtElementProps;
+};
+export type FilteredElementWithModel = FilteredElement & {
+    modelID: number;
+};
+export type FilteredElementId = number;
+export type FilteredElementsResult = Record<number, FilteredElement[]>;
+export type FilteredElementIdsResult = Record<number, number[]>;
+export type FilteredElementPredicate = (element: FilteredElementWithModel) => unknown;
+export type FilteredElementsSource = BmtModelData | BmtModelProps | Record<number, BmtModelData> | Record<number, BmtModelProps> | null | undefined;
+export declare class FilteredElementsCollector<TSingleModel extends boolean = false> {
+    private elements;
+    private filters;
+    private selectedModelIDs;
+    constructor(source?: FilteredElementsSource);
+    from(source: FilteredElementsSource): this;
+    ofType(type: IfcClassName | readonly IfcClassName[]): this;
+    ofModel(modelID: number): FilteredElementsCollector<true>;
+    ofModel(modelID: number[]): FilteredElementsCollector<false>;
+    Where(predicate: FilteredElementPredicate): this;
+    where(predicate: FilteredElementPredicate): this;
+    private getFilteredElements;
+    private hasSingleSelectedModel;
+    toElements(): TSingleModel extends true ? FilteredElement[] : FilteredElementsResult;
+    toElementsIds(): TSingleModel extends true ? number[] : FilteredElementIdsResult;
+    toElementIds(): TSingleModel extends true ? number[] : FilteredElementIdsResult;
+}
+export {};

package/lib/api/ViewerApi.d.ts

@@ -5,6 +5,7 @@ import type { ViewerClippingApi } from "../utils/ClippingUtils";
 import type { ViewerDimensionsApi } from "../utils/DimentionsUtils";
 import type { ViewerCameraGetIntersection } from "../Camera/useCameraUtils";
 import type { BmtConversionResult, BmtConverterOptions, BmtConverterSource } from "../Loaders/BmtConverter";
+import { FilteredElementsCollector } from "../Selector/FilteredElementsCollector";
 export type { ViewerClippingApi } from "../utils/ClippingUtils";
 export type { ViewerDimensionsApi } from "../utils/DimentionsUtils";
 export type { ViewerCameraGetIntersection } from "../Camera/useCameraUtils";
@@ -24,6 +25,7 @@ export type ViewerGeometryUtilsApi = {
 };
 export type ViewerSelectorApi = {
     addSelected: (modelID: number, ids: number[]) => void;
+    collector: () => FilteredElementsCollector;
     getPreselectionColor: () => ColorRepresentation;
     getSelectionColor: () => ColorRepresentation;
     getSelected: () => ViewerSelection;

package/lib/api/ViewerPropertiesApi.d.ts

@@ -1,5 +1,9 @@
 import type { ViewerModelPropsStore, ViewerModelStructureStore, ViewerStoreApi } from "../store/ViewerStore";
+import { type ExportedExcelFile, type ModelPropertiesExcelOptions } from "../utils/ExportUtils";
+export type ViewerPropertiesExcelOptions = ModelPropertiesExcelOptions;
 export type ViewerPropertiesApi = {
+    exportAllExcel: (options?: ViewerPropertiesExcelOptions) => ExportedExcelFile[];
+    exportExcel: (modelID: number, options?: ViewerPropertiesExcelOptions) => ExportedExcelFile | null;
     getModelProps: () => ViewerModelPropsStore;
     getModelStructure: () => ViewerModelStructureStore;
 };

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 export { default as Viewer } from "./Viewer";
 export type { ViewerModelsData, ViewerProps } from "./Viewer";
 export type { ViewerApi, ViewerCameraApi, ViewerCameraGetIntersection, ViewerClippingApi, ViewerColorsApi, ViewerBmtConverterOptions, ViewerConverterApi, ViewerDimensionsApi, ViewerGeometryUtilsApi, ViewerSelection, ViewerSelectorApi, ViewerUtilsApi, } from "./api/ViewerApi";
-export type { ViewerPropertiesApi } from "./api/ViewerPropertiesApi";
+export type { ViewerPropertiesApi, ViewerPropertiesExcelOptions, } from "./api/ViewerPropertiesApi";
 export { BMTLoader } from "./Loaders/BmtLoader";
 export type { BmtModelGeometryData, BmtGeomData, BmtIndexArray, BmtMaterialData, BmtElementProps, BmtModelData, BmtModelProps, BmtModelStructure, BmtModelStructureNode, BmtPropertyRecord, BmtPropertySet, BmtPropertyValue, } from "./Loaders/BmtLoader";
 export { IFCLoader } from "./Loaders/IFCLoader/IFCLoader";
@@ -10,11 +10,15 @@ export { BmtConverter, ConvertIfcFileToBmt, ConvertToBmt, bmtConverter, } from "
 export type { BmtActiveViewFilter, BmtActiveViewFilterParams, BmtConvertibleModels, BmtConversionResult, BmtConvertedFile, BmtConvertedFileType, BmtConverterOptions, BmtConverterSource, BmtVisibleIdsByModel, } from "./Loaders/BmtConverter";
 export { ModelGrids } from "./utils/ModelGrids";
 export type { ModelGridAxis, ModelGridData, ModelGridPoint, ModelGridsProps, ModelGridsData, } from "./utils/ModelGrids";
+export { exportExcel, exportModelPropertiesToExcel, } from "./utils/ExportUtils";
+export type { ExportedExcelFile, ExportModelSource, ModelPropertiesExcelOptions, } from "./utils/ExportUtils";
 export { loader } from "./api/loader";
 export type { ViewerLoadedModels, ViewerLoadModelOptions, ViewerModelSource, } from "./api/loader";
+export { FilteredElementsCollector } from "./Selector/FilteredElementsCollector";
+export type { FilteredElement, FilteredElementId, FilteredElementIdsResult, FilteredElementPredicate, FilteredElementsResult, FilteredElementsSource, FilteredElementWithModel, IfcClass, IfcClassName, } from "./Selector/FilteredElementsCollector";
 export { NavigationCube } from "./utils/NavigationCube";
 export { DimensionLine, DimensionsUtils, useDimensionsUtils, type DimensionUnit, } from "./utils/DimentionsUtils";
 export { createViewerStore } from "./store/ViewerStore";
 export { ViewerStoreProvider } from "./store/ViewerStoreProvider";
 export { useViewerStore, useViewerStoreApi } from "./store/useViewerStore";
-export type { SelectedStore, UserDevice, ViewerGridAxesVisibility, ViewerGridAxisSide, ViewerModelPropsStore, ViewerModelStructureStore, ViewerStore, ViewerStoreApi, } from "./store/ViewerStore";
+export type { SelectedStore, UserDevice, ViewerGridAxesVisibility, ViewerGridAxisSide, ViewerModelNamesStore, ViewerModelPropsStore, ViewerModelStructureStore, ViewerStore, ViewerStoreApi, } from "./store/ViewerStore";