@thatopen/components 1.5.0 → 2.0.0-alpha.1

package/dist/navigation/OrthoPerspectiveCamera/index.d.ts

@@ -0,0 +1,49 @@
+import * as THREE from "three";
+import { Components } from "../../core/Components";
+import { SimpleCamera } from "../../core";
+import { NavigationMode, NavModeID, ProjectionManager } from "./src";
+export * from "./src";
+/**
+ * A flexible camera that uses
+ * [yomotsu's cameracontrols](https://github.com/yomotsu/camera-controls) to
+ * easily control the camera in 2D and 3D. It supports multiple navigation
+ * modes, such as 2D floor plan navigation, first person and 3D orbit.
+ */
+export declare class OrthoPerspectiveCamera extends SimpleCamera {
+    /**
+     * The current {@link NavigationMode}.
+     */
+    mode: NavigationMode;
+    readonly core: ProjectionManager;
+    readonly threeOrtho: THREE.OrthographicCamera;
+    protected readonly _userInputButtons: any;
+    protected readonly _frustumSize = 50;
+    protected readonly _navigationModes: Map<NavModeID, NavigationMode>;
+    constructor(components: Components);
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    /**
+     * Sets a new {@link NavigationMode} and disables the previous one.
+     *
+     * @param mode - The {@link NavigationMode} to set.
+     */
+    set(mode: NavModeID): void;
+    /**
+     * Make the camera view fit all the specified meshes.
+     *
+     * @param meshes the meshes to fit. If it is not defined, it will
+     * evaluate {@link Components.meshes}.
+     * @param offset the distance to the fit object
+     */
+    fit(meshes: Iterable<THREE.Mesh>, offset?: number): Promise<void>;
+    /**
+     * Allows or prevents all user input.
+     *
+     * @param active - whether to enable or disable user inputs.
+     */
+    setUserInput(active: boolean): void;
+    private disableUserInput;
+    private enableUserInput;
+    private newOrthoCamera;
+    private setOrthoCameraAspect;
+}

package/dist/navigation/OrthoPerspectiveCamera/src/first-person-mode.d.ts

@@ -0,0 +1,16 @@
+import { NavigationMode } from "./types";
+/**
+ * A {@link NavigationMode} that allows first person navigation,
+ * simulating FPS video games.
+ */
+export declare class FirstPersonMode implements NavigationMode {
+    private camera;
+    /** {@link NavigationMode.enabled} */
+    enabled: boolean;
+    /** {@link NavigationMode.id} */
+    readonly id = "FirstPerson";
+    constructor(camera: any);
+    /** {@link NavigationMode.set} */
+    set(active: boolean): void;
+    private setupFirstPersonCamera;
+}

package/dist/navigation/OrthoPerspectiveCamera/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./first-person-mode";
+export * from "./orbit-mode";
+export * from "./plan-mode";
+export * from "./projections";
+export * from "./types";

package/dist/navigation/OrthoPerspectiveCamera/src/orbit-mode.d.ts

@@ -0,0 +1,16 @@
+import { NavigationMode } from "./types";
+/**
+ * A {@link NavigationMode} that allows 3D navigation and panning
+ * like in many 3D and CAD softwares.
+ */
+export declare class OrbitMode implements NavigationMode {
+    camera: any;
+    /** {@link NavigationMode.enabled} */
+    enabled: boolean;
+    /** {@link NavigationMode.id} */
+    readonly id = "Orbit";
+    constructor(camera: any);
+    /** {@link NavigationMode.set} */
+    set(active: boolean): void;
+    private activateOrbitControls;
+}

package/dist/navigation/OrthoPerspectiveCamera/src/plan-mode.d.ts

@@ -0,0 +1,20 @@
+import { NavigationMode } from "./types";
+/**
+ * A {@link NavigationMode} that allows to navigate floorplans in 2D,
+ * like many BIM tools.
+ */
+export declare class PlanMode implements NavigationMode {
+    private camera;
+    /** {@link NavigationMode.enabled} */
+    enabled: boolean;
+    /** {@link NavigationMode.id} */
+    readonly id = "Plan";
+    private mouseAction1?;
+    private mouseAction2?;
+    private mouseInitialized;
+    private readonly defaultAzimuthSpeed;
+    private readonly defaultPolarSpeed;
+    constructor(camera: any);
+    /** {@link NavigationMode.set} */
+    set(active: boolean): void;
+}

package/dist/navigation/OrthoPerspectiveCamera/src/projections.d.ts

@@ -0,0 +1,37 @@
+import * as THREE from "three";
+import { CameraProjection } from "./types";
+import { Event } from "../../../core";
+import { OrthoPerspectiveCamera } from "../index";
+/**
+ * Object to control the {@link CameraProjection} of the {@link OrthoPerspectiveCamera}.
+ */
+export declare class ProjectionManager {
+    /**
+     * Event that fires when the {@link CameraProjection} changes.
+     */
+    readonly onProjectionChanged: Event<THREE.Camera>;
+    projection: CameraProjection;
+    three: THREE.PerspectiveCamera | THREE.OrthographicCamera;
+    private _component;
+    private _previousDistance;
+    /** Match Ortho zoom with Perspective distance when changing projection mode */
+    matchOrthoDistanceEnabled: boolean;
+    constructor(camera: OrthoPerspectiveCamera);
+    /**
+     * Sets the {@link CameraProjection} of the {@link OrthoPerspectiveCamera}.
+     *
+     * @param projection - the new projection to set. If it is the current projection,
+     * it will have no effect.
+     */
+    set(projection: CameraProjection): Promise<void>;
+    /**
+     * Changes the current {@link CameraProjection} from Ortographic to Perspective
+     * and vice versa.
+     */
+    toggle(): Promise<void>;
+    private setOrthoCamera;
+    private getDims;
+    private setupOrthoCamera;
+    private getDistance;
+    private setPerspectiveCamera;
+}

package/dist/navigation/OrthoPerspectiveCamera/src/types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The projection system of the camera.
+ */
+export type CameraProjection = "Perspective" | "Orthographic";
+/**
+ * The extensible list of supported navigation modes.
+ */
+export type NavModeID = "Orbit" | "FirstPerson" | "Plan";
+/**
+ * An object that determines the behavior of the camera controls
+ * and the user input (e.g. 2D floor plan mode, first person mode, etc).
+ */
+export interface NavigationMode {
+    /** The unique ID of this navigation mode. */
+    id: NavModeID;
+    /**
+     * Enable or disable this navigation mode.
+     * When a new navigation mode is enabled, the previous navigation mode
+     * must be disabled.
+     *
+     * @param active - whether to enable or disable this mode.
+     * @param options - any additional data required to enable or disable it.
+     * */
+    set: (active: boolean, options?: any) => void;
+    /** Whether this navigation mode is active or not. */
+    enabled: boolean;
+}

package/dist/navigation/index.d.ts

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

package/dist/utils/bbox.d.ts

@@ -0,0 +1,7 @@
+import * as THREE from "three";
+export declare function obbFromPoints(vertices: ArrayLike<number>): {
+    center: THREE.Vector3;
+    halfSizes: THREE.Vector3;
+    rotation: THREE.Matrix3;
+    transformation: THREE.Matrix4;
+};

package/dist/utils/geometry.d.ts

@@ -0,0 +1 @@
+export declare function isPointInFrontOfPlane(point: number[], planePoint: number[], planeNormal: number[]): boolean;

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./bbox";
+export * from "./geometry";
+export * from "./materials";
+export * from "./uuid";

package/dist/utils/materials.d.ts

@@ -0,0 +1,4 @@
+import * as THREE from "three";
+export declare class MaterialsUtils {
+    static isTransparent(material: THREE.Material): boolean;
+}

package/dist/utils/uuid.d.ts

@@ -0,0 +1,6 @@
+export declare class UUID {
+    private static _pattern;
+    private static _lut;
+    static create(): string;
+    static validate(uuid: string): void;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thatopen/components",
   "description": "Collection of core functionalities to author BIM apps.",
-  "version": "1.5.0",
+  "version": "2.0.0-alpha.1",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",
@@ -14,7 +14,8 @@
     "url": "https://github.com/ThatOpen/engine_components/issues"
   },
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
@@ -28,8 +29,12 @@
     "dev": "vite --host",
     "test": "jest",
     "build": "tsc --p ./tsconfig-build.json && vite build",
-    "publish-repo": "cd dist && npm publish",
-    "publish-alpha": "cd dist && npm publish --tag alpha"
+    "prepublishOnly": "yarn build",
+    "publish-repo": "npm publish",
+    "publish-alpha": "npm publish --tag alpha"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "devDependencies": {
     "@types/jest": "27.0.0",
@@ -64,4 +69,4 @@
     "three": "^0.160.1",
     "web-ifc": "0.0.53"
   }
-}
+}