@thatopen/components 2.1.26 → 2.2.0-alpha.0

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

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

@@ -0,0 +1,13 @@
+import { World, Component, Disposable, Event, DataMap } from "../Types";
+import { Components } from "../Components";
+import { BCFViewpoint, Viewpoint } from "./src";
+export declare class Viewpoints extends Component implements Disposable {
+    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);
+    readonly onDisposed: Event<unknown>;
+    dispose(): void;
+}
+export * from "./src";

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

@@ -0,0 +1,37 @@
+import * as THREE from "three";
+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 { SimplePlane } from "../../Clipper";
+export declare class Viewpoint implements BCFViewpoint {
+    name: string;
+    guid: string;
+    clippingPlanes: DataSet<SimplePlane>;
+    camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera;
+    readonly exceptionComponents: DataSet<string>;
+    readonly selectionComponents: DataSet<string>;
+    spacesVisible: boolean;
+    spaceBoundariesVisible: boolean;
+    openingsVisible: boolean;
+    defaultVisibility: boolean;
+    private get _selectionModelIdMap();
+    private get _exceptionModelIdMap();
+    get selection(): FRAGS.FragmentIdMap;
+    get exception(): FRAGS.FragmentIdMap;
+    get projection(): CameraProjection;
+    get position(): THREE.Vector3;
+    get direction(): THREE.Vector3;
+    private _components;
+    readonly world: World;
+    private get _managerVersion();
+    get topics(): import("../../../openbim/BCFTopics").Topic[];
+    constructor(components: Components, world: World);
+    addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap): Promise<void>;
+    set(data: Partial<BCFViewpoint>): void;
+    go(transition?: boolean): Promise<void>;
+    updateCamera(): void;
+    private createComponentTags;
+    serialize(version?: import("../../../openbim/BCFTopics").BCFVersion): Promise<string>;
+}

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

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

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

@@ -0,0 +1,33 @@
+import { SimplePlane } from "../../Clipper";
+import { DataSet } from "../../Types";
+export interface ViewpointCamera {
+    direction: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    aspectRatio: number;
+}
+export interface ViewpointPerspectiveCamera extends ViewpointCamera {
+    fov: number;
+}
+export interface ViewpointOrthographicCamera extends ViewpointCamera {
+    viewToWorldScale: number;
+}
+export interface BCFViewpoint {
+    name: string;
+    guid: string;
+    camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera;
+    selectionComponents: Iterable<string>;
+    exceptionComponents: Iterable<string>;
+    clippingPlanes: DataSet<SimplePlane>;
+    spacesVisible: boolean;
+    spaceBoundariesVisible: boolean;
+    openingsVisible: boolean;
+    defaultVisibility: boolean;
+}

package/dist/core/index.d.ts

@@ -7,5 +7,6 @@ export * from "./Worlds";
 export * from "./Grids";
 export * from "./Clipper";
 export * from "./Cullers";
+export * from "./Viewpoints";
 export * from "./MiniMap";
 export * from "./OrthoPerspectiveCamera";

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

@@ -100,6 +100,14 @@ export declare class FragmentsManager extends Component implements Disposable {
     modelIdToFragmentIdMap(modelIdMap: {
         [modelID: string]: Set<number>;
     }): FRAGS.FragmentIdMap;
+    /**
+     * Converts a collection of IFC GUIDs to a fragmentIdMap.
+     *
+     * @param guids - An iterable collection of global IDs to be converted to a fragment ID map.
+     *
+     * @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;
     /**
      * Applies coordinate transformation to the provided models.
      * If no models are provided, all groups are used.
@@ -124,7 +132,7 @@ export declare class FragmentsManager extends Component implements Disposable {
      * @param originalCoordinateSystem - The original coordinate system of the object.
      * This should be a THREE.Matrix4 representing the object's transformation matrix.
      */
-    applyBaseCoordinateSystem(object: THREE.Object3D | THREE.Vector3, originalCoordinateSystem: THREE.Matrix4): void;
+    applyBaseCoordinateSystem(object: THREE.Object3D | THREE.Vector3, originalCoordinateSystem?: THREE.Matrix4): void;
     /**
      * Creates a copy of the whole model or a part of it.
      *

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

@@ -139,6 +139,18 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     getRelationsMapFromJSON(json: string): RelationsMap;
     /** {@link Disposable.dispose} */
     dispose(): void;
+    /**
+     * 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").
+     * @param expressID - The expressID of the entity within the model.
+     *
+     * @returns A `Set` with the expressIDs of the entities that have the specified relation with the given entity.
+     *
+     * @throws An error if the model relations are not indexed or if the inverse attribute name is invalid.
+     */
+    getEntitiesWithRelation(model: FragmentsGroup, inv: InverseAttribute, expressID: number): Set<number>;
     /**
      * Adds relations between an entity and other entities in a BIM model.
      *