@thatopen/components 2.2.0-alpha.0 → 2.2.0-alpha.1

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

@@ -23,7 +23,7 @@ export declare class DataMap<K, V> extends Map<K, V> {
     /**
      * An event triggered when an item is deleted from the map.
      */
-    readonly onItemDeleted: Event<unknown>;
+    readonly onItemDeleted: Event<K>;
     /**
      * An event triggered when the map is cleared.
      */
@@ -46,6 +46,17 @@ export declare class DataMap<K, V> extends Map<K, V> {
      * @returns The DataMap instance.
      */
     set(key: K, value: V): this;
+    /**
+     * A function that acts as a guard for adding items to the set.
+     * It determines whether a given value should be allowed to be added to the set.
+     *
+     * @param key - The key of the entry to be checked against the guard.
+     * @param value - The value of the entry to be checked against the guard.
+     * @returns A boolean indicating whether the value should be allowed to be added to the set.
+     *          By default, this function always returns true, allowing all values to be added.
+     *          You can override this behavior by providing a custom implementation.
+     */
+    guard: (key: K, value: V) => boolean;
     /**
      * Deletes the specified key from the map and triggers the onItemDeleted event if the key was found.
      *

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

@@ -29,12 +29,22 @@ export declare class DataSet<T> extends Set<T> {
      */
     clear(): void;
     /**
-     * Adds a value to the set and triggers the onItemAdded event.
+     * Adds one or multiple values to the set and triggers the onItemAdded event per each.
      *
      * @param value - The value to add to the set.
      * @returns - The set instance.
      */
-    add(value: T): this;
+    add(...value: T[]): this;
+    /**
+     * A function that acts as a guard for adding items to the set.
+     * It determines whether a given value should be allowed to be added to the set.
+     *
+     * @param value - The value to be checked against the guard.
+     * @returns A boolean indicating whether the value should be allowed to be added to the set.
+     *          By default, this function always returns true, allowing all values to be added.
+     *          You can override this behavior by providing a custom implementation.
+     */
+    guard: (value: T) => boolean;
     /**
      * Deletes a value from the set and triggers the onItemDeleted event.
      *

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

@@ -1,12 +1,26 @@
-import { World, Component, Disposable, Event, DataMap } from "../Types";
+import { World, Component, Disposable, Event, DataMap, Configurable } from "../Types";
 import { Components } from "../Components";
 import { BCFViewpoint, Viewpoint } from "./src";
-export declare class Viewpoints extends Component implements Disposable {
+/**
+ * Configuration interface for the Viewpoints general behavior.
+ */
+interface ViewpointsConfig {
+    /**
+     * Indicates whether to overwrite the fragments colors when applying viewpoints.
+     * @default false
+     */
+    overwriteColors: boolean;
+}
+export declare class Viewpoints extends Component implements Disposable, Configurable<ViewpointsConfig> {
     static readonly uuid: "ee867824-a796-408d-8aa0-4e5962a83c66";
     enabled: boolean;
     readonly list: DataMap<string, Viewpoint>;
     create(world: World, data?: Partial<BCFViewpoint>): Viewpoint;
     constructor(components: Components);
+    isSetup: boolean;
+    setup(): void;
+    onSetup: Event<unknown>;
+    config: Required<ViewpointsConfig>;
     readonly onDisposed: Event<unknown>;
     dispose(): void;
 }

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

@@ -3,15 +3,16 @@ import * as FRAGS from "@thatopen/fragments";
 import { BCFViewpoint, ViewpointOrthographicCamera, ViewpointPerspectiveCamera } from "./types";
 import { CameraProjection } from "../../OrthoPerspectiveCamera";
 import { Components } from "../../Components";
-import { DataSet, World } from "../../Types";
+import { DataMap, DataSet, World } from "../../Types";
 import { SimplePlane } from "../../Clipper";
 export declare class Viewpoint implements BCFViewpoint {
-    name: string;
+    title?: string;
     guid: string;
     clippingPlanes: DataSet<SimplePlane>;
     camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera;
     readonly exceptionComponents: DataSet<string>;
     readonly selectionComponents: DataSet<string>;
+    readonly componentColors: DataMap<string, string[]>;
     spacesVisible: boolean;
     spaceBoundariesVisible: boolean;
     openingsVisible: boolean;
@@ -27,11 +28,16 @@ export declare class Viewpoint implements BCFViewpoint {
     readonly world: World;
     private get _managerVersion();
     get topics(): import("../../../openbim/BCFTopics").Topic[];
-    constructor(components: Components, world: World);
+    constructor(components: Components, world: World, _config?: {
+        data?: Partial<BCFViewpoint>;
+        setCamera?: boolean;
+    });
     addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap): Promise<void>;
-    set(data: Partial<BCFViewpoint>): void;
+    set(data: Partial<BCFViewpoint>): this;
     go(transition?: boolean): Promise<void>;
     updateCamera(): void;
+    colorize(): void;
+    resetColors(): void;
     private createComponentTags;
     serialize(version?: import("../../../openbim/BCFTopics").BCFVersion): Promise<string>;
 }

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

@@ -20,7 +20,7 @@ export interface ViewpointOrthographicCamera extends ViewpointCamera {
     viewToWorldScale: number;
 }
 export interface BCFViewpoint {
-    name: string;
+    title?: string;
     guid: string;
     camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera;
     selectionComponents: Iterable<string>;