@thatopen/components 2.1.1 → 2.1.3

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

@@ -94,7 +94,7 @@ export declare class Clipper extends Component implements Createable, Disposable
     /** {@link Disposable.dispose} */
     dispose(): void;
     /** {@link Createable.create} */
-    create(world: World): void;
+    create(world: World): SimplePlane | null;
     /**
      * Creates a plane in a certain place and with a certain orientation,
      * without the need of the mouse.
@@ -113,8 +113,12 @@ export declare class Clipper extends Component implements Createable, Disposable
      * found under the cursor will be deleted.
      */
     delete(world: World, plane?: SimplePlane): void;
-    /** Deletes all the existing clipping planes. */
-    deleteAll(): void;
+    /**
+     * Deletes all the existing clipping planes.
+     *
+     * @param types - the types of planes to be deleted. If not provided, all planes will be deleted.
+     */
+    deleteAll(types?: Set<string>): void;
     private deletePlane;
     private pickPlane;
     private getAllPlaneMeshes;

package/dist/core/Clipper/src/simple-plane.d.ts

@@ -27,6 +27,8 @@ export declare class SimplePlane implements Disposable, Hideable {
     components: Components;
     /** The world instance to which this plane belongs. */
     world: World;
+    /** A custom string to identify what this plane is used for. */
+    type: string;
     protected readonly _helper: THREE.Object3D;
     protected _visible: boolean;
     protected _enabled: boolean;

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.1.1";
+    static readonly release = "2.1.3";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

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

@@ -2,7 +2,7 @@ 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 to their respective express IDs.
+ * 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 {
     /**
@@ -12,9 +12,13 @@ export interface Classification {
     [system: string]: {
         /**
          * A class within the system.
-         * The key is the class name, and the value is a map of fragment IDs to their respective express IDs.
+         * The key is the class name, and the value is an object containing a map of fragment IDs with extra information.
          */
-        [className: string]: FRAGS.FragmentIdMap;
+        [className: string]: {
+            map: FRAGS.FragmentIdMap;
+            name: string;
+            id: number | null;
+        };
     };
 }
 /**
@@ -124,6 +128,7 @@ export declare class Classifier extends Component implements Disposable {
      * 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" (if false, the classification will use the expressIDs instead of the names)
      *
      * @remarks
      * This method iterates through the relations of the fragments in the provided group,
@@ -133,7 +138,9 @@ export declare class Classifier extends Component implements Disposable {
      *
      * @throws Will throw an error if the fragment ID is not found or if the model relations do not exist.
      */
-    bySpatialStructure(model: FRAGS.FragmentsGroup): Promise<void>;
+    bySpatialStructure(model: FRAGS.FragmentsGroup, config?: {
+        useProperties: boolean;
+    }): Promise<void>;
     /**
      * Sets the color of the specified fragments.
      *
@@ -160,5 +167,5 @@ export declare class Classifier extends Component implements Disposable {
      * @throws Will throw an error if the fragment with the specified ID is not found.
      */
     resetColor(items: FRAGS.FragmentIdMap): void;
-    protected saveItem(group: FRAGS.FragmentsGroup, systemName: string, className: string, expressID: number): void;
+    protected saveItem(group: FRAGS.FragmentsGroup, systemName: string, className: string, expressID: number, parentID?: number | null): void;
 }

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

@@ -138,4 +138,14 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     getRelationsMapFromJSON(json: string): RelationsMap;
     /** {@link Disposable.dispose} */
     dispose(): void;
+    /**
+     * Gets the children of the given element recursively. E.g. in a model with project - site - building - storeys - rooms, passing a storey will include all its children and the children of the rooms contained in it.
+     *
+     * @param model The BIM model whose children to get.
+     * @param id The expressID of the item whose children to get.
+     * @param found An optional parameter that includes a set of expressIDs where the found element IDs will be added.
+     *
+     * @returns A `Set` with the expressIDs of the found items.
+     */
+    getElementsChildren(model: FragmentsGroup, id: number, found?: Set<number>): Set<number>;
 }