@thatopen/components 2.4.11 → 3.1.1

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

@@ -1,197 +0,0 @@
-import * as THREE from "three";
-import * as FRAGS from "@thatopen/fragments";
-import { Disposable, Component, Event, Components } from "../../core";
-/**
- * Interface representing a classification system. The classification is organized by system and class name, and each class contains a map of fragment IDs with extra information.
- */
-export interface Classification {
-    /**
-     * A system within the classification.
-     * The key is the system name, and the value is an object representing the classes within the system.
-     */
-    [system: string]: {
-        /**
-         * A class within the system.
-         * The key is the class name, and the value is an object containing a map of fragment IDs with extra information.
-         */
-        [groupName: string]: {
-            map: FRAGS.FragmentIdMap;
-            name: string;
-            id: number | null;
-        };
-    };
-}
-interface ExportedClassification {
-    [system: string]: {
-        [groupName: string]: {
-            map: {
-                [name: string]: number[];
-            };
-            name: string;
-            id: number | null;
-        };
-    };
-}
-/**
- * The Classifier component is responsible for classifying and categorizing fragments based on various criteria. It provides methods to add, remove, find, and filter fragments based on their classification. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/Classifier). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/Classifier).
- */
-export declare class Classifier 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: "e25a7f3c-46c4-4a14-9d3d-5115f24ebeb7";
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * A map representing the classification systems.
-     * The key is the system name, and the value is an object representing the classes within the system.
-     */
-    list: Classification;
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<unknown>;
-    constructor(components: Components);
-    private onFragmentsDisposed;
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * Removes a fragment from the classification based on its unique identifier (guid).
-     * This method iterates through all classification systems and classes, and deletes the fragment with the specified guid from the respective group.
-     *
-     * @param guid - The unique identifier of the fragment to be removed.
-     */
-    remove(guid: string): void;
-    /**
-     * Finds and returns fragments based on the provided filter criteria.
-     * If no filter is provided, it returns all fragments.
-     *
-     * @param filter - An optional object containing filter criteria.
-     * The keys of the object represent the classification system names,
-     * and the values are arrays of class names to match.
-     *
-     * @returns A map of fragment GUIDs to their respective express IDs,
-     * where the express IDs are filtered based on the provided filter criteria.
-     *
-     * @throws Will throw an error if the fragments map is malformed.
-     */
-    find(filter?: {
-        [name: string]: string[];
-    }): FRAGS.FragmentIdMap;
-    /**
-     * Classifies fragments based on their modelID.
-     *
-     * @param modelID - The unique identifier of the model to classify fragments by.
-     * @param group - The FragmentsGroup containing the fragments to be classified.
-     *
-     * @remarks
-     * This method iterates through the fragments in the provided group,
-     * and classifies them based on their modelID.
-     * The classification is stored in the `list.models` property,
-     * with the modelID as the key and a map of fragment IDs to their respective express IDs as the value.
-     *
-     */
-    byModel(modelID: string, group: FRAGS.FragmentsGroup): void;
-    /**
-     * Classifies fragments based on their PredefinedType property.
-     *
-     * @param group - The FragmentsGroup containing the fragments to be classified.
-     *
-     * @remarks
-     * This method iterates through the properties of the fragments in the provided group,
-     * and classifies them based on their PredefinedType property.
-     * The classification is stored in the `list.predefinedTypes` property,
-     * with the PredefinedType as the key and a map of fragment IDs to their respective express IDs as the value.
-     *
-     * @throws Will throw an error if the fragment ID is not found.
-     */
-    byPredefinedType(group: FRAGS.FragmentsGroup): Promise<void>;
-    /**
-     * Classifies fragments based on their entity type.
-     *
-     * @param group - The FragmentsGroup containing the fragments to be classified.
-     *
-     * @remarks
-     * This method iterates through the relations of the fragments in the provided group,
-     * and classifies them based on their entity type.
-     * The classification is stored in the `list.entities` property,
-     * with the entity type as the key and a map of fragment IDs to their respective express IDs as the value.
-     *
-     * @throws Will throw an error if the fragment ID is not found.
-     */
-    byEntity(group: FRAGS.FragmentsGroup): void;
-    /**
-     * Classifies fragments based on a specific IFC relationship.
-     *
-     * @param group - The FragmentsGroup containing the fragments to be classified.
-     * @param ifcRel - The IFC relationship number to classify fragments by.
-     * @param systemName - The name of the classification system to store the classification.
-     *
-     * @remarks
-     * This method iterates through the relations of the fragments in the provided group,
-     * and classifies them based on the specified IFC relationship.
-     * The classification is stored in the `list` property under the specified system name,
-     * with the relationship name as the class name and a map of fragment IDs to their respective express IDs as the value.
-     *
-     * @throws Will throw an error if the fragment ID is not found or if the IFC relationship is not valid.
-     */
-    byIfcRel(group: FRAGS.FragmentsGroup, ifcRel: number, systemName: string): Promise<void>;
-    /**
-     * Classifies fragments based on their spatial structure in the IFC model.
-     *
-     * @param model - The FragmentsGroup containing the fragments to be classified.
-     * @param config - The configuration for the classifier. It includes "useProperties", which is true by default
-     * (if false, the classification will use the expressIDs instead of the names), and "isolate", which will make
-     * the classifier just pick the WEBIFC categories provided.
-     *
-     * @remarks
-     * This method iterates through the relations of the fragments in the provided group,
-     * and classifies them based on their spatial structure in the IFC model.
-     * The classification is stored in the `list` property under the system name "spatialStructures",
-     * with the relationship name as the class name and a map of fragment IDs to their respective express IDs as the value.
-     *
-     * @throws Will throw an error if the fragment ID is not found or if the model relations do not exist.
-     */
-    bySpatialStructure(model: FRAGS.FragmentsGroup, config?: {
-        useProperties?: boolean;
-        isolate?: Set<number>;
-        systemName?: string;
-    }): Promise<void>;
-    /**
-     * Sets the color of the specified fragments.
-     *
-     * @param items - A map of fragment IDs to their respective express IDs.
-     * @param color - The color to set for the fragments.
-     * @param override - A boolean indicating whether to override the existing color of the fragments.
-     *
-     * @remarks
-     * This method iterates through the provided fragment IDs, retrieves the corresponding fragments,
-     * and sets their color using the `setColor` method of the FragmentsGroup class.
-     *
-     * @throws Will throw an error if the fragment with the specified ID is not found.
-     */
-    setColor(items: FRAGS.FragmentIdMap, color: THREE.Color, override?: boolean): void;
-    /**
-     * Resets the color of the specified fragments to their original color.
-     *
-     * @param items - A map of fragment IDs to their respective express IDs.
-     *
-     * @remarks
-     * This method iterates through the provided fragment IDs, retrieves the corresponding fragments,
-     * and resets their color using the `resetColor` method of the FragmentsGroup class.
-     *
-     * @throws Will throw an error if the fragment with the specified ID is not found.
-     */
-    resetColor(items: FRAGS.FragmentIdMap): void;
-    /**
-     * Exports the computed classification to persists them and import them back
-     * later for faster loading.
-     */
-    export(): ExportedClassification;
-    /**
-     * Imports a classification previously exported with .export().
-     * @param data the serialized classification to import.
-     */
-    import(data: ExportedClassification): void;
-    protected saveItem(group: FRAGS.FragmentsGroup, systemName: string, className: string, expressID: number, parentID?: number | null): void;
-}
-export {};

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

@@ -1,50 +0,0 @@
-import { Component, Disposable, Event, Components } from "../../core";
-/**
- * The Exploder component is responsible for managing the explosion of 3D model fragments (generally by floor). 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/Exploder). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/Exploder).
- */
-export declare class Exploder 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: "d260618b-ce88-4c7d-826c-6debb91de3e2";
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<unknown>;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * The height of the explosion animation.
-     * This property determines the vertical distance by which fragments are moved during the explosion.
-     * Default value is 10.
-     */
-    height: number;
-    /**
-     * The group name used for the explosion animation.
-     * This property specifies the group of fragments that will be affected by the explosion.
-     * Default value is "storeys".
-     */
-    groupName: string;
-    /**
-     * A set of strings representing the exploded items.
-     * This set is used to keep track of which items have been exploded.
-     */
-    list: Set<string>;
-    constructor(components: Components);
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * Sets the explosion state of the fragments.
-     *
-     * @param active - A boolean indicating whether to activate or deactivate the explosion.
-     *
-     * @remarks
-     * This method applies a vertical transformation to the fragments based on the `active` parameter.
-     * If `active` is true, the fragments are moved upwards by a distance determined by the `height` property.
-     * If `active` is false, the fragments are moved back to their original position.
-     *
-     * The method also keeps track of the exploded items using the `list` set.
-     *
-     * @throws Will throw an error if the `Classifier` or `FragmentsManager` components are not found in the `components` system.
-     */
-    set(active: boolean): void;
-}

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

@@ -1,152 +0,0 @@
-import { Fragment, FragmentsGroup } from "@thatopen/fragments";
-import * as THREE from "three";
-import * as FRAGS from "@thatopen/fragments";
-import { Component, Components, Event, Disposable, DataMap } from "../../core";
-import { RelationsMap } from "../../ifc/IfcRelationsIndexer/src/types";
-/**
- * Component to load, delete and manage [fragments](https://github.com/ThatOpen/engine_fragment) efficiently. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/FragmentsManager). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/FragmentsManager).
- */
-export declare class FragmentsManager 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: "fef46874-46a3-461b-8c44-2922ab77c806";
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<unknown>;
-    /**
-     * Event triggered when fragments are loaded.
-     */
-    readonly onFragmentsLoaded: Event<FragmentsGroup>;
-    /**
-     * Event triggered when fragments are disposed.
-     */
-    readonly onFragmentsDisposed: Event<{
-        groupID: string;
-        fragmentIDs: string[];
-    }>;
-    /**
-     * DataMap containing all loaded fragments.
-     * The key is the fragment's unique identifier, and the value is the fragment itself.
-     */
-    readonly list: DataMap<string, Fragment>;
-    /**
-     * DataMap containing all loaded fragment groups.
-     * The key is the group's unique identifier, and the value is the group itself.
-     */
-    readonly groups: DataMap<string, FragmentsGroup>;
-    baseCoordinationModel: string;
-    baseCoordinationMatrix: THREE.Matrix4;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    private _loader;
-    /**
-     * Getter for the meshes of all fragments in the FragmentsManager.
-     * It iterates over the fragments in the list and pushes their meshes into an array.
-     * @returns {THREE.Mesh[]} An array of THREE.Mesh objects representing the fragments.
-     */
-    get meshes(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[], THREE.Object3DEventMap>[];
-    constructor(components: Components);
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * Dispose of a specific fragment group.
-     * This method removes the group from the groups map, deletes all fragments within the group from the list,
-     * disposes of the group, and triggers the onFragmentsDisposed event.
-     *
-     * @param group - The fragment group to be disposed.
-     */
-    disposeGroup(group: FragmentsGroup): void;
-    /**
-     * Loads a binary file that contain fragment geometry.
-     * @param data - The binary data to load.
-     * @param config - Optional configuration for loading.
-     * @param config.isStreamed - Optional setting to determine whether this model is streamed or not.
-     * @param config.coordinate - Whether to apply coordinate transformation. Default is true.
-     * @param config.properties - Ifc properties to set on the loaded fragments. Not to be used when streaming.
-     * @returns The loaded FragmentsGroup.
-     */
-    load(data: Uint8Array, config?: Partial<{
-        coordinate: boolean;
-        name: string;
-        properties: FRAGS.IfcProperties;
-        relationsMap: RelationsMap;
-        isStreamed?: boolean;
-    }>): FragmentsGroup;
-    /**
-     * Export the specified fragmentsgroup to binary data.
-     * @param group - the fragments group to be exported.
-     * @returns the exported data as binary buffer.
-     */
-    export(group: FragmentsGroup): Uint8Array;
-    /**
-     * Gets a map of model IDs to sets of express IDs for the given fragment ID map.
-     * @param fragmentIdMap - A map of fragment IDs to their corresponding express IDs.
-     * @returns A map of model IDs to sets of express IDs.
-     */
-    getModelIdMap(fragmentIdMap: FRAGS.FragmentIdMap): {
-        [modelID: string]: Set<number>;
-    };
-    /**
-     * Converts a map of model IDs to sets of express IDs to a fragment ID map.
-     * @param modelIdMap - A map of model IDs to their corresponding express IDs.
-     * @returns A fragment ID map.
-     * @remarks
-     * This method iterates through the provided model ID map, retrieves the corresponding model from the `groups` map,
-     * and then calls the `getFragmentMap` method of the model to obtain a fragment ID map for the given express IDs.
-     * The fragment ID maps are then merged into a single map and returned.
-     * If a model with a given ID is not found in the `groups` map, the method skips that model and continues with the next one.
-     */
-    modelIdToFragmentIdMap(modelIdMap: {
-        [modelID: string]: Set<number>;
-    }): FRAGS.FragmentIdMap;
-    /**
-     * Converts a collection of IFC GUIDs to a fragmentIdMap.
-     *
-     * @param guids - An iterable collection of global IDs to be converted to a fragment ID map.
-     *
-     * @returns A fragment ID map, where the keys are fragment IDs and the values are the corresponding express IDs.
-     */
-    guidToFragmentIdMap(guids: Iterable<string>): FRAGS.FragmentIdMap;
-    /**
-     * Converts a fragment ID map to a collection of IFC GUIDs.
-     *
-     * @param fragmentIdMap - A fragment ID map to be converted to a collection of IFC GUIDs.
-     *
-     * @returns An array of IFC GUIDs.
-     */
-    fragmentIdMapToGuids(fragmentIdMap: FRAGS.FragmentIdMap): string[];
-    /**
-     * Applies coordinate transformation to the provided models.
-     * If no models are provided, all groups are used.
-     * The first model in the list becomes the base model for coordinate transformation.
-     * All other models are then transformed to match the base model's coordinate system.
-     *
-     * @param models - The models to apply coordinate transformation to.
-     * If not provided, all models are used.
-     */
-    coordinate(models?: FragmentsGroup[]): void;
-    /**
-     * Applies the base coordinate system to the provided object.
-     *
-     * This function takes an object and its original coordinate system as input.
-     * It then inverts the original coordinate system and applies the base coordinate system
-     * to the object. This ensures that the object's position, rotation, and scale are
-     * transformed to match the base coordinate system (which is taken from the first model loaded).
-     *
-     * @param object - The object to which the base coordinate system will be applied.
-     * This should be an instance of THREE.Object3D.
-     *
-     * @param originalCoordinateSystem - The original coordinate system of the object.
-     * This should be a THREE.Matrix4 representing the object's transformation matrix.
-     */
-    applyBaseCoordinateSystem(object: THREE.Object3D | THREE.Vector3, originalCoordinateSystem?: THREE.Matrix4): void;
-    /**
-     * Creates a copy of the whole model or a part of it.
-     *
-     * @param model - The model to clone.
-     * @param items - Optional - The part of the model to be cloned. If not given, the whole group is cloned.
-     *
-     */
-    clone(model: FRAGS.FragmentsGroup, items?: FRAGS.FragmentIdMap): FragmentsGroup;
-}

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

@@ -1,38 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { Components, Component } from "../../core";
-/**
- * A component that hides or isolates fragments within a 3D scene. It extends the base Component class and provides methods to control fragment visibility and isolation. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/Hider). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/Hider).
- */
-export declare class Hider extends Component {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "dd9ccf2d-8a21-4821-b7f6-2949add16a29";
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    constructor(components: Components);
-    /**
-     * Sets the visibility of fragments within the 3D scene.
-     * If no `items` parameter is provided, all fragments will be set to the specified visibility.
-     * If `items` is provided, only the specified fragments will be affected.
-     *
-     * @param visible - The visibility state to set for the fragments.
-     * @param items - An optional map of fragment IDs and their corresponding sub-fragment IDs to be affected.
-     * If not provided, all fragments will be affected.
-     *
-     * @returns {void}
-     */
-    set(visible: boolean, items?: FRAGS.FragmentIdMap): void;
-    /**
-     * Isolates fragments within the 3D scene by hiding all other fragments and showing only the specified ones.
-     * It calls the `set` method twice: first to hide all fragments, and then to show only the specified ones.
-     *
-     * @param items - A map of fragment IDs and their corresponding sub-fragment IDs to be isolated.
-     * If not provided, all fragments will be isolated.
-     *
-     * @returns {void}
-     */
-    isolate(items: FRAGS.FragmentIdMap): void;
-    private updateCulledVisibility;
-}

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

@@ -1,103 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import { Components, Disposable, Event, Component, AsyncEvent } from "../../core";
-import { IfcStreamingSettings, StreamedGeometries, StreamedAsset } from "./src";
-export * from "./src";
-/**
- * A component that handles the tiling of IFC geometries for efficient streaming. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcGeometryTiler). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcGeometryTiler).
- */
-export declare class IfcGeometryTiler 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: "d9999a00-e1f5-4d3f-8cfe-c56e08609764";
-    /**
-     * Event triggered when geometry is streamed.
-     * Contains the streamed geometry data and its buffer.
-     */
-    readonly onGeometryStreamed: AsyncEvent<{
-        buffer: Uint8Array;
-        data: StreamedGeometries;
-    }>;
-    /**
-     * Event triggered when assets are streamed.
-     * Contains the streamed assets.
-     */
-    readonly onAssetStreamed: AsyncEvent<StreamedAsset[]>;
-    /**
-     * Event triggered to indicate the progress of the streaming process.
-     * Contains the progress percentage.
-     */
-    readonly onProgress: AsyncEvent<number>;
-    /**
-     * Event triggered when the IFC file is loaded.
-     * Contains the loaded IFC file data.
-     */
-    readonly onIfcLoaded: AsyncEvent<Uint8Array>;
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<unknown>;
-    /**
-     * Settings for the IfcGeometryTiler.
-     */
-    settings: IfcStreamingSettings;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * The WebIFC API instance used for IFC file processing.
-     */
-    webIfc: WEBIFC.IfcAPI;
-    private _nextAvailableID;
-    private _splittedGeometries;
-    private _spatialTree;
-    private _metaData;
-    private _visitedGeometries;
-    private _streamSerializer;
-    private _geometries;
-    private _geometryCount;
-    private _civil;
-    private _groupSerializer;
-    private _assets;
-    private _meshesWithHoles;
-    constructor(components: Components);
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * This method streams the IFC file from a given buffer.
-     *
-     * @param data - The Uint8Array containing the IFC file data.
-     * @returns A Promise that resolves when the streaming process is complete.
-     *
-     * @remarks
-     * This method cleans up any resources after the streaming process is complete.
-     *
-     * @example
-     * ```typescript
-     * const ifcData = await fetch('path/to/ifc/file.ifc');
-     * const rawBuffer = await response.arrayBuffer();
-     * const ifcBuffer = new Uint8Array(rawBuffer);
-     * await ifcGeometryTiler.streamFromBuffer(ifcBuffer);
-     * ```
-     */
-    streamFromBuffer(data: Uint8Array): Promise<void>;
-    /**
-     * This method streams the IFC file from a given callback.
-     *
-     * @param loadCallback - The callback function that will be used to load the IFC file.
-     * @returns A Promise that resolves when the streaming process is complete.
-     *
-     * @remarks
-     * This method cleans up any resources after the streaming process is complete.
-     *
-     */
-    streamFromCallBack(loadCallback: WEBIFC.ModelLoadCallback): Promise<void>;
-    private readIfcFile;
-    private streamIfcFile;
-    private streamAllGeometries;
-    private cleanUp;
-    private getMesh;
-    private getGeometry;
-    private streamAssets;
-    private streamGeometries;
-    private outputGeometries;
-    private registerGeometryData;
-}

package/dist/fragments/IfcGeometryTiler/src/base-types.d.ts

@@ -1,29 +0,0 @@
-/**
- * A dictionary of geometries streamed from a server. Each geometry is identified by a unique number (id), and contains information about its bounding box, whether it has holes, and an optional file path for the geometry data.
- */
-export interface StreamedGeometries {
-    [id: number]: {
-        /** The bounding box of the geometry as a Float32Array. */
-        boundingBox: Float32Array;
-        /** A boolean indicating whether the geometry has holes. */
-        hasHoles: boolean;
-        /** An optional file path for the geometry data. */
-        geometryFile?: string;
-    };
-}
-/**
- * A streamed asset, which consists of multiple geometries. Each geometry in the asset is identified by a unique number (geometryID), and contains information about its transformation and color.
- */
-export interface StreamedAsset {
-    /** The unique identifier of the asset. */
-    id: number;
-    /** An array of geometries associated with the asset. */
-    geometries: {
-        /** The unique identifier of the geometry. */
-        geometryID: number;
-        /** The transformation matrix of the geometry as a number array. */
-        transformation: number[];
-        /** The color of the geometry as a number array. */
-        color: number[];
-    }[];
-}

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

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

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

@@ -1,20 +0,0 @@
-import { IfcFragmentSettings } from "../../IfcLoader/src";
-/**
- * Settings for streaming IFC geometry and assets. Extends {@link IfcFragmentSettings} to inherit common settings.
- */
-export declare class IfcStreamingSettings extends IfcFragmentSettings {
-    /**
-     * Minimum number of geometries to be streamed.
-     * Defaults to 10 geometries.
-     */
-    minGeometrySize: number;
-    /**
-     * Minimum amount of assets to be streamed.
-     * Defaults to 1000 assets.
-     */
-    minAssetsSize: number;
-    /**
-     * Maximum amount of triangles per fragment. Useful for controlling the maximum size of fragment files.
-     */
-    maxTriangles: number | null;
-}