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

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

@@ -1,95 +0,0 @@
-/**
- * @module viw-webgl-viewer/rendering
- */
-import * as THREE from 'three';
-import { Viewport } from '../viewport';
-import { RenderScene } from './renderScene';
-import { Materials } from '../../loader/materials/materials';
-import { Camera } from '../camera/camera';
-/**
- * Composer for managing the rendering pipeline including anti-aliasing and outline effects.
- * Handles the orchestration of multiple render passes including:
- * - Main scene rendering
- * - Selection outline rendering
- * - FXAA anti-aliasing
- * - Final composition and screen output
- */
-export declare class RenderingComposer {
-    private _renderer;
-    private _scene;
-    private _materials;
-    private _camera;
-    private _size;
-    private _composer;
-    private _renderPass;
-    private _selectionRenderPass;
-    private _transferPass;
-    private _outlineFxaaPass;
-    private _outlines;
-    private _clock;
-    private _outlinePass;
-    private _mergePass;
-    private _outlineTarget;
-    private _sceneTarget;
-    /**
-     * Creates a new RenderingComposer instance
-     * @param renderer - The WebGL renderer instance
-     * @param scene - The scene to be rendered
-     * @param viewport - The viewport containing size information
-     * @param materials - Materials used for rendering including outline and mask materials
-     * @param camera - The camera used for rendering
-     */
-    constructor(renderer: THREE.WebGLRenderer, scene: RenderScene, viewport: Viewport, materials: Materials, camera: Camera);
-    /**
-     * Initializes the main scene rendering pipeline
-     * Creates render targets and sets up the main render pass
-     * @private
-     */
-    private initSceneRenderingPipeline;
-    /**
-     * Initializes the outline rendering pipeline
-     * Sets up render targets and passes for selection, outline, FXAA, and final composition
-     * @private
-     */
-    private initOutlinePipeline;
-    /**
-     * @returns Whether outline rendering is enabled
-     */
-    get outlines(): boolean;
-    /**
-     * Enables or disables outline rendering
-     */
-    set outlines(value: boolean);
-    /**
-     * @returns The current camera
-     */
-    get camera(): THREE.PerspectiveCamera | THREE.OrthographicCamera;
-    /**
-     * Updates the camera across all render passes
-     */
-    set camera(value: THREE.PerspectiveCamera | THREE.OrthographicCamera);
-    /**
-     * Updates the size of all render targets and passes
-     * @param width - New width in pixels
-     * @param height - New height in pixels
-     */
-    setSize(width: number, height: number): void;
-    /**
-     * @returns The current MSAA sample count
-     */
-    get samples(): number;
-    /**
-     * Sets the MSAA sample count for the scene render target
-     */
-    set samples(value: number);
-    /**
-     * Executes the complete rendering pipeline
-     * First renders the main scene, then processes outlines if enabled
-     */
-    render(): void;
-    /**
-     * Cleans up all resources used by the composer
-     * Should be called when the composer is no longer needed
-     */
-    dispose(): void;
-}

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

@@ -1,40 +0,0 @@
-/**
- * @module viw-webgl-viewer/rendering
- */
-import * as THREE from 'three';
-import { Materials } from '../../loader/materials/materials';
-import { Renderer } from './renderer';
-/**
- * Manages a section box from renderer clipping planes
- */
-export declare class RenderingSection {
-    private _renderer;
-    private _materials;
-    private _active;
-    /**
-     * Current section box. To update the box use fitbox.
-     */
-    readonly box: THREE.Box3;
-    private maxX;
-    private minX;
-    private maxY;
-    private minY;
-    private maxZ;
-    private minZ;
-    private planes;
-    constructor(renderer: Renderer, materials: Materials);
-    /**
-     * Resizes the section box to match the dimensions of the provided bounding box.
-     * @param box The bounding box to match the section box to.
-     */
-    fitBox(box: THREE.Box3): void;
-    /**
-     * Determines whether objecets outside the section box will be culled or not.
-     */
-    set active(value: boolean);
-    get active(): boolean;
-    /**
-     * Returns the clipping planes used for section box culling.
-     */
-    get clippingPlanes(): THREE.Plane[];
-}

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

@@ -1,17 +0,0 @@
-/**
- * @module viw-webgl-viewer/rendering
- */
-import * as THREE from 'three';
-import { Pass } from 'three/examples/jsm/postprocessing/Pass';
-/**
- * Copies a source buffer to the current write buffer.
- */
-export declare class TransferPass extends Pass {
-    private _fsQuad;
-    private _uniforms;
-    constructor(sceneTexture: THREE.Texture);
-    get source(): THREE.Texture;
-    set source(value: THREE.Texture);
-    dispose(): void;
-    render(renderer: THREE.WebGLRenderer, writeBuffer: THREE.WebGLRenderTarget, readBuffer: THREE.WebGLRenderTarget): void;
-}

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

@@ -1,9 +0,0 @@
-/**
- * @module viw-webgl-viewer
- */
-import { Marker } from './gizmos/markers/gizmoMarker';
-import { Element3D } from '../loader/element3d';
-import { Selection } from '../../shared/selection';
-export type Selectable = Element3D | Marker;
-export type ISelection = Selection<Selectable>;
-export declare function createSelection(): Selection<Selectable>;

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

@@ -1,3 +0,0 @@
-export * from './viewerDefaultSettings';
-export * from './viewerSettings';
-export * from './viewerSettingsParsing';

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

@@ -1,5 +0,0 @@
-import { ViewerSettings } from './viewerSettings';
-/**
- * Defines the default values for the VIM Viewer settings.
- */
-export declare function getDefaultViewerSettings(): ViewerSettings;

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

@@ -1,310 +0,0 @@
-/**
- @module viw-webgl-viewer
-*/
-import * as THREE from 'three';
-import { AxesSettings } from '../gizmos/axes/axesSettings';
-import { RecursivePartial } from '../../../../utils/partial';
-export type TextureEncoding = 'url' | 'base64' | undefined;
-/** Viewer related options independant from vims */
-export type ViewerSettings = {
-    /**
-     * Webgl canvas related options
-     */
-    canvas: {
-        /**
-         * Canvas dom model id. If none provided a new canvas will be created
-         * Default: undefined.
-         */
-        id: string | undefined;
-        /**
-         * Limits how often canvas will be resized if window is resized in ms.
-         * Default: 200
-         */
-        resizeDelay: number;
-    };
-    /**
-     * Three.js camera related options
-     */
-    camera: {
-        /**
-         * Start with orthographic camera
-         * Default: false
-         */
-        orthographic: boolean;
-        /**
-         * Vector3 of 0 or 1 to enable/disable movement along each axis
-         * Default: THREE.Vector3(1, 1, 1)
-         */
-        allowedMovement: THREE.Vector3;
-        /**
-         * Vector2 of 0 or 1 to enable/disable rotation around x or y.
-         * Default: THREE.Vector2(1, 1)
-         */
-        allowedRotation: THREE.Vector2;
-        /**
-         * Near clipping plane distance
-         * Default: 0.01
-         */
-        near: number;
-        /**
-         * Far clipping plane distance
-         * Default: 15000
-         */
-        far: number;
-        /**
-         * Fov angle in degrees
-         * Default: 50
-         */
-        fov: number;
-        /**
-         * Camera zoom level
-         * Default: 1
-         */
-        zoom: number;
-        /**
-         * Initial forward vector of the camera
-         * THREE.Vector3(1, -1, 1)
-         */
-        forward: THREE.Vector3;
-        /** Camera controls related options */
-        controls: {
-            /**
-             * <p>Set true to start in orbit mode.</p>
-             * <p>Camera has two modes: First person and orbit</p>
-             * <p>First person allows to moves the camera around freely</p>
-             * <p>Orbit rotates the camera around a focus point</p>
-             * Default: true
-             */
-            orbit: boolean;
-            /**
-             * Camera rotation speed factor
-             * Default: 1
-             */
-            rotateSpeed: number;
-            /**
-             * Camera orbit rotation speed factor.
-             * Default: 1
-             */
-            orbitSpeed: number;
-            /**
-             * Camera movement speed factor
-             * Default: 1
-             */
-            moveSpeed: number;
-            /**
-             * Camera movement speed factor on mouse scroll
-             * Default: 1
-             * Range: [0.1, 10]
-             */
-            scrollSpeed: number;
-        };
-        /** Camera gizmo related options */
-        gizmo: {
-            /**
-            * Enables/Disables camera gizmo.
-            * Default: true
-            */
-            enable: boolean;
-            /**
-            * Size of camera gizmo as fraction of screen (0-1).
-            * Default: 0.1
-            */
-            size: number;
-            /**
-            * Color of vertical rings (great circles).
-            * Default: THREE.Color(0x0590cc) - VIM blue
-            */
-            color: THREE.Color;
-            /**
-            * Color of horizontal rings (latitude circles).
-            * Default: THREE.Color(0x58b5dd) - Primary_300
-            */
-            colorHorizontal: THREE.Color;
-            /**
-            * Opacity of the camera gizmo when in front of objects.
-            * Default: 0.5
-            */
-            opacity: number;
-            /**
-            * Opacity of the camera gizmo when behind objects.
-            * Default: 0.1
-            */
-            opacityAlways: number;
-        };
-    };
-    /**
-     * Rendering background options
-     */
-    background: {
-        /**
-         * Color of the cavas background
-         * Default: THREE.Color('#96999f')
-         */
-        color: THREE.Color;
-    };
-    /**
-     * Skybox options
-     */
-    skybox: {
-        /**
-         * Enables/Disables skybox.
-         */
-        enable: boolean;
-        /**
-         * Color for the lower part of the skybox.
-         */
-        groundColor: THREE.Color;
-        /**
-         * Color for the upper part of the skybox.
-         */
-        skyColor: THREE.Color;
-        /**
-         * Controls the gradient transition between the sky and the ground.
-         */
-        sharpness: number;
-    };
-    /**
-    * Object highlight on click options
-    */
-    materials: {
-        /**
-        * Default color of standard material
-        */
-        standard: {
-            color: THREE.Color;
-        };
-        /**
-        * Highlight on hover options
-        */
-        highlight: {
-            /**
-            * Highlight color
-            * Default: rgb(106, 210, 255)
-            */
-            color: THREE.Color;
-            /**
-            * Highlight opacity
-            * Default: 0.5
-            */
-            opacity: number;
-        };
-        /**
-        * Ghost material options
-        */
-        ghost: {
-            /**
-            * Ghost material color
-            * Default: rgb(78, 82, 92)
-            */
-            color: THREE.Color;
-            /**
-            * Ghost material opacity
-            * Default: 0.08
-            */
-            opacity: number;
-        };
-        /**
-        * Section box intersection highlight options
-        */
-        section: {
-            /**
-            * Intersection highlight stroke width.
-            * Default: 0.01
-            */
-            strokeWidth: number;
-            /**
-            * Intersection highlight stroke falloff.
-            * Default: 0.75
-            */
-            strokeFalloff: number;
-            /**
-            * Intersection highlight stroke color.
-            * Default: rgb(246, 246, 246)
-            */
-            strokeColor: THREE.Color;
-        };
-        /**
-        * Selection outline options
-        */
-        outline: {
-            /**
-            * Enable antialiasing for the outline.
-            * Default: false
-            */
-            antialias: boolean;
-            /**
-            * Selection outline intensity.
-            * Default: 3
-            */
-            intensity: number;
-            /**
-            * Selection outline falloff.
-            * Default: 3
-            */
-            falloff: number;
-            /**
-            * Selection outline blur.
-            * Default: 2
-            */
-            blur: number;
-            /**
-            * Selection outline color.
-            * Default: rgb(0, 255, 255)
-            */
-            color: THREE.Color;
-        };
-    };
-    /**
-     * Axes gizmo options
-     */
-    axes: Partial<AxesSettings>;
-    /**
-     * Skylight (hemisphere light) options
-     */
-    skylight: {
-        /**
-        * Skylight sky Color.
-        * Default: THREE.Color(153, 204, 255)
-        */
-        skyColor: THREE.Color;
-        /**
-        * Skylight ground color.
-        * Default: THREE.Color(242, 213, 181)
-        */
-        groundColor: THREE.Color;
-        /**
-        * Skylight intensity.
-        * Default: 0.8
-        */
-        intensity: number;
-    };
-    /**
-     * Sunlight (directional light) options
-     * Two Blue-Green lights at odd angles. See defaultViewerSettings.
-     */
-    sunlights: {
-        followCamera: boolean;
-        /** Light position. */
-        position: THREE.Vector3;
-        /** Light color. */
-        color: THREE.Color;
-        /** Light intensity. */
-        intensity: number;
-    }[];
-    rendering: {
-        /**
-         * Enable on-demand rendering which wait for changes before rendering to the canvas.
-         * Default: true
-         */
-        onDemand: boolean;
-    };
-};
-/**
- * Same as the Setting type but any field can be undefined.
- */
-export type PartialViewerSettings = RecursivePartial<ViewerSettings>;
-/**
- * Returns a full viewer settings where all unassigned values are replaced with the default values.
- * @param settings optional values to use instead of default.
- */
-export declare function createViewerSettings(settings?: PartialViewerSettings): ViewerSettings;

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

@@ -1,9 +0,0 @@
-import { PartialViewerSettings } from './viewerSettings';
-/**
- * Parses the url for settings and merges the result with the optional provided settings.
- * URL settings have priority
- * @param settings Settings to use if not defined in the url.
- * @param url URL string with standard parameters.
- * @returns A PartialSettings object that can further be merged with default values.
- */
-export declare function createViewerSettingsFromUrl(url?: string, settings?: PartialViewerSettings): PartialViewerSettings;

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

@@ -1,115 +0,0 @@
-/**
- @module viw-webgl-viewer
-*/
-import { Camera } from './camera/camera';
-import { Environment } from './environment/environment';
-import { Gizmos } from './gizmos/gizmos';
-import { IRaycaster } from './raycaster';
-import { ISelection } from './selection';
-import { PartialViewerSettings, ViewerSettings } from './settings/viewerSettings';
-import { Viewport } from './viewport';
-import { ISignal } from 'ste-signals';
-import type { InputHandler } from '../../shared';
-import { Materials } from '../loader/materials/materials';
-import { Vim } from '../loader/vim';
-import { Renderer } from './rendering/renderer';
-/**
- * Viewer and loader for vim files.
- */
-export declare class Viewer {
-    /**
-     * The type of the viewer, indicating it is a WebGL viewer.
-     * Useful for distinguishing between different viewer types in a multi-viewer application.
-     */
-    readonly type = "webgl";
-    /**
-     * The settings configuration used by the viewer.
-     */
-    readonly settings: ViewerSettings;
-    /**
-     * The renderer used by the viewer for rendering scenes.
-     */
-    readonly renderer: Renderer;
-    /**
-     * The interface for managing the HTML canvas viewport.
-     */
-    readonly viewport: Viewport;
-    /**
-     * The interface for managing viewer selection.
-     */
-    readonly selection: ISelection;
-    /**
-     * The interface for manipulating default viewer inputs.
-     */
-    readonly inputs: InputHandler;
-    /**
-     * The interface for performing raycasting into the scene to find objects.
-     */
-    readonly raycaster: IRaycaster;
-    /**
-     * The materials used by the viewer to render the vims.
-     */
-    readonly materials: Materials;
-    /**
-     * The environment of the viewer, including the ground plane and lights.
-     */
-    readonly environment: Environment;
-    /**
-     * The interface for manipulating the viewer's camera.
-     */
-    get camera(): Camera;
-    /**
-     * The collection of gizmos available for visualization and interaction within the viewer.
-     */
-    gizmos: Gizmos;
-    /**
-     * A signal that is dispatched when a new Vim object is loaded or unloaded.
-     */
-    get onVimLoaded(): ISignal;
-    private _camera;
-    private _clock;
-    private _vimCollection;
-    private _onVimLoaded;
-    private _updateId;
-    constructor(settings?: PartialViewerSettings);
-    private animate;
-    /**
-     * Retrieves an array containing all currently loaded Vim objects.
-     * @returns {Vim[]} An array of all Vim objects currently loaded in the viewer.
-     */
-    get vims(): Vim[];
-    /**
-     * The number of Vim objects currently loaded in the viewer.
-     */
-    get vimCount(): number;
-    /**
-     * Allocates a stable ID for a new vim to be loaded.
-     * The ID persists for the vim's lifetime and is used for GPU picking.
-     * @returns The allocated ID (0-255), or undefined if all 256 slots are in use
-     */
-    allocateVimId(): number | undefined;
-    /**
-     * Whether the viewer has reached maximum capacity (256 vims).
-     */
-    get isVimsFull(): boolean;
-    /**
-     * Adds a Vim object to the renderer, triggering the appropriate actions and dispatching events upon successful addition.
-     * @param {Vim} vim - The Vim object to add to the renderer.
-     * @throws {Error} If the Vim object is already added or if loading the Vim would exceed maximum geometry memory.
-     */
-    add(vim: Vim): void;
-    /**
-     * Unloads the given Vim object from the viewer, updating the scene and triggering necessary actions.
-     * @param {Vim} vim - The Vim object to remove from the viewer.
-     * @throws {Error} If attempting to remove a Vim object that is not present in the viewer.
-     */
-    remove(vim: Vim): void;
-    /**
-     * Removes all Vim objects from the viewer, clearing the scene.
-     */
-    clear(): void;
-    /**
-     * Cleans up and releases resources associated with the viewer.
-     */
-    dispose(): void;
-}

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

@@ -1,73 +0,0 @@
-/**
- @module viw-webgl-viewer
-*/
-import * as THREE from 'three';
-import { CSS2DRenderer } from 'three/examples/jsm/renderers/CSS2DRenderer';
-import { ViewerSettings } from './settings/viewerSettings';
-export declare class Viewport {
-    /**
-     *  HTML Canvas on which the model is rendered
-     */
-    readonly canvas: HTMLCanvasElement;
-    /** HTML Element in which text is rendered */
-    readonly textRenderer: CSS2DRenderer;
-    get text(): HTMLElement;
-    private _unregisterResize;
-    private _ownedCanvas;
-    private _onResize;
-    private _onReparent;
-    /**
-     * Signal dispatched when the canvas reparented.
-     */
-    get onReparent(): import("ste-signals").ISignal;
-    /**
-     * Signal dispatched when the canvas is resized.
-     */
-    get onResize(): import("ste-signals").ISignal;
-    /**
-     * Constructs a new instance of the class with the provided settings.
-     * @param {ViewerSettings} settings The settings object defining viewer configurations.
-     */
-    constructor(settings: ViewerSettings);
-    /**
-     * Either returns html canvas at provided Id or creates a canvas at root level
-     */
-    private static getOrCreateCanvas;
-    private static createCanvas;
-    /** Returns a text renderer that will render html in an html element sibbling to canvas */
-    private createTextRenderer;
-    get parent(): HTMLElement;
-    reparent(parent: HTMLElement): void;
-    /**
-     * Removes the canvas if it's owned by the viewer.
-     */
-    dispose(): void;
-    /**
-     * Returns the pixel size of the parent element.
-     * @returns {THREE.Vector2} The pixel size of the parent element.
-     */
-    getParentSize(): THREE.Vector2;
-    private getParentWidth;
-    private getParentHeight;
-    /**
-     * Returns the pixel size of the canvas.
-     * @returns {THREE.Vector2} The pixel size of the canvas.
-     */
-    getSize(): THREE.Vector2;
-    /**
-     * Calculates and returns the aspect ratio of the parent element.
-     * @returns {number} The aspect ratio (width divided by height) of the parent element.
-     */
-    getAspectRatio(): number;
-    /**
-     * Resizes the canvas and updates the camera to match new parent dimensions.
-     */
-    resizeToParent(): void;
-    /**
-     * Set a callback for canvas resize with debouncing
-     * https://stackoverflow.com/questions/5825447/javascript-event-for-canvas-resize/30688151
-     * @param callback code to be called
-     * @param timeout time after the last resize before code will be called
-     */
-    private watchResize;
-}

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * as Core from './core-viewers';
-export * as React from './react-viewers';
-export * as THREE from 'three';

package/dist/types/react-viewers/bim/bimInfoBody.d.ts

@@ -1,9 +0,0 @@
-import * as BIM from './bimInfoData';
-import { BimInfoPanelRef } from './bimInfoData';
-/**
- * Represents the details of a BIM object.
- */
-export declare function BimBody(props: {
-    bimInfoRef: BimInfoPanelRef;
-    sections: BIM.Section[];
-}): import("react/jsx-runtime").JSX.Element;