@thatopen/components 2.2.9 → 2.3.0-alpha.2

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.3.0-alpha.1";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

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

@@ -1,6 +1,6 @@
-import { SimpleScene, SimpleSceneConfig } from "../Worlds";
+import { SimpleScene, SimpleSceneConfig, SimpleSceneConfigManager } from "../Worlds";
 import { DistanceRenderer } from "./src";
-import { Disposable } from "../Types";
+import { Configurable, Disposable } from "../Types";
 /**
  * Configuration interface for the {@link ShadowedScene}. Defines properties for directional and ambient lights,
  * as well as shadows.
@@ -14,17 +14,16 @@ export interface ShadowedSceneConfig extends SimpleSceneConfig {
 /**
  * A scene that supports efficient cast shadows. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/ShadowedScene). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/ShadowedScene).
  */
-export declare class ShadowedScene extends SimpleScene implements Disposable {
+export declare class ShadowedScene extends SimpleScene implements Disposable, Configurable<SimpleSceneConfigManager, ShadowedSceneConfig> {
     private _distanceRenderer?;
     /**
      * Whether the bias property should be set automatically depending on the shadow distance.
      */
     autoBias: boolean;
-    /**
-     * Configuration interface for the {@link ShadowedScene}.
-     * Defines properties for directional and ambient lights, as well as shadows.
-     */
-    config: Required<ShadowedSceneConfig>;
+    protected _defaultShadowConfig: {
+        cascade: number;
+        resolution: number;
+    };
     private _lightsWithShadow;
     private _isComputingShadows;
     private _shadowsEnabled;

package/dist/core/Types/src/base-scene.d.ts

@@ -21,4 +21,5 @@ export declare abstract class BaseScene extends BaseWorldItem implements Disposa
     protected constructor(components: Components);
     /** {@link Disposable.dispose} */
     dispose(): void;
+    deleteAllLights(): void;
 }

package/dist/core/Types/src/base.d.ts

@@ -15,5 +15,5 @@ export declare abstract class Base {
     /** Whether is component is {@link Hideable}. */
     isHideable: () => this is Hideable;
     /** Whether is component is {@link Configurable}. */
-    isConfigurable: () => this is Configurable<any>;
+    isConfigurable: () => this is Configurable<any, any>;
 }

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

@@ -0,0 +1,13 @@
+import { Component } from "./component";
+export type ComponentUIElement = {
+    name: string;
+    componentID: string;
+    attributes: {
+        [name: string]: string;
+    };
+    get: () => HTMLElement;
+};
+export declare abstract class ComponentWithUI extends Component {
+    abstract name: string;
+    abstract getUI(): ComponentUIElement[];
+}

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

@@ -0,0 +1,50 @@
+import * as THREE from "three";
+export interface BooleanSettingsControl {
+    type: "Boolean";
+    value: boolean;
+}
+export interface ColorSettingsControl {
+    type: "Color";
+    opacity: number;
+    value: THREE.Color;
+}
+export interface TextSettingsControl {
+    type: "Text";
+    value: string;
+}
+export interface NumberSettingControl {
+    type: "Number";
+    interpolable: boolean;
+    min?: number;
+    max?: number;
+    value: number;
+}
+export interface SelectSettingControl {
+    type: "Select";
+    options: Set<string>;
+    value: string;
+}
+export interface MultiSelectSettingControl {
+    type: "MultiSelect";
+    options: Set<string>;
+    value: Set<string>;
+}
+export interface Vector3SettingControl {
+    type: "Vector";
+    value: THREE.Vector3;
+}
+export interface TextSetSettingControl {
+    type: "TextSet";
+    value: Set<string>;
+}
+type ControlEntry = BooleanSettingsControl | ColorSettingsControl | TextSettingsControl | NumberSettingControl | SelectSettingControl | Vector3SettingControl | TextSetSettingControl | MultiSelectSettingControl;
+interface ControlsSchema {
+    [name: string]: ControlEntry | ControlsSchema;
+}
+export declare abstract class ConfigManager<T, U extends ControlsSchema> {
+    protected abstract _list: U;
+    protected _component: T;
+    get controls(): any;
+    constructor(component: T);
+}
+export {};

package/dist/core/Types/src/index.d.ts

@@ -10,3 +10,5 @@ export * from "./base-scene";
 export * from "./world";
 export * from "./data-set";
 export * from "./data-map";
+export * from "./component-with-ui";
+export * from "./config-manager";

package/dist/core/Types/src/interfaces.d.ts

@@ -84,15 +84,14 @@ export interface Createable {
 /**
  * Whether this component supports to be configured.
  */
-export interface Configurable<T extends Record<string, any>> {
+export interface Configurable<T, U> {
     /** Wether this components has been already configured. */
     isSetup: boolean;
-    /** Use the provided configuration to setup the tool. */
-    setup: (config?: Partial<T>) => void | Promise<void>;
+    /** Use the provided configuration to set up the tool. */
+    setup: (config?: Partial<U>) => void | Promise<void>;
     /** Fired after successfully calling {@link Configurable.setup()}  */
     readonly onSetup: Event<any>;
-    /** Object holding the tool configuration. Is not meant to be edited directly, if you need
-     * to make changes to this object, use {@link Configurable.setup()} just after the tool is instantiated.
+    /** Object holding the tool configuration. You can edit this directly to change the object.
      */
     config: Required<T>;
 }

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

@@ -1,18 +1,9 @@
 import { World, Component, Disposable, Event, DataMap, Configurable } from "../Types";
 import { Components } from "../Components";
 import { BCFViewpoint, Viewpoint } from "./src";
-/**
- * Configuration interface for the Viewpoints general behavior.
- */
-interface ViewpointsConfig {
-    /**
-     * Indicates whether to overwrite the fragments colors when applying viewpoints.
-     * @remarks BCF Viewpoints comes with information to indicate the colors to be applied to components, if any.
-     * @default false
-     */
-    overwriteColors: boolean;
-}
-export declare class Viewpoints extends Component implements Disposable, Configurable<ViewpointsConfig> {
+import { ViewpointsConfigManger, ViewpointsConfig } from "./src/viewpoints-config";
+export * from "./src";
+export declare class Viewpoints extends Component implements Disposable, Configurable<ViewpointsConfigManger, ViewpointsConfig> {
     static readonly uuid: "ee867824-a796-408d-8aa0-4e5962a83c66";
     enabled: boolean;
     /**
@@ -33,7 +24,7 @@ export declare class Viewpoints extends Component implements Disposable, Configu
     isSetup: boolean;
     setup(): void;
     onSetup: Event<unknown>;
-    config: Required<ViewpointsConfig>;
+    config: ViewpointsConfigManger;
     readonly onDisposed: Event<unknown>;
     /**
      * Disposes of the Viewpoints component and its associated resources.
@@ -44,4 +35,3 @@ export declare class Viewpoints extends Component implements Disposable, Configu
      */
     dispose(): void;
 }
-export * from "./src";

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

@@ -1,2 +1,2 @@
 export * from "./types";
-export * from "./Viewpoint";
+export * from "./viewpoint";

package/dist/core/Viewpoints/src/{Viewpoint.d.ts → viewpoint.d.ts}

@@ -186,5 +186,5 @@ 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.
      */
-    serialize(version?: import("../../../openbim/BCFTopics").BCFVersion): Promise<string>;
+    serialize(version?: string): Promise<string>;
 }

package/dist/core/Viewpoints/src/viewpoints-config.d.ts

@@ -0,0 +1,28 @@
+import { BooleanSettingsControl, ConfigManager } from "../../Types";
+import { Viewpoints } from "../index";
+/**
+ * Configuration interface for the Viewpoints general behavior.
+ */
+export interface ViewpointsConfig {
+    /**
+     * Indicates whether to overwrite the fragments colors when applying viewpoints.
+     * @remarks BCF Viewpoints comes with information to indicate the colors to be applied to components, if any.
+     * @default false
+     */
+    overwriteColors: boolean;
+}
+type ViewpointsConfigType = {
+    overwriteColors: BooleanSettingsControl;
+};
+export declare class ViewpointsConfigManger extends ConfigManager<Viewpoints, ViewpointsConfigType> {
+    protected _list: {
+        overwriteColors: {
+            value: boolean;
+            opacity: number;
+            type: "Boolean";
+        };
+    };
+    get overwriteColors(): boolean;
+    set overwriteColors(value: boolean);
+}
+export {};

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

@@ -2,3 +2,4 @@ export * from "./simple-world";
 export * from "./simple-scene";
 export * from "./simple-renderer";
 export * from "./simple-camera";
+export * from "./simple-scene-config";

package/dist/core/Worlds/src/simple-scene-config.d.ts

@@ -0,0 +1,92 @@
+import * as THREE from "three";
+import { SimpleScene } from "./simple-scene";
+import { ColorSettingsControl, ConfigManager, NumberSettingControl, Vector3SettingControl } from "../../Types";
+type SimpleSceneConfigType = {
+    backgroundColor: ColorSettingsControl;
+    ambientLight: {
+        color: ColorSettingsControl;
+        intensity: NumberSettingControl;
+    };
+    directionalLight: {
+        color: ColorSettingsControl;
+        intensity: NumberSettingControl;
+        position: Vector3SettingControl;
+    };
+};
+declare class DirectionalLightConfig {
+    private _list;
+    private _scene;
+    constructor(list: SimpleSceneConfigType, scene: SimpleScene);
+    get color(): THREE.Color;
+    set color(value: THREE.Color);
+    get intensity(): number;
+    set intensity(value: number);
+    get position(): THREE.Vector3;
+    set position(value: THREE.Vector3);
+}
+declare class AmbientLightConfig {
+    private _list;
+    private _scene;
+    constructor(list: SimpleSceneConfigType, scene: SimpleScene);
+    get color(): THREE.Color;
+    set color(value: THREE.Color);
+    get intensity(): number;
+    set intensity(value: number);
+}
+/**
+ * Configuration interface for the {@link SimpleScene}.
+ */
+export interface SimpleSceneConfig {
+    backgroundColor: THREE.Color;
+    directionalLight: {
+        color: THREE.Color;
+        intensity: number;
+        position: THREE.Vector3;
+    };
+    ambientLight: {
+        color: THREE.Color;
+        intensity: number;
+    };
+}
+export declare class SimpleSceneConfigManager extends ConfigManager<SimpleScene, SimpleSceneConfigType> {
+    protected _list: {
+        backgroundColor: {
+            value: THREE.Color;
+            opacity: number;
+            type: "Color";
+        };
+        ambientLight: {
+            color: {
+                type: "Color";
+                opacity: number;
+                value: THREE.Color;
+            };
+            intensity: {
+                type: "Number";
+                interpolable: boolean;
+                value: number;
+            };
+        };
+        directionalLight: {
+            color: {
+                type: "Color";
+                opacity: number;
+                value: THREE.Color;
+            };
+            intensity: {
+                type: "Number";
+                interpolable: boolean;
+                value: number;
+            };
+            position: {
+                type: "Vector";
+                value: THREE.Vector3;
+            };
+        };
+    };
+    ambientLight: AmbientLightConfig;
+    directionalLight: DirectionalLightConfig;
+    get backgroundColor(): THREE.Color;
+    set backgroundColor(value: THREE.Color);
+}
+export {};

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

@@ -1,24 +1,11 @@
 import * as THREE from "three";
 import { BaseScene, Configurable, Event } from "../../Types";
 import { Components } from "../../Components";
-/**
- * Configuration interface for the {@link SimpleScene}. Defines properties for directional and ambient lights.
- */
-export interface SimpleSceneConfig {
-    directionalLight: {
-        color: THREE.Color;
-        intensity: number;
-        position: THREE.Vector3;
-    };
-    ambientLight: {
-        color: THREE.Color;
-        intensity: number;
-    };
-}
+import { SimpleSceneConfig, SimpleSceneConfigManager } from "./simple-scene-config";
 /**
  * A basic 3D [scene](https://threejs.org/docs/#api/en/scenes/Scene) to add objects hierarchically, and easily dispose them when you are finished with it.
  */
-export declare class SimpleScene extends BaseScene implements Configurable<{}> {
+export declare class SimpleScene extends BaseScene implements Configurable<SimpleSceneConfigManager, SimpleSceneConfig> {
     /** {@link Configurable.isSetup} */
     isSetup: boolean;
     /**
@@ -28,11 +15,9 @@ export declare class SimpleScene extends BaseScene implements Configurable<{}> {
     three: THREE.Scene;
     /** {@link Configurable.onSetup} */
     readonly onSetup: Event<SimpleScene>;
-    /**
-     * Configuration interface for the {@link SimpleScene}.
-     * Defines properties for directional and ambient lights.
-     */
-    config: Required<SimpleSceneConfig>;
+    /** {@link Configurable.config} */
+    config: SimpleSceneConfigManager;
+    protected _defaultConfig: SimpleSceneConfig;
     constructor(components: Components);
     /** {@link Configurable.setup} */
     setup(config?: Partial<SimpleSceneConfig>): void;

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

@@ -1,7 +1,6 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Component, Disposable, Event, Components } from "../../core";
-import { IfcRelation } from "../IfcRelationsIndexer";
 /**
  * Types for boolean properties in IFC schema.
  */
@@ -208,10 +207,7 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @throws Will throw an error if the Pset to be removed is not of type `IFCPROPERTYSET`.
      */
     removePsetProp(model: FragmentsGroup, psetID: number, propID: number): Promise<void>;
-    /**
-     * @deprecated Use indexer.addEntitiesRelation instead. This will be removed in future releases.
-     */
-    addElementToPset(model: FragmentsGroup, psetID: number, ...expressIDs: number[]): void;
+    addElementToPset(model: FragmentsGroup, psetID: number, ...expressIDs: number[]): Promise<void>;
     /**
      * Adds elements to a Property Set (Pset) in the given model.
      *
@@ -226,19 +222,6 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @throws Will throw an error if no relation is found between the Pset and the model.
      */
     addPropToPset(model: FragmentsGroup, psetID: number, ...propID: number[]): Promise<void>;
-    /**
-     * Creates a new instance of a relationship between entities in the IFC model.
-     *
-     * @param model - The FragmentsGroup model in which to create the relationship.
-     * @param type - The type of the relationship to create.
-     * @param relatingID - The express ID of the entity that is related to the other entities.
-     * @param relatedIDs - The express IDs of the entities that are related to the relating entity.
-     *
-     * @returns A promise that resolves with the newly created relationship.
-     *
-     * @throws Will throw an error if the relationship type is unsupported.
-     */
-    createIfcRel(model: FragmentsGroup, type: IfcRelation, relatingID: number, relatedIDs: number[]): Promise<any>;
     /**
      * Saves the changes made to the model to a new IFC file.
      *
@@ -282,4 +265,3 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
     private registerChange;
     private newSingleProperty;
 }
-export * from "./src";

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

@@ -1,7 +1,8 @@
 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 } from "./src/types";
+export type { InverseAttribute, RelationsMap } from "./src/types";
 /**
  * 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).
  */
@@ -139,7 +140,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     /** {@link Disposable.dispose} */
     dispose(): void;
     /**
-     * Retrieves the entities within a model that have a specific relation with a given entity.
+     * Retrieves the entities within a given model that have a specific relation with a given entity.
      *
      * @param model - The BIM model to search for related entities.
      * @param inv - The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
@@ -157,40 +158,10 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * @param expressID - The expressID of the entity within the model.
      * @param relationName - The IFC schema inverse attribute of the relation to add (e.g., "IsDefinedBy", "ContainsElements").
      * @param relIDs - The expressIDs of the related entities within the model.
-     * @deprecated Use addEntitiesRelation instead. This will be removed in future versions.
      *
      * @throws An error if the relation name is not a valid relation name.
      */
     addEntityRelations(model: FragmentsGroup, expressID: number, relationName: InverseAttribute, ...relIDs: number[]): void;
-    /**
-     * 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.
-     *
-     * @returns A promise that resolves when all the relation changes have been applied.
-     */
-    applyRelationChanges(): Promise<void>;
-    private readonly _changeMap;
-    /**
-     * An event that is triggered when entities are related in a BIM model.
-     * 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[];
-    }>;
-    addEntitiesRelation(model: FragmentsGroup, relatingID: number, rel: {
-        type: IfcRelation;
-        inv: InverseAttribute;
-    }, ...relatedIDs: number[]): 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.
      *
@@ -202,4 +173,3 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      */
     getEntityChildren(model: FragmentsGroup, expressID: number, found?: Set<number>): Set<number>;
 }
-export * from "./src";

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

@@ -1,5 +1,5 @@
 import { InverseAttribute } from "./types";
-export declare const relToAttributesMap: Map<160246688 | 2655215786 | 919958153 | 1307041759 | 4186316022 | 781010003 | 307848117 | 3242617779 | 279856033 | 1204542856 | 2857406711 | 2565941209 | 2495723537 | 3268803585 | 982818633, {
+export declare const relToAttributesMap: Map<160246688 | 2655215786 | 919958153 | 1307041759 | 4186316022 | 781010003 | 307848117 | 3242617779 | 279856033 | 1204542856 | 2857406711 | 2565941209 | 2495723537 | 3268803585, {
     forRelating: InverseAttribute;
     forRelated: InverseAttribute;
 }>;

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

@@ -30,8 +30,7 @@ export type InverseAttributes = [
     "HasContext",
     "Controls",
     "IsNestedBy",
-    "Nests",
-    "DocumentRefForObjects"
+    "Nests"
 ];
 export type InverseAttribute = InverseAttributes[number];
 /**
@@ -51,7 +50,6 @@ export type IfcRelations = [
     typeof WEBIFC.IFCRELASSIGNSTOPRODUCT,
     typeof WEBIFC.IFCRELDECLARES,
     typeof WEBIFC.IFCRELASSIGNSTOCONTROL,
-    typeof WEBIFC.IFCRELNESTS,
-    typeof WEBIFC.IFCRELASSOCIATESDOCUMENT
+    typeof WEBIFC.IFCRELNESTS
 ];
 export type IfcRelation = IfcRelations[number];