@thatopen/components 2.4.0-alpha.9 → 2.4.1

package/dist/core/Components/index.d.ts

@@ -6,7 +6,7 @@ export declare class Components implements Disposable {
     /**
      * The version of the @thatopen/components library.
      */
-    static readonly release = "2.4.0-alpha.1";
+    static readonly release = "2.4.1";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

package/dist/core/ConfigManager/src/configurator.d.ts

@@ -1,11 +1,13 @@
-import { ControlsSchema, ControlEntry } from "../../Types";
+import { ControlsSchema } from "../../Types";
 import { Components } from "../../Components";
-export declare abstract class Configurator<T, U extends ControlsSchema> {
+export declare abstract class Configurator<T = any, U extends ControlsSchema = ControlsSchema> {
     protected abstract _config: U;
     protected _component: T;
     name: string;
     uuid: string;
     get controls(): U;
     constructor(component: T, components: Components, name: string, uuid?: string);
-    copyEntry(controlEntry: ControlEntry): ControlEntry;
+    set(data: Partial<U>): void;
+    export(controls?: ControlsSchema, exported?: any): any;
+    import(exported: any, imported?: any, first?: boolean): void;
 }

package/dist/core/ShadowedScene/index.d.ts

@@ -2,8 +2,7 @@ import { SimpleScene, SimpleSceneConfig, SimpleSceneConfigManager } from "../Wor
 import { DistanceRenderer } from "./src";
 import { Configurable, Disposable } from "../Types";
 /**
- * Configuration interface for the {@link ShadowedScene}. Defines properties for directional and ambient lights,
- * as well as shadows.
+ * Configuration interface for the {@link ShadowedScene}. Defines properties for directional and ambient lights, as well as shadows.
  */
 export interface ShadowedSceneConfig extends SimpleSceneConfig {
     shadows: {

package/dist/core/Types/src/component-with-ui.d.ts

@@ -1,11 +1,16 @@
 import { Component } from "./component";
+import { Configurator } from "../../ConfigManager";
+import { Components } from "../../Components";
 export type ComponentUIElement = {
     name: string;
+    id: string;
+    icon: string;
     componentID: string;
-    attributes: {
-        [name: string]: string;
+    get: (components: Components) => {
+        element: HTMLElement;
+        config?: Configurator;
+        dispose?: () => void;
     };
-    get: () => HTMLElement;
 };
 export declare abstract class ComponentWithUI extends Component {
     abstract name: string;

package/dist/core/Types/src/config-types.d.ts

@@ -40,3 +40,8 @@ export type ControlEntry = BooleanSettingsControl | ColorSettingsControl | TextS
 export interface ControlsSchema {
     [name: string]: ControlEntry | ControlsSchema;
 }
+export declare class ControlsUtils {
+    static isEntry(item: any): boolean;
+    static copySchema<T extends ControlsSchema = ControlsSchema>(schema: T, copy?: ControlsSchema): T;
+    static copyEntry(controlEntry: ControlEntry): ControlEntry;
+}

package/dist/core/Types/src/data-map.d.ts

@@ -39,7 +39,9 @@ export declare class DataMap<K, V> extends Map<K, V> {
      */
     clear(): void;
     /**
-     * Sets the value for the specified key in the map and triggers the appropriate event (onItemSet or onItemUpdated).
+     * Sets the value for the specified key in the map.
+     * If the item is new, then onItemSet is triggered.
+     * If the item is already in the map, then onItemUpdated is triggered.
      *
      * @param key - The key of the item to set.
      * @param value - The value of the item to set.

package/dist/core/Types/src/data-set.d.ts

@@ -1,7 +1,6 @@
 import { Event } from "./event";
 /**
- * A class that extends the built-in Set class and provides additional functionality.
- * It triggers events when items are added, deleted, or the set is cleared.
+ * A class that extends the built-in Set class and provides additional functionality. It triggers events when items are added, deleted, or the set is cleared.
  *
  * @template T - The type of elements in the set.
  */

package/dist/core/Viewpoints/src/viewpoint.d.ts

@@ -150,7 +150,7 @@ export declare class Viewpoint implements BCFViewpoint {
      *
      * @returns A Promise that resolves when the camera has been set.
      */
-    go(transition?: boolean): Promise<void>;
+    go(world?: World, transition?: boolean): Promise<void>;
     /**
      * Updates the camera settings of the viewpoint based on the current world's camera and renderer.
      *
@@ -162,7 +162,7 @@ export declare class Viewpoint implements BCFViewpoint {
      * @throws An error if the world's camera does not have camera controls.
      * @throws An error if the world's renderer is not available.
      */
-    updateCamera(): void;
+    updateCamera(world?: World): void;
     applyVisibility(): void;
     /**
      * Applies color to the components in the viewpoint based on their GUIDs.

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

@@ -21,6 +21,17 @@ export interface Classification {
         };
     };
 }
+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).
  */
@@ -143,6 +154,7 @@ export declare class Classifier extends Component implements Disposable {
     bySpatialStructure(model: FRAGS.FragmentsGroup, config?: {
         useProperties?: boolean;
         isolate?: Set<number>;
+        systemName?: string;
     }): Promise<void>;
     /**
      * Sets the color of the specified fragments.
@@ -174,11 +186,12 @@ export declare class Classifier extends Component implements Disposable {
      * Exports the computed classification to persists them and import them back
      * later for faster loading.
      */
-    export(): string;
+    export(): ExportedClassification;
     /**
      * Imports a classification previously exported with .export().
      * @param data the serialized classification to import.
      */
-    import(data: string): void;
+    import(data: ExportedClassification): void;
     protected saveItem(group: FRAGS.FragmentsGroup, systemName: string, className: string, expressID: number, parentID?: number | null): void;
 }
+export {};

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

@@ -98,5 +98,6 @@ export declare class IfcGeometryTiler extends Component implements Disposable {
     private getGeometry;
     private streamAssets;
     private streamGeometries;
+    private outputGeometries;
     private registerGeometryData;
 }

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

@@ -0,0 +1,24 @@
+import * as WEBIFC from "web-ifc";
+import { Component, Components } from "../../core";
+/**
+ * Component to isolate certain elements from an IFC and export to another IFC. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcIsolator). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcIsolator).
+ */
+export declare class IfcIsolator extends Component {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
+    static readonly uuid: "6eb0ba2f-71c0-464e-bcec-2d7c335186b2";
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    constructor(components: Components);
+    getIsolatedElements(webIfc: WEBIFC.IfcAPI, modelID: number, elementIDs: Array<number>): Promise<any[]>;
+    /**
+     * Exports isolated elements to the new model.
+     * @param webIfc The instance of [web-ifc](https://github.com/ThatOpen/engine_web-ifc) to use.
+     * @param modelID ID of the new IFC model.
+     * @param isolatedElements The array of isolated elements
+     */
+    export(webIfc: WEBIFC.IfcAPI, modelID: number, isolatedElements: Array<any>): Promise<Uint8Array>;
+    splitIfc(webIfc: WEBIFC.IfcAPI, ifcFile: ArrayBuffer, idsToExtract: Array<number>): Promise<Uint8Array>;
+}

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

@@ -138,7 +138,6 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      */
     newPset(model: FragmentsGroup, name: string, description?: string): Promise<{
         pset: WEBIFC.IFC4.IfcPropertySet | WEBIFC.IFC2X3.IfcPropertySet | WEBIFC.IFC4X3.IfcPropertySet;
-        rel: WEBIFC.IFC4X3.IfcRelDefinesByProperties | WEBIFC.IFC2X3.IfcRelDefinesByProperties | WEBIFC.IFC4.IfcRelDefinesByProperties;
     }>;
     /**
      * Removes a Property Set (Pset) from the given model.
@@ -278,8 +277,13 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
     setAttributeListener(model: FragmentsGroup, expressID: number, attributeName: string): Promise<Event<String | Number | Boolean>>;
     private getNewExpressID;
     private newGUID;
-    private getOwnerHistory;
-    private registerChange;
+    getOwnerHistory(model: FragmentsGroup): Promise<{
+        entity: {
+            [attribute: string]: any;
+        };
+        handle: WEBIFC.Handle<unknown>;
+    }>;
+    registerChange(model: FragmentsGroup, ...expressID: number[]): void;
     private newSingleProperty;
 }
 export * from "./src";

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

@@ -1,7 +1,7 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Disposable, Event, Component, Components } from "../../core";
-import { RelationsMap, ModelsRelationMap, InverseAttribute, IfcRelation } from "./src";
+import { RelationsMap, ModelsRelationMap, InverseAttribute, IfcRelation, RelationsProcessingConfig, EntitiesRelatedEvent } from "./src";
 /**
  * Indexer component for IFC entities, facilitating the indexing and retrieval of IFC entity relationships. It is designed to process models properties by indexing their IFC entities' relations based on predefined inverse attributes, and provides methods to query these relations. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcRelationsIndexer). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcRelationsIndexer).
  */
@@ -42,7 +42,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     constructor(components: Components);
     private onFragmentsDisposed;
     private indexRelations;
-    getAttributeIndex(inverseAttribute: InverseAttribute): number | null;
+    getAttributeIndex(inverseAttribute: InverseAttribute): number;
     /**
      * Adds a relation map to the model's relations map.
      *
@@ -68,7 +68,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * representation of the relations indexed by entity expressIDs and relation types.
      * @throws An error if the model does not have properties loaded.
      */
-    process(model: FragmentsGroup): Promise<RelationsMap>;
+    process(model: FragmentsGroup, config?: Partial<RelationsProcessingConfig>): Promise<RelationsMap>;
     /**
      * Processes a given model from a WebIfc API to index its IFC entities relations.
      *
@@ -85,11 +85,10 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      *
      * @param model The `FragmentsGroup` model containing the entity, or its UUID.
      * @param expressID The unique identifier of the entity within the model.
-     * @param relationName The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
-     * @returns An array of express IDs representing the related entities, or `null` if no relations are found
-     * or the specified relation name is not indexed.
+     * @param attribute The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
+     * @returns An array of express IDs representing the related entities. If the array is empty, no relations were found.
      */
-    getEntityRelations(model: FragmentsGroup | string, expressID: number, relationName: InverseAttribute): number[] | null;
+    getEntityRelations(model: FragmentsGroup | string | RelationsMap, expressID: number, attribute: InverseAttribute): number[];
     /**
      * Serializes the relations of a given relation map into a JSON string.
      * This method iterates through the relations in the given map, organizing them into a structured object where each key is an expressID of an entity,
@@ -166,7 +165,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * Converts the relations made into actual IFC data.
      *
      * @remarks This function iterates through the changes made to the relations and applies them to the corresponding BIM model.
-     * It only make sense to use if the relations need to be write in the IFC file.
+     * It only make sense to use it if the relations need to be write in the IFC file.
      *
      * @returns A promise that resolves when all the relation changes have been applied.
      */
@@ -177,16 +176,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * The event provides information about the type of relation, the inverse attribute,
      * the IDs of the entities related, and the IDs of the entities that are being related.
      */
-    readonly onEntitiesRelated: Event<{
-        /** The type of the IFC relation. */
-        relType: IfcRelation;
-        /** The inverse attribute of the relation. */
-        invAttribute: InverseAttribute;
-        /** The IDs of the entities that are relating. */
-        relatingIDs: number[];
-        /** The IDs of the entities that are being related. */
-        relatedIDs: number[];
-    }>;
+    readonly onEntitiesRelated: Event<EntitiesRelatedEvent>;
     addEntitiesRelation(model: FragmentsGroup, relatingID: number, rel: {
         type: IfcRelation;
         inv: InverseAttribute;

package/dist/ifc/IfcRelationsIndexer/src/newVersion.d.ts

@@ -0,0 +1,51 @@
+declare const actual: {
+    186: {
+        7: number[];
+    };
+    250: {
+        8: number[];
+    };
+    253: {
+        8: number[];
+    };
+    257: {
+        8: number[];
+    };
+};
+declare const newVersion: {
+    186: {
+        7: ({
+            259: number[];
+            263?: undefined;
+            266?: undefined;
+        } | {
+            263: number[];
+            259?: undefined;
+            266?: undefined;
+        } | {
+            266: number[];
+            259?: undefined;
+            263?: undefined;
+        })[];
+    };
+    190: {
+        7: {
+            259: number[];
+        }[];
+    };
+    250: {
+        8: {
+            259: number[];
+        }[];
+    };
+};
+interface V2Schema {
+    [expressID: number]: {
+        [invAttrIndex: number]: {
+            [IfcRelationship: number]: number[];
+        };
+    };
+}
+type RelationsMap = Map<number, Map<number, {
+    [ifcRel: number]: number[];
+}>>;

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

@@ -55,3 +55,19 @@ export type IfcRelations = [
     typeof WEBIFC.IFCRELASSOCIATESDOCUMENT
 ];
 export type IfcRelation = IfcRelations[number];
+export interface RelationsProcessingConfig {
+    relationsToProcess: IfcRelation[];
+}
+/**
+ * Interface definition of an Entities Related Event from the IfcRelationsIndexer. This event gets triggered when two or more entities has been related with each other.
+ */
+export interface EntitiesRelatedEvent {
+    /** The type of the IFC relation. */
+    relType: IfcRelation;
+    /** The inverse attribute of the relation. */
+    invAttribute: InverseAttribute;
+    /** The IDs of the entities that are relating. */
+    relatingIDs: number[];
+    /** The IDs of the entities that are being related. */
+    relatedIDs: number[];
+}

package/dist/ifc/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./IfcJsonExporter";
+export * from "./IfcIsolator";
 export * from "./IfcRelationsIndexer";
 export * from "./IfcPropertiesManager";
 export * from "./Utils";