@thatopen/components 2.1.16 → 2.1.17

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

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

@@ -1,18 +1,60 @@
 import { Event } from "./event";
+/**
+ * A class that extends the built-in Map class and provides additional events for item set, update, delete, and clear operations.
+ *
+ * @template K - The type of keys in the map.
+ * @template V - The type of values in the map.
+ */
 export declare class DataMap<K, V> extends Map<K, V> {
+    /**
+     * An event triggered when a new item is set in the map.
+     */
     readonly onItemSet: Event<{
         key: K;
         value: V;
     }>;
+    /**
+     * An event triggered when an existing item in the map is updated.
+     */
     readonly onItemUpdated: Event<{
         key: K;
         value: V;
     }>;
+    /**
+     * An event triggered when an item is deleted from the map.
+     */
     readonly onItemDeleted: Event<unknown>;
+    /**
+     * An event triggered when the map is cleared.
+     */
     readonly onCleared: Event<unknown>;
+    /**
+     * Constructs a new DataMap instance.
+     *
+     * @param iterable - An iterable object containing key-value pairs to populate the map.
+     */
     constructor(iterable?: Iterable<readonly [K, V]> | null | undefined);
+    /**
+     * Clears the map and triggers the onCleared event.
+     */
     clear(): void;
+    /**
+     * Sets the value for the specified key in the map and triggers the appropriate event (onItemSet or onItemUpdated).
+     *
+     * @param key - The key of the item to set.
+     * @param value - The value of the item to set.
+     * @returns The DataMap instance.
+     */
     set(key: K, value: V): this;
+    /**
+     * Deletes the specified key from the map and triggers the onItemDeleted event if the key was found.
+     *
+     * @param key - The key of the item to delete.
+     * @returns True if the key was found and deleted; otherwise, false.
+     */
     delete(key: K): boolean;
+    /**
+     * Clears the map and resets the events.
+     */
     dispose(): void;
 }

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

@@ -1,11 +1,49 @@
 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.
+ *
+ * @template T - The type of elements in the set.
+ */
 export declare class DataSet<T> extends Set<T> {
+    /**
+     * An event that is triggered when a new item is added to the set.
+     */
     readonly onItemAdded: Event<T>;
+    /**
+     * An event that is triggered when an item is deleted from the set.
+     */
     readonly onItemDeleted: Event<unknown>;
+    /**
+     * An event that is triggered when the set is cleared.
+     */
     readonly onCleared: Event<unknown>;
+    /**
+     * Constructs a new instance of the DataSet class.
+     *
+     * @param iterable - An optional iterable object to initialize the set with.
+     */
     constructor(iterable?: Iterable<T> | null);
+    /**
+     * Clears the set and triggers the onCleared event.
+     */
     clear(): void;
+    /**
+     * Adds a value to the set and triggers the onItemAdded event.
+     *
+     * @param value - The value to add to the set.
+     * @returns - The set instance.
+     */
     add(value: T): this;
+    /**
+     * Deletes a value from the set and triggers the onItemDeleted event.
+     *
+     * @param value - The value to delete from the set.
+     * @returns - True if the value was successfully deleted, false otherwise.
+     */
     delete(value: T): boolean;
+    /**
+     * Clears the set and resets the onItemAdded, onItemDeleted, and onCleared events.
+     */
     dispose(): void;
 }

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

@@ -1,7 +1,7 @@
 import { Fragment, FragmentsGroup } from "@thatopen/fragments";
 import * as THREE from "three";
 import * as FRAGS from "@thatopen/fragments";
-import { Component, Components, Event, Disposable } from "../../core";
+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).
@@ -26,15 +26,15 @@ export declare class FragmentsManager extends Component implements Disposable {
         fragmentIDs: string[];
     }>;
     /**
-     * Map containing all loaded fragments.
+     * DataMap containing all loaded fragments.
      * The key is the fragment's unique identifier, and the value is the fragment itself.
      */
-    readonly list: Map<string, Fragment>;
+    readonly list: DataMap<string, Fragment>;
     /**
-     * Map containing all loaded fragment groups.
+     * DataMap containing all loaded fragment groups.
      * The key is the group's unique identifier, and the value is the group itself.
      */
-    readonly groups: Map<string, FragmentsGroup>;
+    readonly groups: DataMap<string, FragmentsGroup>;
     baseCoordinationModel: string;
     baseCoordinationMatrix: THREE.Matrix4;
     /** {@link Component.enabled} */
@@ -125,4 +125,12 @@ export declare class FragmentsManager extends Component implements Disposable {
      * 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;
 }