@thatopen/components 2.4.11 → 3.1.0

package/package.json

@@ -1,60 +1,58 @@
-{
-  "name": "@thatopen/components",
-  "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.4.11",
-  "author": "That Open Company",
-  "contributors": [
-    "Antonio Gonzalez Viegas (https://github.com/agviegas)",
-    "Juan Hoyos (https://github.com/HoyosJuan)",
-    "Harry Collin (https://github.com/harrycollin)"
-  ],
-  "license": "MIT",
-  "homepage": "https://github.com/ThatOpen/engine_components/tree/main/packages/components#readme",
-  "bugs": {
-    "url": "https://github.com/ThatOpen/engine_components/issues"
-  },
-  "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ThatOpen/engine_components/tree/main/packages/components.git"
-  },
-  "packageManager": "yarn@3.2.1",
-  "scripts": {
-    "dev": "vite --host",
-    "test": "jest",
-    "build": "tsc --p ./tsconfig-build.json && vite build",
-    "prepublishOnly": "node ./resources/updateComponentsVersion.mjs && yarn build",
-    "publish-repo": "npm publish"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@thatopen/fragments": "~3.0.0",
-    "@thatopen/ui": "~2.4.0",
-    "@types/earcut": "2.1.4",
-    "@types/three": "0.175.0",
-    "stats.js": "^0.17.0",
-    "three": "^0.175.0",
-    "web-ifc": "0.0.68"
-  },
-  "dependencies": {
-    "camera-controls": "2.9.0",
-    "earcut": "2.2.4",
-    "fast-xml-parser": "4.4.1",
-    "jszip": "3.10.1",
-    "three-mesh-bvh": "0.7.0"
-  },
-  "peerDependencies": {
-    "@thatopen/fragments": "~3.0.0",
-    "three": ">=0.175.0",
-    "web-ifc": "0.0.68"
-  }
-}
+{
+  "name": "@thatopen/components",
+  "description": "Collection of core functionalities to author BIM apps.",
+  "version": "3.1.0",
+  "author": "That Open Company",
+  "contributors": [
+    "Antonio Gonzalez Viegas (https://github.com/agviegas)",
+    "Juan Hoyos (https://github.com/HoyosJuan)",
+    "Harry Collin (https://github.com/harrycollin)"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/ThatOpen/engine_components/tree/main/packages/components#readme",
+  "bugs": {
+    "url": "https://github.com/ThatOpen/engine_components/issues"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ThatOpen/engine_components/tree/main/packages/components.git"
+  },
+  "scripts": {
+    "dev": "vite --host",
+    "test": "jest",
+    "build": "tsc --p ./tsconfig-build.json && vite build",
+    "prepublishOnly": "node ./resources/updateComponentsVersion.mjs && yarn build",
+    "publish-repo": "npm publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@thatopen/fragments": "~3.1.0",
+    "@thatopen/ui": "~2.4.0",
+    "@types/convert-units": "2.3.11",
+    "@types/three": "0.175.0",
+    "stats.js": "^0.17.0",
+    "three": "^0.175.0",
+    "web-ifc": "0.0.69"
+  },
+  "dependencies": {
+    "camera-controls": "^2.9.0",
+    "fast-xml-parser": "4.4.1",
+    "jszip": "3.10.1",
+    "three-mesh-bvh": "0.7.0"
+  },
+  "peerDependencies": {
+    "@thatopen/fragments": "~3.1.0",
+    "three": ">=0.175.0",
+    "web-ifc": "0.0.69"
+  }
+}

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

@@ -1,142 +0,0 @@
-import * as THREE from "three";
-import { Component, Configurable, Createable, Disposable, Event, Hideable, World } from "../Types";
-import { SimplePlane } from "./src";
-import { Components } from "../Components";
-import { ClipperConfig, ClipperConfigManager } from "./src/clipper-config";
-export * from "./src";
-/**
- * A lightweight component to easily create, delete and handle [clipping planes](https://threejs.org/docs/#api/en/materials/Material.clippingPlanes). 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/Clipper). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/Clipper).
- *
- * @param components - the instance of {@link Components} used.
- * E.g. {@link SimplePlane}.
- */
-export declare class Clipper extends Component implements Createable, Disposable, Hideable, Configurable<ClipperConfigManager, ClipperConfig> {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "66290bc5-18c4-4cd1-9379-2e17a0617611";
-    /** {@link Configurable.onSetup} */
-    readonly onSetup: Event<unknown>;
-    /** Event that fires when the user starts dragging a clipping plane. */
-    readonly onBeforeDrag: Event<void>;
-    /** Event that fires when the user stops dragging a clipping plane. */
-    readonly onAfterDrag: Event<void>;
-    /**
-     * Event that fires when the user starts creating a clipping plane.
-     */
-    readonly onBeforeCreate: Event<unknown>;
-    /**
-     * Event that fires when the user cancels the creation of a clipping plane.
-     */
-    readonly onBeforeCancel: Event<unknown>;
-    /**
-     * Event that fires after the user cancels the creation of a clipping plane.
-     */
-    readonly onAfterCancel: Event<unknown>;
-    /**
-     * Event that fires when the user starts deleting a clipping plane.
-     */
-    readonly onBeforeDelete: Event<unknown>;
-    /**
-     * Event that fires after a clipping plane has been created.
-     * @param plane - The newly created clipping plane.
-     */
-    readonly onAfterCreate: Event<SimplePlane>;
-    /**
-     * Event that fires after a clipping plane has been deleted.
-     * @param plane - The deleted clipping plane.
-     */
-    readonly onAfterDelete: Event<SimplePlane>;
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<string>;
-    /** {@link Configurable.isSetup} */
-    isSetup: boolean;
-    /**
-     * Whether to force the clipping plane to be orthogonal in the Y direction
-     * (up). This is desirable when clipping a building horizontally and a
-     * clipping plane is created in its roof, which might have a slight
-     * slope for draining purposes.
-     */
-    orthogonalY: boolean;
-    /**
-     * The tolerance that determines whether an almost-horizontal clipping plane
-     * will be forced to be orthogonal to the Y direction. {@link orthogonalY}
-     * has to be `true` for this to apply.
-     */
-    toleranceOrthogonalY: number;
-    /**
-     * The type of clipping plane to be created.
-     * Default is {@link SimplePlane}.
-     */
-    Type: new (...args: any) => SimplePlane;
-    /**
-     * A list of all the clipping planes created by this component.
-     */
-    list: SimplePlane[];
-    /** {@link Configurable.config} */
-    config: ClipperConfigManager;
-    protected _defaultConfig: ClipperConfig;
-    /** The material used in all the clipping planes. */
-    private _material;
-    private _size;
-    private _enabled;
-    private _visible;
-    /** {@link Component.enabled} */
-    get enabled(): boolean;
-    /** {@link Component.enabled} */
-    set enabled(state: boolean);
-    /** {@link Hideable.visible } */
-    get visible(): boolean;
-    /** {@link Hideable.visible } */
-    set visible(state: boolean);
-    /** The material of the clipping plane representation. */
-    get material(): THREE.MeshBasicMaterial;
-    /** The material of the clipping plane representation. */
-    set material(material: THREE.MeshBasicMaterial);
-    /** The size of the geometric representation of the clippings planes. */
-    get size(): number;
-    /** The size of the geometric representation of the clippings planes. */
-    set size(size: number);
-    constructor(components: Components);
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /** {@link Createable.create} */
-    create(world: World): SimplePlane | null;
-    /**
-     * Creates a plane in a certain place and with a certain orientation,
-     * without the need of the mouse.
-     *
-     * @param world - the world where this plane should be created.
-     * @param normal - the orientation of the clipping plane.
-     * @param point - the position of the clipping plane.
-     * navigation.
-     */
-    createFromNormalAndCoplanarPoint(world: World, normal: THREE.Vector3, point: THREE.Vector3): SimplePlane;
-    /**
-     * {@link Createable.delete}
-     *
-     * @param world - the world where the plane to delete is.
-     * @param plane - the plane to delete. If undefined, the first plane
-     * found under the cursor will be deleted.
-     */
-    delete(world: World, plane?: SimplePlane): void;
-    /**
-     * Deletes all the existing clipping planes.
-     *
-     * @param types - the types of planes to be deleted. If not provided, all planes will be deleted.
-     */
-    deleteAll(types?: Set<string>): void;
-    /** {@link Configurable.setup} */
-    setup(config?: Partial<ClipperConfig>): void;
-    private deletePlane;
-    private pickPlane;
-    private getAllPlaneMeshes;
-    private createPlaneFromIntersection;
-    private getWorldNormal;
-    private normalizePlaneDirectionY;
-    private newPlane;
-    private updateMaterialsAndPlanes;
-    private _onStartDragging;
-    private _onEndDragging;
-}

package/dist/core/Clipper/src/clipper-config.d.ts

@@ -1,33 +0,0 @@
-import * as THREE from "three";
-import { BooleanSettingsControl, ColorSettingsControl, NumberSettingControl } from "../../Types";
-import { Configurator } from "../../ConfigManager";
-import { Clipper } from "../index";
-type ClipperConfigType = {
-    enabled: BooleanSettingsControl;
-    visible: BooleanSettingsControl;
-    color: ColorSettingsControl;
-    opacity: NumberSettingControl;
-    size: NumberSettingControl;
-};
-/**
- * Configuration interface for the {@link Clipper}.
- */
-export interface ClipperConfig {
-    color: THREE.Color;
-    opacity: number;
-    size: number;
-}
-export declare class ClipperConfigManager extends Configurator<Clipper, ClipperConfigType> {
-    protected _config: ClipperConfigType;
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    get visible(): boolean;
-    set visible(value: boolean);
-    get color(): THREE.Color;
-    set color(value: THREE.Color);
-    get opacity(): number;
-    set opacity(value: number);
-    get size(): number;
-    set size(value: number);
-}
-export {};

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

@@ -1 +0,0 @@
-export * from "./simple-plane";

package/dist/core/Clipper/src/simple-plane.d.ts

@@ -1,99 +0,0 @@
-import * as THREE from "three";
-import { Hideable, Disposable, Event, World } from "../../Types";
-import { Components } from "../../Components";
-/**
- * Each of the clipping planes created by the clipper.
- */
-export declare class SimplePlane implements Disposable, Hideable {
-    /** Event that fires when the user starts dragging a clipping plane. */
-    readonly onDraggingStarted: Event<unknown>;
-    /** Event that fires when the user stops dragging a clipping plane. */
-    readonly onDraggingEnded: Event<unknown>;
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<unknown>;
-    /**
-     * The normal vector of the clipping plane.
-     */
-    readonly normal: THREE.Vector3;
-    /**
-     * The origin point of the clipping plane.
-     */
-    readonly origin: THREE.Vector3;
-    /**
-     * The THREE.js Plane object representing the clipping plane.
-     */
-    readonly three: THREE.Plane;
-    /** The components instance to which this plane belongs. */
-    components: Components;
-    /** The world instance to which this plane belongs. */
-    world: World;
-    /** A custom string to identify what this plane is used for. */
-    type: string;
-    protected readonly _helper: THREE.Object3D;
-    protected _visible: boolean;
-    protected _enabled: boolean;
-    private _controlsActive;
-    private readonly _arrowBoundBox;
-    private readonly _planeMesh;
-    private readonly _controls;
-    private readonly _hiddenMaterial;
-    /**
-     * Getter for the enabled state of the clipping plane.
-     * @returns {boolean} The current enabled state.
-     */
-    get enabled(): boolean;
-    /**
-     * Setter for the enabled state of the clipping plane.
-     * Updates the clipping plane state in the renderer and throws an error if no renderer is found.
-     * @param {boolean} state - The new enabled state.
-     */
-    set enabled(state: boolean);
-    /** {@link Hideable.visible } */
-    get visible(): boolean;
-    /** {@link Hideable.visible } */
-    set visible(state: boolean);
-    /** The meshes used for raycasting */
-    get meshes(): THREE.Mesh[];
-    /** The material of the clipping plane representation. */
-    get planeMaterial(): THREE.Material | THREE.Material[];
-    /** The material of the clipping plane representation. */
-    set planeMaterial(material: THREE.Material | THREE.Material[]);
-    /** The size of the clipping plane representation. */
-    get size(): number;
-    /** Sets the size of the clipping plane representation. */
-    set size(size: number);
-    /**
-     * Getter for the helper object of the clipping plane.
-     * The helper object is a THREE.Object3D that contains the clipping plane mesh and other related objects.
-     * It is used for positioning, rotating, and scaling the clipping plane in the 3D scene.
-     *
-     * @returns {THREE.Object3D} The helper object of the clipping plane.
-     */
-    get helper(): THREE.Object3D<THREE.Object3DEventMap>;
-    constructor(components: Components, world: World, origin: THREE.Vector3, normal: THREE.Vector3, material: THREE.Material, size?: number, activateControls?: boolean);
-    /**
-     * Sets the clipping plane's normal and origin from the given normal and point.
-     * This method resets the clipping plane's state, updates the normal and origin,
-     * and positions the helper object accordingly.
-     *
-     * @param normal - The new normal vector for the clipping plane.
-     * @param point - The new origin point for the clipping plane.
-     *
-     * @returns {void}
-     */
-    setFromNormalAndCoplanarPoint(normal: THREE.Vector3, point: THREE.Vector3): void;
-    /** {@link Updateable.update} */
-    update: () => void;
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    private reset;
-    protected toggleControls(state: boolean): void;
-    private newTransformControls;
-    private initializeControls;
-    private createArrowBoundingBox;
-    private changeDrag;
-    private notifyDraggingChanged;
-    private preventCameraMovement;
-    private newHelper;
-    private static newPlaneMesh;
-}

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

@@ -1,93 +0,0 @@
-import { Component, Disposable, Event } from "../Types";
-/**
- * The entry point of the Components library. It can create, delete and access all the components of the library globally, update all the updatable components automatically and dispose all the components, preventing memory leaks.
- */
-export declare class Components implements Disposable {
-    /**
-     * The version of the @thatopen/components library.
-     */
-    static readonly release = "2.4.11";
-    /** {@link Disposable.onDisposed} */
-    readonly onDisposed: Event<void>;
-    /**
-     * The list of components created in this app.
-     * The keys are UUIDs and the values are instances of the components.
-     */
-    readonly list: Map<string, Component>;
-    /**
-     * If disabled, the animation loop will be stopped.
-     * Default value is false.
-     */
-    enabled: boolean;
-    private _clock;
-    /**
-     * Event that triggers the Components instance is initialized.
-     *
-     * @remarks
-     * This event is triggered once when the {@link Components.init} method has been called and finish processing.
-     * This is useful to set configuration placeholders that need to be executed when the components instance is initialized.
-     * For example, enabling and configuring custom effects in a post-production renderer.
-     *
-     * @example
-     * ```typescript
-     * const components = new Components();
-     * components.onInit.add(() => {
-     *   // Enable custom effects in the post-production renderer
-     *   // or any other operation dependant on the component initialization
-     * });
-     * components.init();
-     * ```
-     */
-    readonly onInit: Event<undefined>;
-    /**
-     * Adds a component to the list of components.
-     * Throws an error if a component with the same UUID already exists.
-     *
-     * @param uuid - The unique identifier of the component.
-     * @param instance - The instance of the component to be added.
-     *
-     * @throws Will throw an error if a component with the same UUID already exists.
-     *
-     * @internal
-     */
-    add(uuid: string, instance: Component): void;
-    /**
-     * Retrieves a component instance by its constructor function.
-     * If the component does not exist in the list, it will be created and added.
-     *
-     * @template U - The type of the component to retrieve.
-     * @param Component - The constructor function of the component to retrieve.
-     *
-     * @returns The instance of the requested component.
-     *
-     * @throws Will throw an error if a component with the same UUID already exists.
-     *
-     * @internal
-     */
-    get<U extends Component>(Component: new (components: Components) => U): U;
-    constructor();
-    /**
-     * Initializes the Components instance.
-     * This method starts the animation loop, sets the enabled flag to true,
-     * and calls the update method.
-     */
-    init(): void;
-    /**
-     * Disposes the memory of all the components and tools of this instance of
-     * the library. A memory leak will be created if:
-     *
-     * - An instance of the library ends up out of scope and this function isn't
-     * called. This is especially relevant in Single Page Applications (React,
-     * Angular, Vue, etc).
-     *
-     * - Any of the objects of this instance (meshes, geometries,materials, etc) is
-     * referenced by a reference type (object or array).
-     *
-     * You can learn more about how Three.js handles memory leaks
-     * [here](https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects).
-     *
-     */
-    dispose(): void;
-    private update;
-    private static setupBVH;
-}

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

@@ -1,21 +0,0 @@
-import { Component, DataMap } from "../Types";
-import { Components } from "../Components";
-import { Configurator } from "./src";
-export * from "./src";
-/**
- * A tool to manage all the configuration from the app centrally.
- */
-export declare class ConfigManager extends Component {
-    /**
-     * The list of all configurations of this app.
-     */
-    list: DataMap<string, Configurator<any, any>>;
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "b8c764e0-6b24-4e77-9a32-35fa728ee5b4";
-    constructor(components: Components);
-}

package/dist/core/ConfigManager/src/configurator.d.ts

@@ -1,13 +0,0 @@
-import { ControlsSchema } from "../../Types";
-import { Components } from "../../Components";
-export declare abstract class Configurator<T = any, U extends ControlsSchema = ControlsSchema> {
-    protected abstract _config: U;
-    protected _component: T;
-    name: string;
-    uuid: string;
-    get controls(): U;
-    constructor(component: T, components: Components, name: string, uuid?: string);
-    set(data: Partial<U>): void;
-    export(controls?: ControlsSchema, exported?: any): any;
-    import(exported: any, imported?: any, first?: boolean): void;
-}

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

@@ -1 +0,0 @@
-export * from "./configurator";

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

@@ -1,56 +0,0 @@
-import * as THREE from "three";
-import { Components } from "../Components";
-import { MeshCullerRenderer } from "./src";
-import { Component, Event, Disposable, World } from "../Types";
-export * from "./src";
-/**
- * A component that provides culling functionality for meshes in a 3D scene. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/Cullers). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/Cullers).
- */
-export declare class Cullers extends Component implements Disposable {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "69f2a50d-c266-44fc-b1bd-fa4d34be89e6";
-    /**
-     * An event that is triggered when the Cullers component is disposed.
-     */
-    readonly onDisposed: Event<unknown>;
-    private _enabled;
-    /**
-     * A map of MeshCullerRenderer instances, keyed by their world UUIDs.
-     */
-    list: Map<string, MeshCullerRenderer>;
-    /** {@link Component.enabled} */
-    get enabled(): boolean;
-    /** {@link Component.enabled} */
-    set enabled(value: boolean);
-    constructor(components: Components);
-    /**
-     * Creates a new MeshCullerRenderer for the given world.
-     * If a MeshCullerRenderer already exists for the world, it will return the existing one.
-     *
-     * @param world - The world for which to create the MeshCullerRenderer.
-     *
-     * @returns The newly created or existing MeshCullerRenderer for the given world.
-     */
-    create(world: World): MeshCullerRenderer;
-    /**
-     * Deletes the MeshCullerRenderer associated with the given world.
-     * If a MeshCullerRenderer exists for the given world, it will be disposed and removed from the list.
-     *
-     * @param world - The world for which to delete the MeshCullerRenderer.
-     *
-     * @returns {void}
-     */
-    delete(world: World): void;
-    /** {@link Disposable.dispose} */
-    dispose(): void;
-    /**
-     * Updates the given instanced meshes inside the all the cullers. You should use this if you change the count property, e.g. when changing the visibility of fragments.
-     *
-     * @param meshes - The meshes to update.
-     *
-     */
-    updateInstanced(meshes: Iterable<THREE.InstancedMesh>): void;
-}

package/dist/core/Cullers/src/culler-renderer-config.d.ts

@@ -1,74 +0,0 @@
-import { BooleanSettingsControl, NumberSettingControl } from "../../Types";
-import { Configurator } from "../../ConfigManager";
-import { CullerRenderer } from "../index";
-type CullerRendererConfigType = {
-    enabled: BooleanSettingsControl;
-    width: NumberSettingControl;
-    height: NumberSettingControl;
-    updateInterval: NumberSettingControl;
-    autoUpdate: BooleanSettingsControl;
-    renderDebugFrame: BooleanSettingsControl;
-    threshold: NumberSettingControl;
-};
-/**
- * Configuration interface for the {@link CullerRenderer}.
- */
-export interface CullerRendererConfig {
-    /**
-     * Whether the culler renderer should make renders or not.
-     */
-    enabled: boolean;
-    /**
-     * Width of the render target used for visibility checks.
-     */
-    width: number;
-    /**
-     * Height of the render target used for visibility checks.
-     * Default value is 512.
-     */
-    height: number;
-    /**
-     * Whether the visibility check should be performed automatically.
-     * Default value is true.
-     */
-    autoUpdate: boolean;
-    /**
-     * Interval in milliseconds at which the visibility check should be performed.
-     */
-    updateInterval: number;
-    /**
-     * Whether to render the frame use to debug the culler behavior.
-     */
-    renderDebugFrame: boolean;
-    /**
-     * Pixels in screen a geometry must occupy to be considered "seen".
-     * Default value is 100.
-     */
-    threshold: number;
-}
-/**
- * Settings to configure the CullerRenderer.
- */
-export declare class CullerRendererConfigManager extends Configurator<CullerRenderer, CullerRendererConfigType> {
-    protected _config: CullerRendererConfigType;
-    private _interval;
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    get width(): number;
-    set width(value: number);
-    get height(): number;
-    set height(value: number);
-    get autoUpdate(): boolean;
-    set autoUpdate(value: boolean);
-    get updateInterval(): number;
-    set updateInterval(value: number);
-    get renderDebugFrame(): boolean;
-    set renderDebugFrame(value: boolean);
-    get threshold(): number;
-    set threshold(value: number);
-    setWidthHeight(width: number, height: number): void;
-    setAutoAndInterval(auto: boolean, interval: number): void;
-    private resetRenderTarget;
-    private resetInterval;
-}
-export {};