@thatopen/components 1.5.0 → 2.0.0-alpha.0

package/dist/fragments/FragmentIfcStreamer/src/fragment-ifc-stream-converter.d.ts

@@ -0,0 +1,41 @@
+import * as WEBIFC from "web-ifc";
+import { Components, Disposable, Event, Component } from "../../../core";
+import { IfcStreamingSettings } from "./streaming-settings";
+import { StreamedGeometries, StreamedAsset } from "./base-types";
+export declare class FragmentIfcStreamConverter extends Component implements Disposable {
+    static readonly uuid: "d9999a00-e1f5-4d3f-8cfe-c56e08609764";
+    onGeometryStreamed: Event<{
+        buffer: Uint8Array;
+        data: StreamedGeometries;
+    }>;
+    onAssetStreamed: Event<StreamedAsset[]>;
+    onProgress: Event<number>;
+    onIfcLoaded: Event<Uint8Array>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    settings: IfcStreamingSettings;
+    enabled: boolean;
+    webIfc: WEBIFC.IfcAPI;
+    private _spatialTree;
+    private _metaData;
+    private _visitedGeometries;
+    private _streamSerializer;
+    private _geometries;
+    private _geometryCount;
+    private _civil;
+    private _groupSerializer;
+    private _assets;
+    private _meshesWithHoles;
+    constructor(components: Components);
+    dispose(): void;
+    streamFromBuffer(data: Uint8Array): Promise<void>;
+    streamFromCallBack(loadCallback: WEBIFC.ModelLoadCallback): Promise<void>;
+    private readIfcFile;
+    private streamIfcFile;
+    private streamAllGeometries;
+    private cleanUp;
+    private getMesh;
+    private getGeometry;
+    private streamAssets;
+    private streamGeometries;
+}

package/dist/fragments/FragmentIfcStreamer/src/fragment-props-stream-converter.d.ts

@@ -0,0 +1,27 @@
+import * as WEBIFC from "web-ifc";
+import { Component, Disposable, Event } from "../../../core";
+import { PropertiesStreamingSettings } from "./streaming-settings";
+export declare class FragmentPropsStreamConverter extends Component implements Disposable {
+    static readonly uuid: "88d2c89c-ce32-47d7-8cb6-d51e4b311a0b";
+    onPropertiesStreamed: Event<{
+        type: number;
+        data: {
+            [id: number]: any;
+        };
+    }>;
+    onProgress: Event<number>;
+    onIndicesStreamed: Event<number[][]>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    enabled: boolean;
+    settings: PropertiesStreamingSettings;
+    webIfc: WEBIFC.IfcAPI;
+    dispose(): Promise<void>;
+    streamFromBuffer(data: Uint8Array): Promise<void>;
+    streamFromCallBack(loadCallback: WEBIFC.ModelLoadCallback): Promise<void>;
+    private readIfcFile;
+    private streamIfcFile;
+    private streamAllProperties;
+    private getIndices;
+    private cleanUp;
+}

package/dist/fragments/FragmentIfcStreamer/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./streaming-settings";
+export * from "./fragment-props-stream-converter";
+export * from "./fragment-ifc-stream-converter";
+export * from "./base-types";

package/dist/fragments/FragmentIfcStreamer/src/streaming-settings.d.ts

@@ -0,0 +1,10 @@
+import { IfcFragmentSettings } from "../../FragmentIfcLoader/src";
+/** Configuration of the IFC-fragment streaming. */
+export declare class IfcStreamingSettings extends IfcFragmentSettings {
+    minGeometrySize: number;
+    minAssetsSize: number;
+}
+/** Configuration of the IFC-fragment streaming. */
+export declare class PropertiesStreamingSettings extends IfcFragmentSettings {
+    propertiesSize: number;
+}

package/dist/fragments/FragmentManager/index.d.ts

@@ -0,0 +1,44 @@
+import { Fragment, FragmentsGroup } from "bim-fragment";
+import * as THREE from "three";
+import { Component, Components, Event, Disposable } from "../../core";
+/**
+ * Object that can efficiently load binary files that contain
+ * [fragment geometry](https://github.com/ThatOpen/engine_fragment).
+ */
+export declare class FragmentManager extends Component implements Disposable {
+    static readonly uuid: "fef46874-46a3-461b-8c44-2922ab77c806";
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    readonly onFragmentsLoaded: Event<FragmentsGroup>;
+    readonly onFragmentsDisposed: Event<{
+        groupID: string;
+        fragmentIDs: string[];
+    }>;
+    /** All the created [fragments](https://github.com/ThatOpen/engine_fragment). */
+    readonly list: Map<string, Fragment>;
+    readonly groups: Map<string, FragmentsGroup>;
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    baseCoordinationModel: string;
+    private _loader;
+    /** The list of meshes of the created fragments. */
+    get meshes(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[], THREE.Object3DEventMap>[];
+    constructor(components: Components);
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    disposeGroup(group: FragmentsGroup): void;
+    /**
+     * Loads one or many fragments into the scene.
+     * @param data - the bytes containing the data for the fragments to load.
+     * @param coordinate - whether this fragmentsgroup should be federated with the others.
+     * @returns the list of IDs of the loaded fragments.
+     */
+    load(data: Uint8Array, coordinate?: boolean): FragmentsGroup;
+    /**
+     * Export the specified fragments.
+     * @param group - the fragments group to be exported.
+     * @returns the exported data as binary buffer.
+     */
+    export(group: FragmentsGroup): Uint8Array;
+    coordinate(models?: FragmentsGroup[]): void;
+}

package/dist/fragments/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./FragmentBoundingBox";
+export * from "./FragmentClassifier";
+export * from "./FragmentIfcLoader";
+export * from "./FragmentIfcStreamer";
+export * from "./FragmentManager";

package/dist/ifc/IfcJsonExporter/index.d.ts

@@ -0,0 +1,16 @@
+import * as WEBIFC from "web-ifc";
+import * as FRAG from "bim-fragment";
+/**
+ * Object to export all the properties from an IFC to a JS object.
+ */
+export declare class IfcJsonExporter {
+    /**
+     * Exports all the properties of an IFC into an array of JS objects.
+     * @param webIfc The instance of [web-ifc]{@link https://github.com/ThatOpen/engine_web-ifc} to use.
+     * @param modelID ID of the IFC model whose properties to extract.
+     * @param indirect whether to get the indirect relationships as well.
+     * @param recursiveSpatial whether to get the properties of spatial items recursively
+     * to make the location data available (e.g. absolute position of building).
+     */
+    export(webIfc: WEBIFC.IfcAPI, modelID: number, indirect?: boolean, recursiveSpatial?: boolean): Promise<FRAG.IfcProperties>;
+}

package/dist/ifc/IfcJsonExporter/src/ifc-geometry-types.d.ts

@@ -0,0 +1 @@
+export declare const GeometryTypes: Set<number>;

package/dist/ifc/IfcPropertiesFinder/index.d.ts

@@ -0,0 +1,37 @@
+import * as FRAGS from "bim-fragment";
+import { FragmentsGroup } from "bim-fragment";
+import { Disposable, Event, Component, Components } from "../../core";
+import { QueryGroup } from "./src/types";
+export interface QueryResult {
+    [modelID: string]: {
+        modelEntities: Set<number>;
+        otherEntities: Set<number>;
+    };
+}
+export interface IndexedModels {
+    [modelID: string]: {
+        [expressID: number]: Set<number>;
+    };
+}
+export declare class IfcPropertiesFinder extends Component implements Disposable {
+    readonly onFound: Event<FRAGS.FragmentIdMap>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    enabled: boolean;
+    indexedModels: IndexedModels;
+    private readonly _conditionFunctions;
+    private _noHandleAttributes;
+    constructor(components: Components);
+    private onFragmentsDisposed;
+    dispose(): void;
+    private indexEntityRelations;
+    find(groups: QueryGroup[], queryModels?: FragmentsGroup[]): Promise<FRAGS.FragmentIdMap>;
+    private toFragmentMap;
+    private simpleQuery;
+    private getMatchingEntities;
+    private combineArrays;
+    private getCommonElements;
+    private arrayIntersection;
+    private arrayUnion;
+    private getConditionFunctions;
+}

package/dist/ifc/IfcPropertiesFinder/src/types.d.ts

@@ -0,0 +1,23 @@
+export type QueryConditions = "is" | "includes" | "startsWith" | "endsWith" | "matches";
+export type ConditionFunctions = {
+    [queryCondition in QueryConditions]: (leftValue: string | boolean | number, rightValue: string | boolean | number) => boolean;
+};
+export type QueryOperators = "AND" | "OR";
+export interface AttributeQuery {
+    operator?: QueryOperators;
+    attribute: string;
+    condition: QueryConditions;
+    value: string | number | boolean;
+    negateResult?: boolean;
+    caseSensitive?: boolean;
+}
+export interface QueryGroup {
+    operator?: QueryOperators;
+    description?: string;
+    queries: (AttributeQuery | QueryGroup)[];
+}
+export interface Query {
+    name: string;
+    description?: string;
+    groups: QueryGroup;
+}

package/dist/ifc/IfcPropertiesIndexer/index.d.ts

@@ -0,0 +1,31 @@
+import { FragmentsGroup } from "bim-fragment";
+import { Disposable, Event, Component, Components } from "../../core";
+import { IfcPropertiesManager } from "../IfcPropertiesManager";
+interface IndexMap {
+    [modelID: string]: {
+        [expressID: string]: Set<number>;
+    };
+}
+export declare class IfcPropertiesIndexer extends Component implements Disposable {
+    static readonly uuid: "23a889ab-83b3-44a4-8bee-ead83438370b";
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    enabled: boolean;
+    relationsToProcess: number[];
+    indexMap: IndexMap;
+    private _propertiesManager;
+    readonly onPropertiesManagerSet: Event<IfcPropertiesManager>;
+    set propertiesManager(manager: IfcPropertiesManager | null);
+    get propertiesManager(): IfcPropertiesManager | null;
+    constructor(components: Components);
+    private onFragmentsDisposed;
+    dispose(): Promise<void>;
+    getProperties(model: FragmentsGroup, id: string): Promise<any[] | null>;
+    private getNestedPsets;
+    private getPsetProperties;
+    process(model: FragmentsGroup): Promise<void>;
+    private setEntityIndex;
+    private cloneProperty;
+    private clonePropertyArray;
+}
+export {};

package/dist/ifc/IfcPropertiesManager/index.d.ts

@@ -0,0 +1,73 @@
+import * as WEBIFC from "web-ifc";
+import { FragmentsGroup } from "bim-fragment";
+import { Component, Disposable, Event, Components } from "../../core";
+type BooleanPropTypes = "IfcBoolean" | "IfcLogical";
+type StringPropTypes = "IfcText" | "IfcLabel" | "IfcIdentifier";
+type NumericPropTypes = "IfcInteger" | "IfcReal";
+interface ChangeMap {
+    [modelID: string]: Set<number>;
+}
+interface AttributeListener {
+    [modelID: string]: {
+        [expressID: number]: {
+            [attributeName: string]: Event<String | Boolean | Number>;
+        };
+    };
+}
+export declare class IfcPropertiesManager extends Component implements Disposable {
+    static readonly uuid: "58c2d9f0-183c-48d6-a402-dfcf5b9a34df";
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    readonly onRequestFile: Event<unknown>;
+    ifcToExport: ArrayBuffer | null;
+    readonly onElementToPset: Event<{
+        model: FragmentsGroup;
+        psetID: number;
+        elementID: number;
+    }>;
+    readonly onPropToPset: Event<{
+        model: FragmentsGroup;
+        psetID: number;
+        propID: number;
+    }>;
+    readonly onPsetRemoved: Event<{
+        model: FragmentsGroup;
+        psetID: number;
+    }>;
+    readonly onDataChanged: Event<{
+        model: FragmentsGroup;
+        expressID: number;
+    }>;
+    wasm: {
+        path: string;
+        absolute: boolean;
+    };
+    enabled: boolean;
+    attributeListeners: AttributeListener;
+    selectedModel?: FragmentsGroup;
+    private _changeMap;
+    constructor(components: Components);
+    get(): ChangeMap;
+    dispose(): void;
+    private increaseMaxID;
+    static getIFCSchema(model: FragmentsGroup): import("bim-fragment").IfcSchema;
+    private newGUID;
+    private getOwnerHistory;
+    private registerChange;
+    setData(model: FragmentsGroup, ...dataToSave: Record<string, any>[]): Promise<void>;
+    newPset(model: FragmentsGroup, name: string, description?: string): Promise<{
+        pset: WEBIFC.IFC2X3.IfcPropertySet | WEBIFC.IFC4.IfcPropertySet | WEBIFC.IFC4X3.IfcPropertySet;
+        rel: WEBIFC.IFC4X3.IfcRelDefinesByProperties | WEBIFC.IFC4.IfcRelDefinesByProperties | WEBIFC.IFC2X3.IfcRelDefinesByProperties;
+    }>;
+    removePset(model: FragmentsGroup, ...psetID: number[]): Promise<void>;
+    private newSingleProperty;
+    newSingleStringProperty(model: FragmentsGroup, type: StringPropTypes, name: string, value: string): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    newSingleNumericProperty(model: FragmentsGroup, type: NumericPropTypes, name: string, value: number): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    newSingleBooleanProperty(model: FragmentsGroup, type: BooleanPropTypes, name: string, value: boolean): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    removePsetProp(model: FragmentsGroup, psetID: number, propID: number): Promise<void>;
+    addElementToPset(model: FragmentsGroup, psetID: number, ...elementID: number[]): Promise<void>;
+    addPropToPset(model: FragmentsGroup, psetID: number, ...propID: number[]): Promise<void>;
+    saveToIfc(model: FragmentsGroup, ifcToSaveOn: Uint8Array): Promise<Uint8Array>;
+    setAttributeListener(model: FragmentsGroup, expressID: number, attributeName: string): Promise<Event<String | Number | Boolean>>;
+}
+export {};

package/dist/ifc/Utils/ifc-categories.d.ts

@@ -0,0 +1,7 @@
+import * as WEBIFC from "web-ifc";
+export interface IfcItemsCategories {
+    [itemID: number]: number;
+}
+export declare class IfcCategories {
+    getAll(webIfc: WEBIFC.IfcAPI, modelID: number): IfcItemsCategories;
+}

package/dist/ifc/Utils/ifc-category-map.d.ts

@@ -0,0 +1,3 @@
+export declare const IfcCategoryMap: {
+    [key: number]: string;
+};

package/dist/ifc/Utils/ifc-elements-map.d.ts

@@ -0,0 +1,3 @@
+export declare const IfcElements: {
+    [key: number]: string;
+};

package/dist/ifc/Utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ifc-categories";
+export * from "./ifc-elements-map";
+export * from "./ifc-category-map";
+export * from "./properties-utils";

package/dist/ifc/Utils/properties-utils.d.ts

@@ -0,0 +1,25 @@
+import * as FRAGS from "bim-fragment";
+export declare class IfcPropertiesUtils {
+    static getUnits(group: FRAGS.FragmentsGroup): Promise<number>;
+    static findItemByGuid(model: FRAGS.FragmentsGroup, guid: string): Promise<{
+        [attribute: string]: any;
+    } | null>;
+    static getRelationMap(model: FRAGS.FragmentsGroup, relationType: number, onElementsFound?: (relatingID: number, relatedIDs: number[]) => Promise<void>): Promise<{
+        [relatingID: number]: number[];
+    }>;
+    static getQsetQuantities(model: FRAGS.FragmentsGroup, expressID: number, onQuantityFound?: (expressID: number) => void): Promise<number[] | null>;
+    static getPsetProps(model: FRAGS.FragmentsGroup, expressID: number, onPropFound?: (expressID: number) => void): Promise<number[] | null>;
+    static getPsetRel(model: FRAGS.FragmentsGroup, psetID: number): Promise<number | null>;
+    static getQsetRel(model: FRAGS.FragmentsGroup, qsetID: number): Promise<number | null>;
+    static getEntityName(model: FRAGS.FragmentsGroup, entityID: number): Promise<{
+        key: string | null;
+        name: string | null;
+    }>;
+    static getQuantityValue(model: FRAGS.FragmentsGroup, quantityID: number): Promise<{
+        key: string | null;
+        value: number | null;
+    }>;
+    static isRel(expressID: number): boolean;
+    static attributeExists(model: FRAGS.FragmentsGroup, expressID: number, attribute: string): Promise<boolean>;
+    static groupEntitiesByType(model: FRAGS.FragmentsGroup, expressIDs: Set<number> | number[]): Promise<Map<number, Set<number>>>;
+}

package/dist/ifc/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./IfcJsonExporter";
+export * from "./IfcPropertiesFinder";
+export * from "./IfcPropertiesIndexer";
+export * from "./IfcPropertiesManager";
+export * from "./Utils";