@x-viewer/core 0.21.11 → 0.21.13

package/dist/types/core/components/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./Spinner";
 export * from "./Container";
 export * from "./ProgressBar";
-export * from "./Watermark";

package/dist/types/core/effect/EffectManager.d.ts

@@ -1,5 +1,5 @@
 import * as THREE from "three";
-import { type BaseViewer } from "../viewers";
+import type { BaseViewer } from "../viewers/BaseViewer";
 /**
  * Visual effect manager for viewers.
  */
@@ -15,6 +15,8 @@ export declare class EffectManager {
     private ssaaRenderPass?;
     private bloomPass?;
     private unrealBloomPass?;
+    /** Last pass: tone mapping + output color space (composer RT is linear / half-float). */
+    private composerOutputPass?;
     private vertexNormalsHelpers?;
     constructor(viewer: BaseViewer);
     get enabled(): boolean;
@@ -66,4 +68,14 @@ export declare class EffectManager {
     private syncPostprocessingCamera;
     render(): void;
     destroy(): void;
+    private createWatermarkPass;
+    /** Creates the watermark pass, enables it, and applies the default text and layout. */
+    private initWatermark;
+    private syncWatermarkResolution;
+    private ensureComposerOutputPass;
+    /**
+     * Keep {@link composerOutputPass} last (screen output), and the GLSL watermark pass immediately before it
+     * so it composites in linear space; OutputPass applies renderer tone mapping and output color space to the canvas.
+     */
+    private ensurePostprocessPassOrder;
 }

package/dist/types/core/effect/WatermarkShader.d.ts

@@ -0,0 +1,33 @@
+import * as THREE from "three";
+/**
+ * Full-screen composite: draws {@link tWatermark} in the top-left region over {@link tDiffuse}.
+ * Replace `tWatermark` with your texture; keep alpha for blending.
+ */
+export declare const WatermarkShader: {
+    name: string;
+    uniforms: {
+        tDiffuse: {
+            value: null;
+        };
+        tWatermark: {
+            value: null;
+        };
+        uResolution: {
+            value: THREE.Vector2;
+        };
+        /** Left and top margin in pixels. */
+        uMarginPx: {
+            value: THREE.Vector2;
+        };
+        /** Draw region size in pixels (image is stretched to this rect). */
+        uAreaPx: {
+            value: THREE.Vector2;
+        };
+        /** Extra multiplier on texture alpha (0–1). */
+        uOpacity: {
+            value: number;
+        };
+    };
+    vertexShader: string;
+    fragmentShader: string;
+};

package/dist/types/core/text-texture/TextTexture.d.ts

@@ -16,6 +16,11 @@ export interface TextTextureConfig {
     padding?: number;
     strokeColor?: string;
     strokeWidth?: number;
+    /**
+     * When true, clears the canvas to transparent instead of filling {@link backgroundColor}.
+     * Use for overlays (e.g. GLSL watermarks) where only the glyphs should be visible.
+     */
+    clearBackground?: boolean;
 }
 export declare function toCssFont(family: string, size: number, style: string, variant: string, weight: string): string;
 export declare class TextTexture extends THREE.Texture {

package/dist/types/core/viewers/BaseViewer.d.ts

@@ -3,11 +3,12 @@ import { CSS2DRenderer } from "three/examples/jsm/renderers/CSS2DRenderer.js";
 import { ViewerName } from "./Constants";
 import type { Plugin } from "./Plugin";
 import { ViewerEvent } from "./ViewerEvent";
-import { ProgressBar, Spinner, Watermark } from "../components";
+import { ProgressBar, Spinner } from "../components";
 import { BaseViewerConfig, CameraInfo, CameraProjection, ModelConfig, Viewpoint } from "../../core/Configs";
 import { CameraManager } from "../../core/camera";
 import { CanvasRender } from "../../core/canvas";
 import { Container } from "../../core/components/Container";
+import { EffectManager } from "../../core/effect";
 import { FontManager } from "../../core/font";
 import { ZoomToRectHelper } from "../../core/helpers";
 import { InputManager } from "../../core/input-manager";
@@ -44,7 +45,6 @@ export declare abstract class BaseViewer<BaseViewerEvents extends ViewerEvents =
     protected css2dRenderer: CSS2DRenderer;
     protected spinner: Spinner;
     protected progressBar?: ProgressBar;
-    protected watermark?: Watermark;
     protected loaderManager: ModelLoaderManager;
     protected zoomToRectHelper?: ZoomToRectHelper;
     protected interaction?: Interaction;
@@ -86,6 +86,13 @@ export declare abstract class BaseViewer<BaseViewerEvents extends ViewerEvents =
     abstract clearHighlight(): void;
     getRaycaster(): THREE.Raycaster;
     getPickManager(): PickManager;
+    /**
+     * Post-processing (GLSL watermark, optional FXAA/SSAO, …). Shared by 2D and 3D viewers.
+     * Created on first access so construction never runs before {@link BaseViewer.cameraManager} exists.
+     */
+    protected get effect(): EffectManager;
+    /** Visual effects / composer (same instance as {@link BaseViewer.effect}). */
+    get effectManager(): EffectManager;
     getViewerConfig(): BaseViewerConfig;
     getSpinner(): Spinner;
     getFontManager(): FontManager | undefined;

package/dist/types/core/viewers/BimTilesViewer.d.ts

@@ -2,7 +2,6 @@ import * as THREE from "three";
 import { BaseViewer } from "./BaseViewer";
 import { ViewerName } from "./Constants";
 import { Viewer3dConfig, ModelConfig, Viewpoint } from "../../core/Configs";
-import { EffectManager } from "../../core/effect";
 import { EventInfo } from "../../core/input-manager/InputManager";
 import { BimTilesModel, TileObject } from "../../core/model";
 /**
@@ -11,7 +10,6 @@ import { BimTilesModel, TileObject } from "../../core/model";
 export declare class BimTilesViewer extends BaseViewer {
     name: ViewerName;
     protected pickUsageScene: THREE.Scene;
-    protected effect: EffectManager;
     loadedModels: BimTilesModel[];
     selectedObject?: TileObject;
     /**
@@ -55,6 +53,8 @@ export declare class BimTilesViewer extends BaseViewer {
     setDoubleSidedMaterials(): void;
     revertDoubleSidedMaterials(): void;
     clearSelection(): void;
+    /** True when the user has an active tile pick selection (independent of the current cursor hit). */
+    hasSelectedObject(): boolean;
     /**
      * Gets if selection is enabled.
      */
@@ -114,6 +114,11 @@ export declare class BimTilesViewer extends BaseViewer {
      * First get the object through the gpu, and then get the specific intersection point
      */
     pickObjects(mousePosition: THREE.Vector2, layerChannels?: number[]): THREE.Intersection<THREE.Object3D<THREE.Object3DEventMap>>[];
+    /**
+     * GPU pick on the BimTiles compositing pass (same as pointer interaction). Call before reading picking buffer.
+     * @returns `{ tilesetId, userId }` when a tile was hit, otherwise `undefined`.
+     */
+    pickTileObject(mousePosition: THREE.Vector2): TileObject | undefined;
     /**
      * `errorTarget` refers to The target screenspace error in pixels to target when updating the geometry.
      * It represents the maximum acceptable error in pixels for the tiles' geometry.

package/dist/types/core/viewers/Viewer3d.d.ts

@@ -1,19 +1,16 @@
 import * as THREE from "three";
 import { BaseViewer } from "./BaseViewer";
 import { ViewerName } from "./Constants";
-import { EffectManager } from "../effect";
 import { Model3d } from "../model";
 import { Viewer3dConfig, ModelConfig, Viewpoint } from "../../core/Configs";
 export declare class Viewer3d extends BaseViewer {
     name: ViewerName;
     loadedModels: Model3d[];
     distanceCullingFactor: number;
-    protected effect: EffectManager;
     private shouldDispatchModelLoadEvent;
     constructor(viewerCfg: Viewer3dConfig, homeView?: Viewpoint);
     protected setDefaultBackground(): void;
     is3d(): boolean;
-    get effectManager(): EffectManager;
     loadLocalModel(url: string, modelCfg: ModelConfig, manager?: THREE.LoadingManager, onProgress?: (event: ProgressEvent) => void): Promise<void>;
     loadModel(modelCfg: ModelConfig, onProgress?: ((event: ProgressEvent<EventTarget>) => void) | undefined): Promise<void>;
     private loadModelInternal;
@@ -101,6 +98,8 @@ export declare class Viewer3d extends BaseViewer {
     setDoubleSidedMaterials(): void;
     revertDoubleSidedMaterials(): void;
     clearSelection(): void;
+    /** True when the user has an active pick selection (independent of the current cursor hit). */
+    hasSelectedObject(): boolean;
     /**
      * Gets if selection is enabled.
      */

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "@x-viewer/core",
-    "version": "0.21.11",
+    "version": "0.21.13",
     "homepage": "https://dwg.thingraph.site/",
     "description": "WebGL-based 2D/3D viewer engine built on Three.js. View DWG/DXF/PDF files in the browser with no server required. Supports glTF, OBJ, FBX, IFC, STL and BimTiles formats.",
-    "author": "thingraph",
+    "author": "Thingraph",
     "license": "UNLICENSED",
     "keywords": [
         "dwg",