@thatopen/components 2.4.11 → 3.1.1

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

@@ -1,116 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFragmentSettings } from "./src";
-import { Component, Components, Event, Disposable } from "../../core";
-export * from "./src/ifc-fragment-settings";
-/**
- * The IfcLoader component is responsible for loading and processing IFC files. It utilizes the Web-IFC library to handle the IFC data and the Three.js library for 3D rendering. The class provides methods for setting up, loading, and cleaning up IFC files. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcLoader). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcLoader).
- */
-export declare class IfcLoader extends Component implements Disposable {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "a659add7-1418-4771-a0d6-7d4d438e4624";
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<string>;
-    /**
-     * An event triggered when the IFC file starts loading.
-     */
-    readonly onIfcStartedLoading: Event<void>;
-    /**
-     * An event triggered when the setup process is completed.
-     */
-    readonly onSetup: Event<void>;
-    /**
-     * The settings for the IfcLoader.
-     * It includes options for excluding categories, setting WASM paths, and more.
-     */
-    settings: IfcFragmentSettings;
-    /**
-     * The instance of the Web-IFC library used for handling IFC data.
-     */
-    webIfc: WEBIFC.IfcAPI;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    private _material;
-    private _spatialTree;
-    private _metaData;
-    private _fragmentInstances;
-    private _civil;
-    private _visitedFragments;
-    private _materialT;
-    constructor(components: Components);
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * Sets up the IfcLoader component with the provided configuration.
-     *
-     * @param config - Optional configuration settings for the IfcLoader.
-     * If not provided, the existing settings will be used.
-     *
-     * @returns A Promise that resolves when the setup process is completed.
-     *
-     * @remarks
-     * If the `autoSetWasm` option is enabled in the configuration,
-     * the method will automatically set the WASM paths for the Web-IFC library.
-     *
-     * @example
-     * ```typescript
-     * const ifcLoader = new IfcLoader(components);
-     * await ifcLoader.setup({ autoSetWasm: true });
-     * ```
-     */
-    setup(config?: Partial<IfcFragmentSettings>): Promise<void>;
-    /**
-     * Loads an IFC file and processes it for 3D visualization.
-     *
-     * @param data - The Uint8Array containing the IFC file data.
-     * @param coordinate - Optional boolean indicating whether to coordinate the loaded IFC data. Default is true.
-     *
-     * @returns A Promise that resolves to the FragmentsGroup containing the loaded and processed IFC data.
-     *
-     * @example
-     * ```typescript
-     * const ifcLoader = components.get(IfcLoader);
-     * const group = await ifcLoader.load(ifcData);
-     * ```
-     */
-    load(data: Uint8Array, coordinate?: boolean, name?: string): Promise<FRAGS.FragmentsGroup>;
-    /**
-     * Reads an IFC file and initializes the Web-IFC library.
-     *
-     * @param data - The Uint8Array containing the IFC file data.
-     *
-     * @returns A Promise that resolves when the IFC file is opened and initialized.
-     *
-     * @remarks
-     * This method sets the WASM path and initializes the Web-IFC library based on the provided settings.
-     * It also opens the IFC model using the provided data and settings.
-     *
-     * @example
-     * ```typescript
-     * const ifcLoader = components.get(IfcLoader);
-     * await ifcLoader.readIfcFile(ifcData);
-     * ```
-     */
-    readIfcFile(data: Uint8Array): Promise<number>;
-    /**
-     * Cleans up the IfcLoader component by resetting the Web-IFC library,
-     * clearing the visited fragments and fragment instances maps, and creating a new instance of the Web-IFC library.
-     *
-     * @remarks
-     * This method is called automatically after using the .load() method, so usually you don't need to use it manually.
-     *
-     * @example
-     * ```typescript
-     * const ifcLoader = components.get(IfcLoader);
-     * ifcLoader.cleanUp();
-     * ```
-     */
-    cleanUp(): void;
-    private getAllGeometries;
-    private getMesh;
-    private getGeometry;
-    private autoSetWasm;
-}

package/dist/fragments/IfcLoader/src/civil-reader.d.ts

@@ -1,15 +0,0 @@
-import * as THREE from "three";
-import * as WEBIFC from "web-ifc";
-import * as FRAGS from "@thatopen/fragments";
-export declare class CivilReader {
-    defLineMat: THREE.LineBasicMaterial;
-    read(webIfc: WEBIFC.IfcAPI): {
-        alignments: Map<number, FRAGS.AlignmentObject>;
-        coordinationMatrix: THREE.Matrix4;
-    } | undefined;
-    get(civilItems: any): {
-        alignments: Map<number, FRAGS.AlignmentObject>;
-        coordinationMatrix: THREE.Matrix4;
-    } | undefined;
-    private getCurves;
-}

package/dist/fragments/IfcLoader/src/ifc-fragment-settings.d.ts

@@ -1,41 +0,0 @@
-import * as WEBIFC from "web-ifc";
-/** Configuration of the IFC-fragment conversion. */
-export declare class IfcFragmentSettings {
-    /** Whether to extract the IFC properties into a JSON. */
-    includeProperties: boolean;
-    /**
-     * Generate the geometry for categories that are not included by default,
-     * like IFCSPACE.
-     */
-    optionalCategories: number[];
-    /** Path of the WASM for [web-ifc](https://github.com/ThatOpen/engine_web-ifc). */
-    wasm: {
-        path: string;
-        absolute: boolean;
-        logLevel?: WEBIFC.LogLevel;
-    };
-    /** List of categories that won't be converted to fragments. */
-    excludedCategories: Set<number>;
-    /** Exclusive list of categories that will be converted to fragments. If this contains any category, any other categories will be ignored. */
-    includedCategories: Set<number>;
-    /** Whether to save the absolute location of all IFC items. */
-    saveLocations: boolean;
-    /** Loader settings for [web-ifc](https://github.com/ThatOpen/engine_web-ifc). */
-    webIfc: WEBIFC.LoaderSettings;
-    /**
-     * Whether to automatically set the path to the WASM file for [web-ifc](https://github.com/ThatOpen/engine_web-ifc).
-     * If set to true, the path will be set to the default path of the WASM file.
-     * If set to false, the path must be provided manually in the `wasm.path` property.
-     * Default value is true.
-     */
-    autoSetWasm: boolean;
-    /**
-     * Custom function to handle the file location for [web-ifc](https://github.com/ThatOpen/engine_web-ifc).
-     * This function will be called when [web-ifc](https://github.com/ThatOpen/engine_web-ifc) needs to locate a file.
-     * If set to null, the default file location handler will be used.
-     *
-     * @param url - The URL of the file to locate.
-     * @returns The absolute path of the file.
-     */
-    customLocateFileHandler: WEBIFC.LocateFileHandlerFn | null;
-}

package/dist/fragments/IfcLoader/src/ifc-metadata-reader.d.ts

@@ -1,5 +0,0 @@
-import * as WEBIFC from "web-ifc";
-export declare class IfcMetadataReader {
-    getNameInfo(webIfc: WEBIFC.IfcAPI): Record<string, any>;
-    getDescriptionInfo(webIfc: WEBIFC.IfcAPI): Record<string, any>;
-}

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

@@ -1,5 +0,0 @@
-export * from "./ifc-fragment-settings";
-export * from "./spatial-structure";
-export * from "./civil-reader";
-export * from "./ifc-metadata-reader";
-export * from "./spatial-ids-finder";

package/dist/fragments/IfcLoader/src/spatial-ids-finder.d.ts

@@ -1,5 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import * as WEBIFC from "web-ifc";
-export declare class SpatialIdsFinder {
-    static get(model: FRAGS.FragmentsGroup, webIfc: WEBIFC.IfcAPI): void;
-}

package/dist/fragments/IfcLoader/src/spatial-structure.d.ts

@@ -1,8 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import { IfcItemsCategories } from "../../../ifc";
-export declare class SpatialStructure {
-    itemsByFloor: IfcItemsCategories;
-    private _units;
-    setUp(webIfc: WEBIFC.IfcAPI): void;
-    cleanUp(): void;
-}

package/dist/fragments/IfcLoader/src/transform-helper.d.ts

@@ -1,5 +0,0 @@
-import { BufferGeometry } from "three";
-import * as THREE from "three";
-export declare class TransformHelper {
-    getHelper(geometries: BufferGeometry[]): THREE.Object3D<THREE.Object3DEventMap>;
-}

package/dist/fragments/IfcLoader/src/units.d.ts

@@ -1,10 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import * as THREE from "three";
-export declare class Units {
-    factor: number;
-    complement: number;
-    apply(matrix: THREE.Matrix4): void;
-    setUp(webIfc: WEBIFC.IfcAPI): void;
-    private getLengthUnits;
-    private getScaleMatrix;
-}

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

@@ -1,66 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import { AsyncEvent, Component, Disposable, Event } from "../../core";
-import { PropertiesStreamingSettings } from "./src";
-export * from "./src";
-/**
- * A component that converts the properties of an IFC file to tiles. It uses the Web-IFC library to read and process the IFC data. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcPropertiesTiler). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcPropertiesTiler).
- */
-export declare class IfcPropertiesTiler extends Component implements Disposable {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "88d2c89c-ce32-47d7-8cb6-d51e4b311a0b";
-    /**
-     * An event that is triggered when properties are streamed from the IFC file.
-     * The event provides the type of the IFC entity and the corresponding data.
-     */
-    readonly onPropertiesStreamed: AsyncEvent<{
-        type: number;
-        data: {
-            [id: number]: any;
-        };
-    }>;
-    /**
-     * An event that is triggered to indicate the progress of the streaming process.
-     * The event provides a number between 0 and 1 representing the progress percentage.
-     */
-    readonly onProgress: AsyncEvent<number>;
-    /**
-     * An event that is triggered when indices are streamed from the IFC file.
-     * The event provides a map of indices, where the key is the entity type and the value is another map of indices.
-     */
-    readonly onIndicesStreamed: AsyncEvent<Map<number, Map<number, number[]>>>;
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<string>;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * An instance of the PropertiesStreamingSettings class, which holds the settings for the streaming process.
-     */
-    settings: PropertiesStreamingSettings;
-    /**
-     * An instance of the IfcAPI class from the Web-IFC library, which provides methods for reading and processing IFC data.
-     */
-    webIfc: WEBIFC.IfcAPI;
-    /** {@link Disposable.dispose} */
-    dispose(): Promise<void>;
-    /**
-     * This method converts properties from an IFC file to tiles given its data as a Uint8Array.
-     *
-     * @param data - The Uint8Array containing the IFC file data.
-     * @returns A Promise that resolves when the streaming process is complete.
-     */
-    streamFromBuffer(data: Uint8Array): Promise<void>;
-    /**
-     * This method converts properties from an IFC file to tiles using a given callback function to read the file.
-     *
-     * @param loadCallback - A callback function that loads the IFC file data.
-     * @returns A Promise that resolves when the streaming process is complete.
-     */
-    streamFromCallBack(loadCallback: WEBIFC.ModelLoadCallback): Promise<void>;
-    private readIfcFile;
-    private streamIfcFile;
-    private streamAllProperties;
-    private cleanUp;
-}

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

@@ -1 +0,0 @@
-export * from "./streaming-settings";

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

@@ -1,11 +0,0 @@
-import { IfcFragmentSettings } from "../../IfcLoader/src";
-/**
- * Settings for streaming properties. Extends {@link IfcFragmentSettings} to inherit common settings.
- */
-export declare class PropertiesStreamingSettings extends IfcFragmentSettings {
-    /**
-     * Amount of properties to be streamed.
-     * Defaults to 100 properties.
-     */
-    propertiesSize: number;
-}

package/dist/fragments/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./BoundingBoxer";
-export * from "./Classifier";
-export * from "./Exploder";
-export * from "./Hider";
-export * from "./IfcLoader";
-export * from "./FragmentsManager";
-export * from "./IfcGeometryTiler";
-export * from "./IfcPropertiesTiler";

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

@@ -1,50 +0,0 @@
-import { Component, Components } from "../../core";
-import { IfcQueryGroup } from "./src/ifc-query-group";
-import { IfcFinderQuery } from "./src";
-export * from "./src";
-/**
- * Component to make text queries in the IFC.
- */
-export declare class IfcFinder extends Component {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "0da7ad77-f734-42ca-942f-a074adfd1e3a";
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * List of all created {@link IfcQueryGroup} instances.
-     */
-    list: Map<string, IfcQueryGroup>;
-    /**
-     * List of all queries from all created {@link IfcQueryGroup} instances.
-     */
-    get queries(): Set<IfcFinderQuery>;
-    constructor(components: Components);
-    /**
-     * Imports all the query groups provided in the given data. You can generate this data to save the result of queries and persist it over time.
-     * @param data The data containing the serialized query groups to import.
-     */
-    import(data: {
-        [groupID: string]: any;
-    }): void;
-    /**
-     * Exports all the query groups created. You can then import this data back using the import method.
-     */
-    export(): {
-        [groupID: string]: any;
-    };
-    /**
-     * Creates a new {@link IfcQueryGroup}.
-     */
-    create(): IfcQueryGroup;
-    /**
-     * Creates the {@link IfcQueryGroup} with the given ID.
-     */
-    delete(id: string): void;
-    /**
-     * Deletes all {@link IfcQueryGroup} instances.
-     */
-    clear(): void;
-}

package/dist/ifc/IfcFinder/src/ifc-basic-query.d.ts

@@ -1,35 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderRule, SerializedQuery } from "./types";
-import { IfcFinderQuery } from "./ifc-finder-query";
-import { Components } from "../../../core";
-/**
- * A query that checks the direct attributes of IFC items.
- */
-export declare class IfcBasicQuery extends IfcFinderQuery {
-    /**
-     * {@link IfcFinderQuery.name}
-     */
-    name: string;
-    /**
-     * The type of this query.
-     */
-    static type: "IfcBasicQuery";
-    /**
-     * {@link IfcFinderQuery.items}
-     */
-    get items(): FRAGS.FragmentIdMap;
-    constructor(components: Components, data: {
-        name: string;
-        rules: IfcFinderRule[];
-        inclusive: boolean;
-    });
-    /**
-     * {@link IfcFinderQuery.export}
-     */
-    export(): SerializedQuery;
-    /**
-     * {@link IfcFinderQuery.update}
-     */
-    update(modelID: string, file: File): Promise<void>;
-    protected findInLines(modelID: string, lines: string[]): void;
-}

package/dist/ifc/IfcFinder/src/ifc-finder-query.d.ts

@@ -1,96 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderRule, SerializedQuery } from "./types";
-import { Components, Event } from "../../../core";
-/**
- * The base class for all queries used by the {@link IfcFinder}.
- */
-export declare abstract class IfcFinderQuery {
-    /**
-     * The list of functions to import the queries. If you create your own custom query, you should add its importer here. See the other queries provided by the library for reference.
-     */
-    static importers: Map<string, (components: Components, data: any) => IfcFinderQuery>;
-    /**
-     * Event used to notify the progress when performing a query on an IFC file.
-     */
-    readonly onProgress: Event<number>;
-    /**
-     * A name given to the instance of the query to identify it.
-     */
-    abstract name: string;
-    /**
-     * The list of IFC items that this query found across all models.
-     */
-    abstract items: FRAGS.FragmentIdMap;
-    /**
-     * If false, ALL rules of the query must comply to make a match. If true, ANY rule will be enough to make a match.
-     */
-    inclusive: boolean;
-    /**
-     * The list of rules to be applied by this query.
-     */
-    rules: IfcFinderRule[];
-    /**
-     * The IDs of the match items per model.
-     */
-    ids: {
-        [modelID: string]: Set<number>;
-    };
-    /**
-     * Whether this query is up to date or not per file. If not, when updating the group where it belongs, it will re-process the given file.
-     */
-    needsUpdate: Map<string, boolean>;
-    /**
-     * Export the current data of this query in a serializable object to persist it over time.
-     */
-    abstract export(): {
-        [key: string]: any;
-    };
-    /**
-     * Perform the search in the given file and save the result.
-     */
-    abstract update(modelID: string, file: File): Promise<void>;
-    protected components: Components;
-    protected abstract findInLines(modelID: string, lines: string[]): void;
-    protected constructor(components: Components);
-    /**
-     * Imports a query given its data. This data can be generating using its {@link IfcFinderQuery.export} method.
-     *
-     * @param components the instance of {@link Components} used by this app.
-     * @param data the data of the query to import as a serializable object.
-     */
-    static import(components: Components, data: {
-        [id: string]: any;
-    }): IfcFinderQuery | null;
-    /**
-     * Imports the given serialized rules. Only use this when writing your own custom query. See the other queries provided by the library for reference.
-     *
-     * @param serializedRules the rules to be parsed.
-     */
-    static importRules(serializedRules: {
-        [key: string]: any;
-    }[]): IfcFinderRule[];
-    /**
-     * Imports the given IDs. Only use this when writing your own custom query. See the other queries provided by the library for reference.
-     *
-     * @param data the serialized object representing the query whose IDs to parse.
-     */
-    static importIds(data: SerializedQuery): {
-        [modelID: string]: Set<number>;
-    };
-    /**
-     * Clears the data of the given model. If not specified, clears all the data.
-     *
-     * @param modelID ID of the model whose data to clear.
-     */
-    clear(modelID?: string): void;
-    protected addID(modelID: string, id: number): void;
-    protected getData(): SerializedQuery;
-    protected exportRules(): {
-        [key: string]: any;
-    }[];
-    protected findInFile(modelID: string, file: File): Promise<void>;
-    protected getIdFromLine(line: string): number;
-    protected testRules(line: string): boolean;
-    protected getCategoryFromLine(line: string): string | null;
-    protected getAttributesFromLine(line: string): string[] | null;
-}

package/dist/ifc/IfcFinder/src/ifc-property-query.d.ts

@@ -1,36 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderQuery } from "./ifc-finder-query";
-import { IfcOperatorRule, IfcPropertyRule, SerializedQuery } from "./types";
-import { Components } from "../../../core";
-/**
- * A query that checks the properties in the property sets assigned to IFC items.
- */
-export declare class IfcPropertyQuery extends IfcFinderQuery {
-    /**
-     * {@link IfcFinderQuery.name}
-     */
-    name: string;
-    /**
-     * The type of this query.
-     */
-    static type: "IfcPropertyQuery";
-    private psets;
-    /**
-     * {@link IfcFinderQuery.items}
-     */
-    get items(): FRAGS.FragmentIdMap;
-    constructor(components: Components, data: {
-        name: string;
-        inclusive: boolean;
-        rules: (IfcPropertyRule | IfcOperatorRule)[];
-    });
-    /**
-     * {@link IfcFinderQuery.export}
-     */
-    export(): SerializedQuery;
-    /**
-     * {@link IfcFinderQuery.update}
-     */
-    update(modelID: string, file: File): Promise<void>;
-    protected findInLines(modelID: string, lines: string[]): void;
-}

package/dist/ifc/IfcFinder/src/ifc-query-group.d.ts

@@ -1,69 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderQuery } from "./ifc-finder-query";
-import { Components } from "../../../core";
-/**
- * A group of queries to perform searches in one or many IFC files.
- */
-export declare class IfcQueryGroup {
-    /**
-     * The list of queries contained in this group.
-     */
-    list: Map<string, IfcFinderQuery>;
-    /**
-     * A unique string to identify this group instance.
-     */
-    id: string;
-    /**
-     * The way this group works when retrieving items.
-     * - Combine: returns the sum of all items of all queries.
-     * - Intersect: returns only the common elements of all queries.
-     */
-    mode: "combine" | "intersect";
-    private _components;
-    /**
-     * The list of unique queries contained in this group.
-     */
-    get queries(): Set<IfcFinderQuery>;
-    /**
-     * The items of all the queries contained in this group. The returned data depends on {@link IfcQueryGroup.mode}.
-     */
-    get items(): FRAGS.FragmentIdMap;
-    constructor(components: Components);
-    /**
-     * Adds a new query to this group.
-     * @param query the query to add.
-     */
-    add(query: IfcFinderQuery): void;
-    /**
-     * Clears the data of the given modelID of all queries contained in this group. If no modelID is provided, clears all data.
-     * @param modelID the model whose data to remove.
-     */
-    clear(modelID?: string): void;
-    /**
-     * Imports data that has been previously exported through {@link IfcQueryGroup.export}.
-     * @param data the serializable object used to persist a group's data.
-     */
-    import(data: {
-        mode: "combine" | "intersect";
-        id: string;
-        queries: {
-            [guid: string]: any;
-        };
-    }): void;
-    /**
-     * Exports all the data of this group, so that it can be persisted and imported later using {@link IfcQueryGroup.import}.
-     */
-    export(): {
-        mode: "combine" | "intersect";
-        id: string;
-        queries: {
-            [guid: string]: any;
-        };
-    };
-    /**
-     * Updates all the queries contained in this group that need an update for the given file. It will skip those where {@link IfcFinderQuery.needsUpdate} is false.
-     * @param modelID the identifier used to refer to the given file.
-     * @param file the file to process.
-     */
-    update(modelID: string, file: File): Promise<void>;
-}

package/dist/ifc/IfcFinder/src/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./types";
-export * from "./ifc-finder-query";
-export * from "./ifc-basic-query";
-export * from "./ifc-property-query";