vim-web 0.3.44-dev.47 → 0.3.44-dev.51

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

@@ -2,63 +2,111 @@ import { Vim } from '../../../loader/vim';
 import { Viewer } from '../../viewer';
 import * as THREE from 'three';
 import { SimpleInstanceSubmesh } from '../../../loader/mesh';
+import { IVimObject } from '../../../../shared/vim';
 /**
- * Marker gizmo that display an interactive sphere at a 3D positions
+ * Marker gizmo that displays an interactive sphere at a 3D position.
  * Marker gizmos are still under development.
  */
-export declare class GizmoMarker {
+export declare class Marker implements IVimObject {
     readonly type = "Marker";
     private _viewer;
     private _submesh;
+    private static _tmpMatrix;
+    private static _unitVector;
     /**
-     * The vim object from which this object came from.
+     * The Vim object from which this object came.
+     * Can be undefined if the object is not part of a Vim.
      */
     vim: Vim | undefined;
     /**
-     * The bim element index associated with this object.
+     * The BIM element index associated with this object.
+     * Can be undefined if the object is not part of a Vim.
      */
     element: number | undefined;
     /**
-     * The geometry instances  associated with this object.
+     * The geometry instances associated with this object.
+     * This is used when the marker is derived from multiple instances.
      */
     instances: number[] | undefined;
+    /**
+     * The index of the marker in the marker collection.
+     */
+    get index(): number;
     private _outlineAttribute;
     private _visibleAttribute;
     private _coloredAttribute;
     private _focusedAttribute;
     private _colorAttribute;
+    /**
+     * Constructs a new Marker object.
+     * @param viewer - The viewer managing rendering and interaction.
+     * @param submesh - The instanced submesh this marker is bound to.
+     */
     constructor(viewer: Viewer, submesh: SimpleInstanceSubmesh);
+    /**
+     * Updates the underlying submesh and rebinds all attributes to the new mesh.
+     * @param mesh - The new submesh to bind to this marker.
+     */
     updateMesh(mesh: SimpleInstanceSubmesh): void;
-    /** Sets the position of the marker in the 3d scene */
+    /**
+     * Sets the world position of the marker.
+     */
     set position(value: THREE.Vector3);
+    /**
+     * Gets the world position of the marker.
+     */
     get position(): THREE.Vector3;
     /**
-     * Always false
+     * Always false; marker is a gizmo and not an actual mesh.
      */
     get hasMesh(): boolean;
     /**
-     * Applies a color override instead of outlines.
+     * Gets whether the marker is outlined (highlighted).
      */
     get outline(): boolean;
+    /**
+     * Sets whether the marker is outlined (highlighted).
+     */
     set outline(value: boolean);
     /**
-     * Enlarges the gizmo to indicate focus.
+     * Gets whether the marker is focused (enlarged).
      */
     get focused(): boolean;
+    /**
+     * Sets whether the marker is focused (enlarged).
+     */
     set focused(value: boolean);
     /**
-     * Determines if the gizmo will be rendered.
+     * Gets whether the marker is visible in the scene.
      */
     get visible(): boolean;
+    /**
+     * Sets whether the marker is visible in the scene.
+     */
     set visible(value: boolean);
+    /**
+     * Gets the current color override for the marker.
+     */
     get color(): THREE.Color;
-    set color(color: THREE.Color);
+    /**
+     * Sets the color override for the marker.
+     * Passing undefined disables the override.
+     */
+    set color(color: THREE.Color | undefined);
+    /**
+     * Gets the uniform scale factor applied to the marker.
+     */
     get size(): number;
+    /**
+     * Sets the uniform scale factor for the marker.
+     * Only updates the matrix if the size has changed.
+     */
     set size(value: number);
     /**
-     * Retrieves the bounding box of the object from cache or computes it if needed.
-     * Returns a unit box arount the marker position.
-     * @returns {THREE.Box3 | undefined} The bounding box of the object.
+     * Retrieves the bounding box of the object.
+     * Returns a unit-sized box centered at the marker position.
+     * Returned as a promise to satisfy interface, but computed synchronously.
+     * @returns The bounding box of the marker.
      */
-    getBoundingBox(): THREE.Box3;
+    getBoundingBox(): Promise<THREE.Box3>;
 }

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

@@ -1,29 +1,52 @@
 import { Viewer } from '../../viewer';
 import * as THREE from 'three';
-import { GizmoMarker } from './gizmoMarker';
+import { Marker } from './gizmoMarker';
 /**
  * API for adding and managing sprite markers in the scene.
+ * Uses THREE.InstancedMesh for performance.
  */
 export declare class GizmoMarkers {
     private _viewer;
     private _markers;
     private _mesh;
+    private _reusableMatrix;
+    /**
+     * Constructs the marker manager and sets up an initial instanced mesh.
+     * @param viewer - The rendering context this marker system belongs to.
+     */
     constructor(viewer: Viewer);
-    getMarkerFromIndex(index: number): GizmoMarker;
+    /**
+     * Returns the marker at the given index.
+     * @param index - The marker index.
+     * @returns The Marker instance or undefined.
+     */
+    getMarkerFromIndex(index: number): Marker | undefined;
+    /**
+     * Creates a new instanced mesh with given capacity, optionally reusing geometry/material.
+     * @param previous - Optional mesh to reuse properties from.
+     * @param capacity - Number of instances the mesh should support.
+     * @returns A new THREE.InstancedMesh.
+     */
     private createMesh;
+    /**
+     * Doubles the mesh capacity and copies over all instance data and marker bindings.
+     */
     private resizeMesh;
     /**
      * Adds a sprite marker at the specified position.
-     * @param {THREE.Vector3} position - The position at which to add the marker.
+     * Resizes mesh if capacity is reached.
+     * @param position - The world position to add the marker at.
+     * @returns The newly created Marker.
      */
-    add(position: THREE.Vector3): GizmoMarker;
+    add(position: THREE.Vector3): Marker;
     /**
      * Removes the specified marker from the scene.
-     * @param {GizmoMarker} marker - The marker to remove.
+     * Uses swap-and-pop to maintain dense storage.
+     * @param marker - The marker to remove.
      */
-    remove(marker: GizmoMarker): void;
+    remove(marker: Marker): void;
     /**
-     * Removes all markers from the scene.
+     * Removes all markers from the scene and resets mesh count.
      */
     clear(): void;
 }

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

@@ -0,0 +1,2 @@
+export * from './gizmoMarker';
+export * from './gizmoMarkers';

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

@@ -0,0 +1,3 @@
+export * from './measure';
+export * from './measureGizmo';
+export * from './measureHtml';

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

@@ -2,7 +2,7 @@
  * @module viw-webgl-viewer/gizmos/measure
  */
 import * as THREE from 'three';
-import { RaycastResult } from '../../raycaster';
+import { IRaycastResult } from '../../raycaster';
 import { Viewer } from '../../viewer';
 /**
  * Interacts with the measure tool.
@@ -77,14 +77,15 @@ export declare class Measure implements IMeasure {
      * Do not override viewer.onMouseClick while this flow is active.
      */
     start(): Promise<void>;
+    private onClick;
     /**
      * Should be private.
      */
-    onFirstClick(hit: RaycastResult): void;
+    onFirstClick(hit: IRaycastResult): void;
     /**
      * Should be private.
      */
-    onSecondClick(hit: RaycastResult): boolean;
+    onSecondClick(hit: IRaycastResult): boolean;
     /**
      * Aborts the current measure flow, fails the related promise.
      */

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

@@ -0,0 +1,7 @@
+export * from './sectionBox';
+export * from './sectionBoxGizmo';
+export * from './sectionBoxHandle';
+export * from './sectionBoxHandles';
+export * from './sectionBoxInputs';
+export * from './SectionBoxMesh';
+export * from './sectionBoxOutline';

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

@@ -3,7 +3,7 @@ import { SectionBoxMesh } from './SectionBoxMesh';
 import { SectionBoxOutline } from './sectionBoxOutline';
 import { SectionBoxHandles } from './sectionBoxHandles';
 import { Renderer } from '../../rendering/renderer';
-import { ICamera } from '../../camera/camera';
+import { ICamera } from '../../camera';
 export declare class SectionBoxGizmo {
     private _renderer;
     readonly cube: SectionBoxMesh;

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

@@ -1,8 +1,8 @@
 import * as THREE from 'three';
-import { ICamera } from '../../camera/camera';
-export type Axis = 'x' | 'y' | 'z';
+import { ICamera } from '../../camera';
+export type AxisName = 'x' | 'y' | 'z';
 export declare class SectionBoxHandle extends THREE.Mesh {
-    readonly axis: Axis;
+    readonly axis: AxisName;
     readonly sign: number;
     private _forward;
     private _color;
@@ -10,7 +10,7 @@ export declare class SectionBoxHandle extends THREE.Mesh {
     private _materials;
     private _camera;
     private _camSub;
-    constructor(axes: Axis, sign: number, size: number, color?: THREE.Color);
+    constructor(axes: AxisName, sign: number, size: number, color?: THREE.Color);
     trackCamera(camera: ICamera): void;
     update(): void;
     setPosition(position: THREE.Vector3): void;

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

@@ -3,7 +3,7 @@
  */
 import * as THREE from 'three';
 import { SectionBoxHandle } from './sectionBoxHandle';
-import { ICamera } from '../../camera/camera';
+import { ICamera } from '../../camera';
 export declare class SectionBoxHandles {
     readonly up: SectionBoxHandle;
     readonly down: SectionBoxHandle;

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

@@ -100,13 +100,6 @@ export declare class BoxInputs {
      * @returns A **new** `Box3` instance with updated min/max coordinates.
      */
     private stretch;
-    /**
-     * Prepares the internal raycaster for a given 2D pointer position.
-     *
-     * @param position - The pointer position in canvas coordinates.
-     * @returns The updated raycaster pointing from the camera through this position.
-     */
-    private getRaycaster;
     /**
      * Raycasts into the handle meshes from the given pointer position.
      *
@@ -121,4 +114,5 @@ export declare class BoxInputs {
      * @returns The intersection point in 3D space, or `null` if none.
      */
     private raycastPlane;
+    private setupRaycaster;
 }

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

@@ -0,0 +1,10 @@
+export * from './viewer';
+export * from './settings';
+export type * from './environment';
+export type * from './gizmos';
+export type * from './raycaster';
+export { Layers } from './raycaster';
+export type * from './selection';
+export type * from './viewport';
+export type * from './rendering';
+export type * from './camera';

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

@@ -0,0 +1,3 @@
+import { InputHandler } from "../../shared/inputHandler";
+import { Viewer } from "./viewer";
+export declare function createInputHandler(viewer: Viewer): InputHandler;

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

@@ -2,36 +2,38 @@
  * @module viw-webgl-viewer
  */
 import * as THREE from 'three';
-import { Object3D } from '../loader/object3D';
+import { Element3D } from '../loader/element3d';
 import { RenderScene } from './rendering/renderScene';
 import { Camera } from './camera/camera';
 import { Renderer } from './rendering/renderer';
-import { GizmoMarker } from './gizmos/markers/gizmoMarker';
+import { Marker } from './gizmos/markers/gizmoMarker';
+import type { IRaycaster as IRaycasterBase, IRaycastResult as IRaycastResultBase } from '../../shared';
 /**
  * Type alias for an array of THREE.Intersection objects.
  */
 export type ThreeIntersectionList = THREE.Intersection<THREE.Object3D<THREE.Object3DEventMap>>[];
-export type ActionType = 'main' | 'double' | 'idle';
-export type ActionModifier = 'none' | 'shift' | 'ctrl';
+export type RaycastableObject = Element3D | Marker;
+export type IRaycastResult = IRaycastResultBase<RaycastableObject>;
+export type IRaycaster = IRaycasterBase<RaycastableObject>;
+export declare enum Layers {
+    Default = 0,
+    NoRaycast = 1
+}
 /**
- * Aggregates detailed information about a raycasting result,
- * including the intersected object and the hit details.
+ * A simple container for raycast results.
  */
-export declare class RaycastResult {
-    object: Object3D | GizmoMarker | undefined;
+export declare class RaycastResult implements IRaycastResult {
+    object: Element3D | Marker | undefined;
     intersections: ThreeIntersectionList;
     firstHit: THREE.Intersection | undefined;
-    constructor(intersections: ThreeIntersectionList);
-    private getFirstVimHit;
-    private getFirstMarkerHit;
-    private getVimObjectFromHit;
-    get isHit(): boolean;
-    get distance(): number;
-    get position(): THREE.Vector3;
-    get threeId(): number;
-    get faceIndex(): number;
+    get worldNormal(): THREE.Vector3;
+    get worldPosition(): THREE.Vector3;
+    constructor(intersections: ThreeIntersectionList, firstHit?: THREE.Intersection, object?: Element3D | Marker);
 }
-export declare class Raycaster {
+/**
+ * Performs raycasting operations.
+ */
+export declare class Raycaster implements IRaycaster {
     private _camera;
     private _scene;
     private _renderer;
@@ -40,39 +42,28 @@ export declare class Raycaster {
     /**
      * Performs a raycast from the camera using normalized screen coordinates.
      * Coordinates must be within [0, 1] for both x and y.
-     * If the coordinates are out of bounds, an error is logged and an empty result is returned.
-     *
-     * @param {THREE.Vector2} position - The normalized screen position for raycasting.
      */
-    raycastFromScreen(position: THREE.Vector2): RaycastResult;
-    private filterHits;
+    raycastFromScreen(position: THREE.Vector2): Promise<RaycastResult>;
     /**
      * Performs a raycast from the camera towards a specified world position.
-     *
-     * @param {THREE.Vector3} position - The target world position for raycasting.
      */
-    raycastFromWorld(position: THREE.Vector3): RaycastResult;
+    raycastFromWorld(position: THREE.Vector3): Promise<RaycastResult>;
+    private filterHits;
     /**
-     * Performs a raycast starting from the camera's current target position.
+     * Processes the list of intersections to determine the first valid hit.
+     * It first checks for a marker hit, then for a model object hit.
      */
-    raycastForward(): RaycastResult;
+    private processIntersections;
     /**
-     * Creates and returns a THREE.Raycaster that casts a ray from the camera's position
-     * through the provided normalized screen coordinate (x and y in the range [0, 1]).
-     *
-     * @param {THREE.Vector2} position - The normalized screen position for raycasting.
-     * @param {THREE.Raycaster} target - Optional existing raycaster instance to update.
-     * @returns {THREE.Raycaster} A configured raycaster for performing raycasting.
+     * Extracts the core model object from a raycast hit.
      */
-    fromPoint2(position: THREE.Vector2, target?: THREE.Raycaster): THREE.Raycaster;
+    private getVimObjectFromHit;
     /**
-     * Creates and returns a THREE.Raycaster that casts a ray from the camera's position
-     * towards the specified world position.
-     * The ray's direction is computed as the normalized vector from the camera position to the target position.
-     *
-     * @param {THREE.Vector3} position - The world position for raycasting.
-     * @param {THREE.Raycaster} target - Optional existing raycaster instance to update.
-     * @returns {THREE.Raycaster} A configured raycaster for performing raycasting.
+     * Creates a WebglRaycastResult from a list of intersections by processing the hits.
      */
-    fromPoint3(position: THREE.Vector3, target?: THREE.Raycaster): THREE.Raycaster;
+    private createResultFromIntersections;
 }
+/**
+ * Converts normalized screen coordinates (0-1 range) into Three.js NDC ([-1, 1] range).
+ */
+export declare function threeNDCFromVector2(position: THREE.Vector2): THREE.Vector2;

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

@@ -0,0 +1,4 @@
+export type * from './renderingSection';
+export type * from './renderer';
+export type * from './renderScene';
+export type * from './renderingComposer';

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

@@ -3,14 +3,14 @@
  */
 import * as THREE from 'three';
 import { Pass } from 'three/examples/jsm/postprocessing/Pass';
-import { ViewerMaterials } from '../../loader/materials/viewerMaterials';
+import { Materials } from '../../loader/materials/materials';
 /**
  * Merges a source buffer into the the current write buffer.
  */
 export declare class MergePass extends Pass {
     private _fsQuad;
     private _material;
-    constructor(source: THREE.Texture, materials?: ViewerMaterials);
+    constructor(source: THREE.Texture, materials?: Materials);
     get source(): THREE.Texture;
     set source(value: THREE.Texture);
     dispose(): void;

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

@@ -2,26 +2,26 @@
  * @module viw-webgl-viewer/rendering
  */
 import * as THREE from 'three';
-import { Scene } from '../../loader/scene';
-import { ModelMaterial } from '../../loader/materials/viewerMaterials';
+import { WebglScene } from '../../loader/scene';
+import { ModelMaterial } from '../../loader/materials/materials';
 import { InstancedMesh } from '../../loader/progressive/instancedMesh';
 /**
  * Wrapper around the THREE scene that tracks bounding box and other information.
  */
 export declare class RenderScene {
-    scene: THREE.Scene;
+    threeScene: THREE.Scene;
     boxUpdated: boolean;
     smallGhostThreshold: number | undefined;
     private _vimScenes;
     private _boundingBox;
     private _memory;
     private _2dCount;
+    private _outlineCount;
     private _modelMaterial;
-    get meshes(): (import("../..").InsertableMesh | import("../../loader/mesh").Mesh | InstancedMesh)[];
+    get meshes(): (import("../..").InsertableMesh | import("../..").WebglMesh | InstancedMesh)[];
     constructor();
     get estimatedMemory(): number;
     has2dObjects(): boolean;
-    hasOutline(): boolean;
     /** Clears the scene updated flags */
     clearUpdateFlags(): void;
     /**
@@ -37,13 +37,13 @@ export declare class RenderScene {
     /**
      * Add object to be rendered
      */
-    add(target: Scene | THREE.Object3D): void;
+    add(target: WebglScene | THREE.Object3D): void;
     private count2dObjects;
     private unparent2dObjects;
     /**
      * Remove object from rendering
      */
-    remove(target: Scene | THREE.Object3D): void;
+    remove(target: WebglScene | THREE.Object3D): void;
     /**
      * Removes all rendered objects
      */

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

@@ -2,10 +2,10 @@
  * @module viw-webgl-viewer/rendering
  */
 import * as THREE from 'three';
-import { IRenderer, Scene } from '../../loader/scene';
+import { IRenderer, WebglScene } from '../../loader/scene';
 import { Viewport } from '../viewport';
 import { RenderScene } from './renderScene';
-import { ModelMaterial, ViewerMaterials } from '../../loader/materials/viewerMaterials';
+import { ModelMaterial, Materials } from '../../loader/materials/materials';
 import { CSS2DRenderer } from 'three/examples/jsm/renderers/CSS2DRenderer';
 import { Camera } from '../camera/camera';
 import { RenderingSection } from './renderingSection';
@@ -41,6 +41,7 @@ export declare class Renderer implements IRenderer {
     private _onBoxUpdated;
     private _sceneUpdated;
     private maxMemory;
+    private _outlineCount;
     /**
      * Indicates whether the scene should be re-rendered on change only.
      */
@@ -51,7 +52,7 @@ export declare class Renderer implements IRenderer {
      */
     get needsUpdate(): boolean;
     set needsUpdate(value: boolean);
-    constructor(scene: RenderScene, viewport: Viewport, materials: ViewerMaterials, camera: Camera, settings: ViewerSettings);
+    constructor(scene: RenderScene, viewport: Viewport, materials: Materials, camera: Camera, settings: ViewerSettings);
     /**
      * Removes all objects from rendering and disposes the WebGL context.
      */
@@ -93,6 +94,8 @@ export declare class Renderer implements IRenderer {
      * Notifies that a scene was updated this frame.
      */
     notifySceneUpdate(): void;
+    addOutline(): void;
+    removeOutline(): void;
     /**
      * Renders what is in the camera's view.
      */
@@ -101,12 +104,12 @@ export declare class Renderer implements IRenderer {
      * Adds an object to be rendered.
      * @param target The object or scene to add for rendering.
      */
-    add(target: Scene | THREE.Object3D): boolean;
+    add(target: WebglScene | THREE.Object3D): boolean;
     /**
      * Removes an object from rendering.
      * @param target The object or scene to remove from rendering.
      */
-    remove(target: Scene | THREE.Object3D): void;
+    remove(target: WebglScene | THREE.Object3D): void;
     /**
      * Clears all objects from rendering.
      */

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

@@ -4,7 +4,7 @@
 import * as THREE from 'three';
 import { Viewport } from '../viewport';
 import { RenderScene } from './renderScene';
-import { ViewerMaterials } from '../../loader/materials/viewerMaterials';
+import { Materials } from '../../loader/materials/materials';
 import { Camera } from '../camera/camera';
 /**
  * Composer for managing the rendering pipeline including anti-aliasing and outline effects.
@@ -39,7 +39,7 @@ export declare class RenderingComposer {
      * @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: ViewerMaterials, camera: Camera);
+    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

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

@@ -2,7 +2,7 @@
  * @module viw-webgl-viewer/rendering
  */
 import * as THREE from 'three';
-import { ViewerMaterials } from '../../loader/materials/viewerMaterials';
+import { Materials } from '../../loader/materials/materials';
 import { Renderer } from './renderer';
 /**
  * Manages a section box from renderer clipping planes
@@ -22,7 +22,7 @@ export declare class RenderingSection {
     private maxZ;
     private minZ;
     private planes;
-    constructor(renderer: Renderer, materials: ViewerMaterials);
+    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.