@thatopen/components 2.2.9 → 2.2.11

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

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

@@ -34,6 +34,7 @@ export declare class Viewpoints extends Component implements Disposable, Configu
     setup(): void;
     onSetup: Event<unknown>;
     config: Required<ViewpointsConfig>;
+    /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<unknown>;
     /**
      * Disposes of the Viewpoints component and its associated resources.

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

@@ -5,13 +5,21 @@ import { CameraProjection } from "../../OrthoPerspectiveCamera";
 import { Components } from "../../Components";
 import { DataMap, DataSet, World } from "../../Types";
 import { SimplePlane } from "../../Clipper";
+/**
+ * Represents a BCF compliant viewpoint from BuildingSMART.
+ *
+ * The Viewpoint class provides methods for managing and interacting with viewpoints.
+ * It includes functionality for setting viewpoint properties, updating the camera,
+ * applying color to components, and serializing the viewpoint for export.
+ */
 export declare class Viewpoint implements BCFViewpoint {
     title?: string;
-    guid: string;
+    readonly guid: string;
     /**
      * ClippingPlanes can be used to define a subsection of a building model that is related to the topic.
      * Each clipping plane is defined by Location and Direction.
      * The Direction vector points in the invisible direction meaning the half-space that is clipped.
+     * @experimental
      */
     clippingPlanes: DataSet<SimplePlane>;
     camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera;
@@ -114,14 +122,13 @@ export declare class Viewpoint implements BCFViewpoint {
      * Adds components to the viewpoint based on the provided fragment ID map.
      *
      * @param fragmentIdMap - A map containing fragment IDs as keys and arrays of express IDs as values.
-     *
-     * @returns A Promise that resolves when the components have been added to the viewpoint.
      */
-    addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap): Promise<void>;
+    addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap): void;
     /**
-     * Sets the properties of the viewpoint with the provided data.
+     * Replace the properties of the viewpoint with the provided data.
      *
      * @remarks The guid will be ommited as it shouldn't change after it has been initially set.
+     * @remarks The existing selection and exception components will be fully replaced in case new ones are provided.
      *
      * @param data - An object containing the properties to be set.
      *               The properties not included in the object will remain unchanged.

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

@@ -19,6 +19,9 @@ export interface ViewpointPerspectiveCamera extends ViewpointCamera {
 export interface ViewpointOrthographicCamera extends ViewpointCamera {
     viewToWorldScale: number;
 }
+/**
+ * Represents a viewpoint in a BCF file.
+ */
 export interface BCFViewpoint {
     title?: string;
     guid: string;

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

@@ -1,4 +1,4 @@
-import { Component, Disposable, Updateable, World, Event, BaseScene, BaseCamera, BaseRenderer } from "../Types";
+import { Component, Disposable, Updateable, World, Event, BaseScene, BaseCamera, BaseRenderer, DataMap } from "../Types";
 import { Components } from "../Components";
 import { SimpleWorld } from "./src";
 export * from "./src";
@@ -17,21 +17,11 @@ export declare class Worlds extends Component implements Updateable, Disposable
     readonly onBeforeUpdate: Event<unknown>;
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<unknown>;
-    /**
-     * An event that is triggered when a new world is created.
-     * The event passes the newly created world as a parameter.
-     */
-    readonly onWorldCreated: Event<World>;
-    /**
-     * An event that is triggered when a world is deleted.
-     * The event passes the UUID of the deleted world as a parameter.
-     */
-    readonly onWorldDeleted: Event<string>;
     /**
      * A collection of worlds managed by this component.
      * The key is the unique identifier (UUID) of the world, and the value is the World instance.
      */
-    list: Map<string, World>;
+    list: DataMap<string, World>;
     /** {@link Component.enabled} */
     enabled: boolean;
     constructor(components: Components);
@@ -51,16 +41,12 @@ export declare class Worlds extends Component implements Updateable, Disposable
      * @param {World} world - The world to be deleted.
      *
      * @throws {Error} - Throws an error if the provided world is not found in the list.
-     *
-     * @returns {void}
      */
     delete(world: World): void;
     /**
      * Disposes of the Worlds component and all its managed worlds.
      * This method sets the enabled flag to false, disposes of all worlds, clears the list,
      * and triggers the onDisposed event.
-     *
-     * @returns {void}
      */
     dispose(): void;
     /** {@link Updateable.update} */

package/dist/core/Worlds/src/simple-world.d.ts

@@ -28,9 +28,9 @@ export declare class SimpleWorld<T extends BaseScene = BaseScene, U extends Base
      */
     enabled: boolean;
     /**
-     * A unique identifier for the world.
+     * A unique identifier for the world. Is not meant to be changed at any moment.
      */
-    uuid: string;
+    readonly uuid: string;
     /**
      * An optional name for the world.
      */

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

@@ -108,6 +108,14 @@ export declare class FragmentsManager extends Component implements Disposable {
      * @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.

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

@@ -76,7 +76,7 @@ export declare class IfcLoader extends Component implements Disposable {
      * const group = await ifcLoader.load(ifcData);
      * ```
      */
-    load(data: Uint8Array, coordinate?: boolean): Promise<FRAGS.FragmentsGroup>;
+    load(data: Uint8Array, coordinate?: boolean, name?: string): Promise<FRAGS.FragmentsGroup>;
     /**
      * Reads an IFC file and initializes the Web-IFC library.
      *