vim-web 0.6.0-dev.3 → 0.6.0-dev.6

package/dist/types/core-viewers/webgl/viewer/camera/camera.d.ts

@@ -1,149 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import * as THREE from 'three';
-import { ISignal } from 'ste-signals';
-import { RenderScene } from '../rendering/renderScene';
-import { ViewerSettings } from '../settings/viewerSettings';
-import { Viewport } from '../viewport';
-import { ICamera } from './cameraInterface';
-import { CameraMovement } from './cameraMovement';
-import { OrthographicCamera } from './cameraOrthographic';
-import { PerspectiveCamera } from './cameraPerspective';
-/**
- * Manages viewer camera movement and position
- */
-export declare class Camera implements ICamera {
-    camPerspective: PerspectiveCamera;
-    camOrthographic: OrthographicCamera;
-    private _viewport;
-    private _scene;
-    private _lerp;
-    private _movement;
-    private _inputVelocity;
-    private _velocity;
-    private _orthographic;
-    private _target;
-    private _lastPosition;
-    private _lastQuaternion;
-    private _lastTarget;
-    private _tmp1;
-    private _tmp2;
-    private _savedState;
-    /**
-     * A signal that is dispatched when camera settings change.
-     */
-    get onSettingsChanged(): ISignal;
-    private _onValueChanged;
-    /**
-     * True if the camera has moved this frame.
-     */
-    get hasMoved(): boolean;
-    private _hasMoved;
-    get isLerping(): boolean;
-    /**
-     * A signal that is dispatched when the camera is moved.
-     */
-    get onMoved(): ISignal;
-    private _onMoved;
-    /** Ignore movement permissions when true */
-    private _force;
-    /**
-     * Represents allowed movement along each axis using a Vector3 object.
-     * Each component of the Vector3 should be either 0 or 1 to enable/disable movement along the corresponding axis.
-     */
-    private _allowedMovement;
-    get allowedMovement(): THREE.Vector3;
-    set allowedMovement(axes: THREE.Vector3);
-    /**
-     * Represents allowed rotation using a Vector2 object.
-     * Each component of the Vector2 should be either 0 or 1 to enable/disable rotation around the corresponding axis.
-     */
-    get allowedRotation(): THREE.Vector2;
-    set allowedRotation(axes: THREE.Vector2);
-    private _allowedRotation;
-    /**
-     * The default forward direction that can be used to initialize the camera.
-     */
-    private _defaultForward;
-    get defaultForward(): THREE.Vector3;
-    set defaultForward(value: THREE.Vector3);
-    private _velocityBlendFactor;
-    constructor(scene: RenderScene, viewport: Viewport, settings: ViewerSettings);
-    /**
-     * Interface for instantaneously moving the camera.
-     * @param {boolean} [force=false] - Set to true to ignore locked axis and rotation.
-     * @returns {CameraMovement} The camera movement api.
-     */
-    snap(force?: boolean): CameraMovement;
-    /**
-     * Interface for smoothly moving the camera over time.
-     * @param {number} [duration=1] - The duration of the camera movement animation.
-     * @param {boolean} [force=false] - Set to true to ignore locked axis and rotation.
-     * @returns {CameraMovement} The camera movement api.
-     */
-    lerp(duration?: number, force?: boolean): CameraMovement;
-    /**
-     * Calculates the frustum size at a given point in the scene.
-     * @param {THREE.Vector3} point - The point in the scene to calculate the frustum size at.
-     * @returns {number} The frustum size at the specified point.
-     */
-    frustrumSizeAt(point: THREE.Vector3): THREE.Vector2;
-    /**
-     * The current THREE Camera
-     */
-    get three(): THREE.PerspectiveCamera | THREE.OrthographicCamera;
-    /**
-     * The quaternion representing the orientation of the object.
-     */
-    get quaternion(): THREE.Quaternion;
-    /**
-     * The position of the camera.
-     */
-    get position(): THREE.Vector3;
-    /**
-     * The matrix representing the transformation of the camera.
-     */
-    get matrix(): THREE.Matrix4;
-    /**
-     * The forward direction of the camera.
-     */
-    get forward(): THREE.Vector3;
-    /**
-     * The current or target velocity of the camera.
-     */
-    get localVelocity(): THREE.Vector3;
-    /**
-     * The current or target velocity of the camera.
-     */
-    set localVelocity(vector: THREE.Vector3);
-    /**
-     * Immediately stops the camera movement.
-     */
-    stop(): void;
-    /**
-     * The target at which the camera is looking at and around which it rotates.
-     */
-    get target(): THREE.Vector3;
-    private applySettings;
-    /**
-     * The distance from the camera to the target.
-     */
-    get orbitDistance(): number;
-    /**
-     * Saves current camera orientation to restore on next reset.
-     */
-    save(): void;
-    /**
-     * Represents whether the camera projection is orthographic.
-     */
-    get orthographic(): boolean;
-    set orthographic(value: boolean);
-    update(deltaTime: number): boolean;
-    private updateProjection;
-    private updateOrthographic;
-    private applyVelocity;
-    private getVelocityMultiplier;
-    private checkForMovement;
-    private applyVelocityOrthographic;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraInterface.d.ts

@@ -1,107 +0,0 @@
-import { ISignal } from 'ste-signals';
-import * as THREE from 'three';
-import { CameraMovement } from './cameraMovement';
-/**
- * Interface representing a camera with various properties and methods for controlling its behavior.
- */
-export interface ICamera {
-    /**
-     * A signal that is dispatched when camera settings change.
-     */
-    onSettingsChanged: ISignal;
-    /**
-     * A signal that is dispatched when camera moves.
-     */
-    onMoved: ISignal;
-    /**
-     * True if the camera has moved this frame.
-     */
-    get hasMoved(): boolean;
-    /**
-     * Represents allowed movement along each axis using a Vector3 object.
-     * Each component of the Vector3 should be either 0 or 1 to enable/disable movement along the corresponding axis.
-     */
-    allowedMovement: THREE.Vector3;
-    /**
-     * Represents allowed rotation using a Vector2 object.
-     * Each component of the Vector2 should be either 0 or 1 to enable/disable rotation around the corresponding axis.
-     */
-    allowedRotation: THREE.Vector2;
-    /**
-     * The default forward direction that can be used to initialize the camera.
-     */
-    defaultForward: THREE.Vector3;
-    /**
-     * Interface for instantaneously moving the camera.
-     * @param {boolean} [force=false] - Set to true to ignore locked axis and rotation.
-     * @returns {CameraMovement} The camera movement api.
-     */
-    snap(force?: boolean): CameraMovement;
-    /**
-     * Interface for smoothly moving the camera over time.
-     * @param {number} [duration=1] - The duration of the camera movement animation.
-     * @param {boolean} [force=false] - Set to true to ignore locked axis and rotation.
-     * @returns {CameraMovement} The camera movement api.
-     */
-    lerp(duration: number, force?: boolean): CameraMovement;
-    /**
-     * Calculates the frustum size at a given point in the scene.
-     * @param {THREE.Vector3} point - The point in the scene to calculate the frustum size at.
-     * @returns {number} The frustum size at the specified point.
-     */
-    frustrumSizeAt(point: THREE.Vector3): THREE.Vector2;
-    /**
-     * The current THREE Camera
-     */
-    get three(): THREE.Camera;
-    /**
-     * The quaternion representing the orientation of the object.
-     */
-    get quaternion(): THREE.Quaternion;
-    /**
-    * The position of the camera.
-    */
-    get position(): THREE.Vector3;
-    /**
-     * The matrix representing the transformation of the camera.
-     */
-    get matrix(): THREE.Matrix4;
-    /**
-     * The forward direction of the camera.
-     */
-    get forward(): THREE.Vector3;
-    get isLerping(): boolean;
-    /**
-     * The current or target velocity of the camera.
-     */
-    localVelocity: THREE.Vector3;
-    /**
-     * Immediately stops the camera movement.
-     */
-    stop(): void;
-    /**
-     * The target at which the camera is looking at and around which it rotates.
-     */
-    get target(): THREE.Vector3;
-    /**
-     * The distance from the camera to the target.
-     */
-    get orbitDistance(): number;
-    /**
-     * Saves current camera orientation to restore on next reset.
-     */
-    save(): void;
-    /**
-     * Represents whether the camera projection is orthographic.
-     */
-    orthographic: boolean;
-}
-export declare class CameraSaveState {
-    private _camera;
-    private _position;
-    private _target;
-    constructor(camera: ICamera);
-    save(): void;
-    get position(): THREE.Vector3;
-    get target(): THREE.Vector3;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraMovement.d.ts

@@ -1,88 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import { Camera } from './camera';
-import { Element3D } from '../../loader/element3d';
-import { Selectable } from '../selection';
-import * as THREE from 'three';
-import { Vim } from '../../loader/vim';
-import { CameraSaveState } from './cameraInterface';
-export declare abstract class CameraMovement {
-    protected _camera: Camera;
-    private _savedState;
-    private _getBoundingBox;
-    constructor(camera: Camera, savedState: CameraSaveState, getBoundingBox: () => THREE.Box3);
-    /**
-     * Moves the camera by the specified 3D vector.
-     * @param {THREE.Vector3} vector - The 3D vector representing the direction and distance of movement.
-     */
-    abstract move3(vector: THREE.Vector3): void;
-    /**
-     * Moves the camera in a specified 2D direction within a plane defined by the given axes.
-     * @param {THREE.Vector2} vector - The 2D vector representing the direction of movement.
-     * @param {'XY' | 'XZ'} axes - The axes defining the plane of movement ('XY' or 'XZ').
-     */
-    move2(vector: THREE.Vector2, axes: 'XY' | 'XZ'): void;
-    /**
-     * Moves the camera along a specified axis by a given amount.
-     * @param {number} amount - The amount to move the camera.
-     * @param {'X' | 'Y' | 'Z'} axis - The axis along which to move the camera ('X', 'Y', or 'Z').
-     */
-    move1(amount: number, axis: 'X' | 'Y' | 'Z'): void;
-    /**
-     * Rotates the camera by the specified angles.
-     * @param {THREE.Vector2} angle - The 2D vector representing the rotation angles around the X and Y axes.
-     */
-    abstract rotate(angle: THREE.Vector2): void;
-    /**
-     * Changes the distance between the camera and its target by a specified factor.
-     * @param {number} amount - The factor by which to change the distance (e.g., 0.5 for halving the distance, 2 for doubling the distance).
-     */
-    abstract zoom(amount: number): void;
-    /**
-     * Zooms toward a specific point, making it the new orbit target.
-     * Preserves the camera's forward direction while moving closer/farther from the point.
-     * If point is undefined, falls back to regular zoom.
-     * @param {THREE.Vector3 | undefined} point - The world position to zoom toward, or undefined for regular zoom
-     * @param {number} amount - The zoom factor (< 1 zooms in, > 1 zooms out)
-     */
-    zoomTo(point: THREE.Vector3 | undefined, amount: number): void;
-    /**
-     * Sets the distance between the camera and its target to the specified value.
-     * @param {number} dist - The new distance between the camera and its target.
-     */
-    abstract setDistance(dist: number): void;
-    /**
-     * Orbits the camera around its target by the given angle while maintaining the distance.
-     * @param {THREE.Vector2} vector - The 2D vector representing the orbit angles around the X and Y axes.
-     */
-    abstract orbit(vector: THREE.Vector2): void;
-    /**
-     * Orbits the camera around its target to align with the given direction.
-     * @param {THREE.Vector3} direction - The direction towards which the camera should be oriented.
-     */
-    orbitTowards(direction: THREE.Vector3): void;
-    /**
-     * Rotates the camera without moving so that it looks at the specified target.
-     * @param {Element3D | THREE.Vector3} target - The target object or position to look at.
-     */
-    abstract target(target: Element3D | THREE.Vector3): void;
-    /**
-     * Resets the camera to its last saved position and orientation.
-     */
-    reset(): void;
-    /**
-     * Moves both the camera and its target to the given positions.
-     * @param {THREE.Vector3} position - The new position of the camera.
-     * @param {THREE.Vector3 | undefined} [target] - The new position of the target (optional).
-     */
-    abstract set(position: THREE.Vector3, target?: THREE.Vector3): any;
-    /**
-     * Sets the camera's orientation and position to focus on the specified target.
-     * @param {IObject | Vim | THREE.Sphere | THREE.Box3 | 'all' | undefined} target - The target object, or 'all' to frame all objects.
-     * @param {THREE.Vector3} [forward] - Optional forward direction after framing.
-     */
-    frame(target: Selectable | Vim | THREE.Sphere | THREE.Box3 | 'all' | undefined, forward?: THREE.Vector3): Promise<void>;
-    protected frameSphere(sphere: THREE.Sphere, forward?: THREE.Vector3): void;
-    private getNormalizedDirection;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraMovementLerp.d.ts

@@ -1,28 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import * as THREE from 'three';
-import { Camera } from './camera';
-import { Element3D } from '../../loader/element3d';
-import { CameraMovementSnap } from './cameraMovementSnap';
-import { CameraMovement } from './cameraMovement';
-import { CameraSaveState } from './cameraInterface';
-export declare class CameraLerp extends CameraMovement {
-    _movement: CameraMovementSnap;
-    _clock: THREE.Clock;
-    onProgress: ((progress: number) => void) | undefined;
-    _duration: number;
-    constructor(camera: Camera, movement: CameraMovementSnap, savedState: CameraSaveState, getBoundingBox: () => THREE.Box3);
-    get isLerping(): boolean;
-    init(duration: number): void;
-    cancel(): void;
-    easeOutCubic(x: number): number;
-    update(): void;
-    move3(vector: THREE.Vector3): void;
-    rotate(angle: THREE.Vector2): void;
-    zoom(amount: number): void;
-    setDistance(dist: number): void;
-    orbit(angle: THREE.Vector2): void;
-    target(target: Element3D | THREE.Vector3): Promise<void>;
-    set(position: THREE.Vector3, target?: THREE.Vector3): void;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraMovementSnap.d.ts

@@ -1,23 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import { CameraMovement } from './cameraMovement';
-import { Element3D } from '../../loader/element3d';
-import * as THREE from 'three';
-export declare class CameraMovementSnap extends CameraMovement {
-    /**
-     * Moves the camera closer or farther away from orbit target.
-     * @param amount movement size.
-     */
-    zoom(amount: number): void;
-    setDistance(dist: number): void;
-    rotate(angle: THREE.Vector2): void;
-    applyRotation(quaternion: THREE.Quaternion): void;
-    target(target: Element3D | THREE.Vector3): Promise<void>;
-    orbit(angle: THREE.Vector2): void;
-    move3(vector: THREE.Vector3): void;
-    set(position: THREE.Vector3, target?: THREE.Vector3): void;
-    private lockVector;
-    predictOrbit(angle: THREE.Vector2): THREE.Vector3;
-    predictRotate(angle: THREE.Vector2): THREE.Quaternion;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraOrthographic.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import * as THREE from 'three';
-import { ViewerSettings } from '../settings/viewerSettings';
-export declare class OrthographicCamera {
-    camera: THREE.OrthographicCamera;
-    constructor(camera: THREE.OrthographicCamera, settings: ViewerSettings);
-    frustrumSizeAt(point: THREE.Vector3): THREE.Vector2;
-    updateProjection(size: THREE.Vector2, aspect: number): void;
-}

package/dist/types/core-viewers/webgl/viewer/camera/cameraPerspective.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module viw-webgl-viewer/camera
- */
-import * as THREE from 'three';
-import { ViewerSettings } from '../settings/viewerSettings';
-export declare class PerspectiveCamera {
-    camera: THREE.PerspectiveCamera;
-    constructor(camera: THREE.PerspectiveCamera, settings: ViewerSettings);
-    updateProjection(aspect: number): void;
-    frustrumSizeAt(point: THREE.Vector3): THREE.Vector2;
-}

package/dist/types/core-viewers/webgl/viewer/camera/index.d.ts

@@ -1,7 +0,0 @@
-export type * from './camera';
-export type * from './cameraInterface';
-export type * from './cameraMovement';
-export type * from './cameraMovementLerp';
-export type * from './cameraMovementSnap';
-export type * from './cameraOrthographic';
-export type * from './cameraPerspective';

package/dist/types/core-viewers/webgl/viewer/environment/environment.d.ts

@@ -1,38 +0,0 @@
-/**
- * @module viw-webgl-viewer
- */
-import * as THREE from 'three';
-import { ViewerSettings } from '../settings/viewerSettings';
-import { ICamera } from '../camera/cameraInterface';
-import { Materials } from '../../loader/materials/materials';
-import { Skybox } from './skybox';
-import { Renderer } from '../rendering/renderer';
-import { Light } from './light';
-/**
- * Manages ground plane and lights that are part of the THREE.Scene to render but not part of the Vims.
- */
-export declare class Environment {
-    private readonly _renderer;
-    private readonly _camera;
-    /**
-     * The skylight in the scene.
-     */
-    readonly skyLight: THREE.HemisphereLight;
-    /**
-     * The array of directional lights in the scene.
-     */
-    readonly sunLights: ReadonlyArray<Light>;
-    readonly skybox: Skybox;
-    constructor(camera: ICamera, renderer: Renderer, materials: Materials, settings: ViewerSettings);
-    /**
-     * Returns all three objects composing the environment
-     */
-    private getObjects;
-    private createSkyLight;
-    private createSunLights;
-    private addObjectsToRenderer;
-    /**
-     * Dispose of all resources.
-     */
-    dispose(): void;
-}

package/dist/types/core-viewers/webgl/viewer/environment/index.d.ts

@@ -1,3 +0,0 @@
-export type * from './environment';
-export type * from './light';
-export type * from './skybox';

package/dist/types/core-viewers/webgl/viewer/environment/light.d.ts

@@ -1,43 +0,0 @@
-/**
- * @module viw-webgl-viewer
- */
-import * as THREE from 'three';
-import { ICamera } from '../camera/cameraInterface';
-export declare class Light {
-    readonly light: THREE.DirectionalLight;
-    private readonly _camera;
-    private _unsubscribe;
-    /**
-     * The position of the light.
-     */
-    position: THREE.Vector3;
-    /**
-     * The color of the light.
-     */
-    get color(): THREE.Color;
-    set color(value: THREE.Color);
-    /**
-     * The intensity of the light.
-     */
-    get intensity(): number;
-    set intensity(value: number);
-    /**
-     * Whether the light follows the camera or not.
-     */
-    get followCamera(): boolean;
-    set followCamera(value: boolean);
-    constructor(camera: ICamera, options: {
-        followCamera: boolean;
-        position: THREE.Vector3;
-        color: THREE.Color;
-        intensity: number;
-    });
-    /**
-     * Updates the light's position based on the camera's quaternion.
-     */
-    private updateLightPosition;
-    /**
-     * Disposes of the camera light.
-     */
-    dispose(): void;
-}

package/dist/types/core-viewers/webgl/viewer/environment/skybox.d.ts

@@ -1,39 +0,0 @@
-/**
- * @module viw-webgl-viewer
- */
-import * as THREE from 'three';
-import { ViewerSettings } from '../settings/viewerSettings';
-import { ICamera } from '../camera/cameraInterface';
-import { Materials } from '../../loader/materials/materials';
-import { Renderer } from '../rendering/renderer';
-export declare class Skybox {
-    readonly mesh: THREE.Mesh;
-    /**
-     * Whether the skybox is enabled or not.
-     */
-    get enable(): boolean;
-    /**
-     * Whether the skybox is enabled or not.
-     */
-    set enable(value: boolean);
-    /**
-     * The color of the sky.
-     */
-    get skyColor(): THREE.Color;
-    set skyColor(value: THREE.Color);
-    /**
-     * The color of the ground.
-     */
-    get groundColor(): THREE.Color;
-    set groundColor(value: THREE.Color);
-    /**
-     * The sharpness of the gradient transition between the sky and the ground.
-     */
-    get sharpness(): number;
-    set sharpness(value: number);
-    private readonly _plane;
-    private readonly _material;
-    private readonly _renderer;
-    constructor(camera: ICamera, renderer: Renderer, materials: Materials, settings: ViewerSettings);
-    dispose(): void;
-}

package/dist/types/core-viewers/webgl/viewer/gizmos/axes/axes.d.ts

@@ -1,14 +0,0 @@
-import * as THREE from 'three';
-import { AxesSettings } from './axesSettings';
-export declare class Axis {
-    axis: string;
-    direction: THREE.Vector3;
-    size: number;
-    color: string;
-    colorSub: string;
-    position: THREE.Vector3;
-    label: string | undefined;
-    line: number | undefined;
-    constructor(init: Axis);
-}
-export declare function createAxes(settings: AxesSettings): Axis[];

package/dist/types/core-viewers/webgl/viewer/gizmos/axes/axesSettings.d.ts

@@ -1,20 +0,0 @@
-export interface AxesSettings {
-    size: number;
-    padding: number;
-    bubbleSizePrimary: number;
-    bubbleSizeSecondary: number;
-    lineWidth: number;
-    fontPxSize: number;
-    fontFamily: string;
-    fontWeight: string;
-    fontColor: string;
-    className: string;
-    colorX: string;
-    colorY: string;
-    colorZ: string;
-    colorXSub: string;
-    colorYSub: string;
-    colorZSub: string;
-}
-export declare function getDefaultAxesSettings(): AxesSettings;
-export declare function createAxesSettings(init?: Partial<AxesSettings>): AxesSettings;

package/dist/types/core-viewers/webgl/viewer/gizmos/axes/gizmoAxes.d.ts

@@ -1,62 +0,0 @@
-/**
- * @module viw-webgl-viewer/gizmos
- */
-import { Camera } from '../../camera';
-import { Viewport } from '../../viewport';
-import { AxesSettings } from './axesSettings';
-/**
- * The axis gizmos of the viewer.
- */
-export declare class GizmoAxes {
-    private _initialOptions;
-    private _options;
-    private _camera;
-    private _canvas;
-    private _context;
-    private _rect;
-    private _reparentConnection;
-    private _resizeConnection;
-    private _axes;
-    private _resized;
-    private _pointerInside;
-    private _isDragging;
-    private _isDragSignificant;
-    private _dragStart;
-    private _dragLast;
-    private _pointer;
-    private _center;
-    private _invRotMat;
-    private _selectedAxis;
-    /**
-     * The canvas on which the axes are drawn.
-     */
-    get canvas(): HTMLCanvasElement;
-    constructor(camera: Camera, viewport: Viewport, options?: Partial<AxesSettings>);
-    reparent(parent: HTMLElement): void;
-    resize(size: number): void;
-    private createCanvas;
-    private onTouchMove;
-    private onTouchEnd;
-    private onPointerDown;
-    private onPointerUp;
-    private onPointerEnter;
-    private onPointerLeave;
-    private onPointerMove;
-    private toMouseVector;
-    private onPointerDrag;
-    private initDrag;
-    private updateDrag;
-    private endDrag;
-    private onMouseClick;
-    update: () => void;
-    private drawLayers;
-    private drawCircle;
-    private drawLine;
-    private setAxisPosition;
-    private pickAxes;
-    /**
-     * Disposes of the gizmo, removing event listeners and cleaning up resources.
-     */
-    dispose(): void;
-}
-export { GizmoAxes as OrbitControlsGizmo };

package/dist/types/core-viewers/webgl/viewer/gizmos/axes/index.d.ts

@@ -1,3 +0,0 @@
-export * from './axes';
-export * from './axesSettings';
-export * from './gizmoAxes';