@splnlss/3d-story-viewer 0.8.4 → 0.8.5

package/build/types/src/viewer/index.d.ts

@@ -6,6 +6,49 @@ export type ViewerCoords = {
     yaw?: number;
     roll?: number;
 };
+/**
+ * WGS84 degrees and ellipsoidal metres.
+ */
+export type DesktopGeodeticPosition = {
+    longitude: number;
+    latitude: number;
+    altitude: number;
+};
+/**
+ * WGS84 degrees, ellipsoidal metres, and Euler degrees.
+ */
+export type DesktopCameraFramePose = {
+    lon: number;
+    lat: number;
+    alt: number;
+    pitch: number;
+    yaw: number;
+    roll: number;
+};
+export type DesktopMovementState = {
+    FRONT: boolean;
+    BACK: boolean;
+    LEFT: boolean;
+    RIGHT: boolean;
+    UP: boolean;
+    DOWN: boolean;
+    BOOST: boolean;
+};
+export type DesktopNavigationFrame = {
+    timeMs: number;
+    deltaSeconds: number;
+    pose: DesktopCameraFramePose;
+    movement: Readonly<DesktopMovementState>;
+};
+export type DesktopNavigationFrameResult = {
+    position: DesktopGeodeticPosition;
+    pitch?: number;
+};
+export type DesktopNavigationController = {
+    update(frame: DesktopNavigationFrame): DesktopNavigationFrameResult;
+    canLook?(): boolean;
+    interrupt?(reason: string): void;
+};
 /**
  * @typedef {Object} ViewerCoords
  * @property {number} [lon]
@@ -15,6 +58,12 @@ export type ViewerCoords = {
  * @property {number} [yaw]
  * @property {number} [roll]
  */
+/** @typedef {{longitude:number, latitude:number, altitude:number}} DesktopGeodeticPosition WGS84 degrees and ellipsoidal metres. */
+/** @typedef {{lon:number, lat:number, alt:number, pitch:number, yaw:number, roll:number}} DesktopCameraFramePose WGS84 degrees, ellipsoidal metres, and Euler degrees. */
+/** @typedef {{FRONT:boolean, BACK:boolean, LEFT:boolean, RIGHT:boolean, UP:boolean, DOWN:boolean, BOOST:boolean}} DesktopMovementState */
+/** @typedef {{timeMs:number, deltaSeconds:number, pose:DesktopCameraFramePose, movement:Readonly<DesktopMovementState>}} DesktopNavigationFrame */
+/** @typedef {{position:DesktopGeodeticPosition, pitch?:number}} DesktopNavigationFrameResult */
+/** @typedef {{update(frame:DesktopNavigationFrame):DesktopNavigationFrameResult, canLook?():boolean, interrupt?(reason:string):void}} DesktopNavigationController */
 declare class Viewer extends EventDispatcher {
     /**
      * @param {HTMLElement | null} container
@@ -25,6 +74,11 @@ declare class Viewer extends EventDispatcher {
     type: string;
     disposed: boolean;
     xrSession: WebXRSession;
+    xrDiagnosticsRows: string[];
+    loadingDiagnosticsEnabled: boolean;
+    diagnosticFps: number;
+    diagnosticWindowStart: any;
+    diagnosticFrameCount: number;
     sparkRenderer: any;
     transparentBackground: boolean;
     state: StateDispatcher;
@@ -37,11 +91,24 @@ declare class Viewer extends EventDispatcher {
     cameraUp: Vector3;
     scene: Scene<import("three").Object3DEventMap>;
     content: Group<import("three").Object3DEventMap>;
+    contentLayerRegistry: ContentLayerRegistry;
+    splatDestinationPrefetch: SplatDestinationPrefetch;
     topLayerIndex: number;
     enabledLayers: any[];
     labels: Map<any, any>;
     features: Map<any, any>;
     globeControls: GlobeControls;
+    _viewModeState: {
+        version: number;
+        confirmedRotationSpeed: number;
+    };
+    /** @type {DesktopNavigationController | null} */
+    desktopNavigationController: DesktopNavigationController | null;
+    _desktopControlsBefore: {
+        enabled: boolean;
+        rotationSpeed: number;
+    };
+    desktopLookControls: DesktopLookControls;
     _onGlobeControlsStart: () => void;
     transitionControls: TransitionControls;
     tileDecoders: TileDecoders;
@@ -79,6 +146,8 @@ declare class Viewer extends EventDispatcher {
     _onKeyDown: (event: any) => void;
     _onKeyUp: (event: any) => void;
     _onResize: (event: any) => void;
+    _onWindowBlur: () => void;
+    _onVisibilityChange: () => void;
     sky: Sky;
     pointerRaycaster: Raycaster;
     _onPointerMove: (event: any) => void;
@@ -158,7 +227,16 @@ declare class Viewer extends EventDispatcher {
     setXRNavigationFade(opacity: number): void;
     set keysEnabled(enabled: boolean);
     get keysEnabled(): boolean;
+    _clearHeldKeys(): void;
     updateMovementState(): void;
+    /** Install one desktop camera owner. A null controller restores the prior globe controls. @param {DesktopNavigationController | null} controller */
+    setDesktopNavigationController(controller: DesktopNavigationController | null): void;
+    /** Rotate Walk view around its eye; pointer delta is CSS pixels. */
+    _applyDesktopLook(dx: any, dy: any): void;
+    /** Turn Walk toward north without moving its eye or leaving Walk. */
+    turnDesktopNorth(): boolean;
+    /** Invoke the desktop controller after globe input and before tiles/content/render. Invalid results leave the previous eye intact. */
+    _applyDesktopNavigationFrame(timeMs: any, deltaSeconds: any): void;
     /**
      * @param {number} lon
      * @param {number} lat
@@ -180,7 +258,6 @@ declare class Viewer extends EventDispatcher {
     setBackgroundColor(color: any): void;
     appendTo(container: any): void;
     container: any;
-    stats: Stats;
     updateCameraDirections(): void;
     setAnimate(bool?: boolean): void;
     /** @param {Event} [event] */
@@ -190,8 +267,19 @@ declare class Viewer extends EventDispatcher {
     ensureSparkRenderer(): Promise<any>;
     disposeSparkRenderer(): void;
     sparkRendererGeneration: any;
+    /** @private @param {import('../main.js').ContentLayerDefinition} sourceLayerData */
+    private prepareContentLayerDefinition;
+    /** @private @param {import('../main.js').ContentLayerDefinition} layerData */
+    private createContentLayer;
+    /** @private */
+    private reportContentLayerError;
+    /** @private */
+    private refreshContentLayerDepth;
     /** @param {import('../main.js').ContentLayerDefinition[]} content */
     defineContentLayers(content?: import("../main.js").ContentLayerDefinition[]): void;
+    /** Replace, add, or remove one content layer without rebuilding its siblings. */
+    /** @param {string} id @param {import('../main.js').ContentLayerDefinition | null} definition */
+    replaceContentLayer(id: string, definition: import("../main.js").ContentLayerDefinition | null): void;
     enableContentLayers(labels?: any[]): void;
     setTimeFrame(start: any, end: any): void;
     timeFrameStart: Date;
@@ -240,8 +328,9 @@ declare class Viewer extends EventDispatcher {
      * @param {number} [yaw]
      * @param {number} [roll]
      * @param {number} [duration]
+     * @returns {Promise<boolean>} Whether the requested transition completed.
      */
-    alignCamera(lon: number, lat: number, alt: number, pitch?: number, yaw?: number, roll?: number, duration?: number): Promise<void>;
+    alignCamera(lon: number, lat: number, alt: number, pitch?: number, yaw?: number, roll?: number, duration?: number): Promise<boolean>;
     /**
      * @param {number} lon
      * @param {number} lat
@@ -249,12 +338,13 @@ declare class Viewer extends EventDispatcher {
      * @param {number} [distance]
      * @param {number} [pitch]
      * @param {number} [duration]
+     * @returns {Promise<boolean>} Whether the requested transition completed.
      */
-    focusCamera(lon: number, lat: number, alt: number, distance?: number, pitch?: number, duration?: number): Promise<void>;
+    focusCamera(lon: number, lat: number, alt: number, distance?: number, pitch?: number, duration?: number): Promise<boolean>;
     /**
      * Temporarily load Google 3D tiles around a WGS84 destination without changing the live view.
      * Position and altitude use degrees and WGS84 ellipsoidal metres; rotation uses degrees.
-     * @param {{longitude:number, latitude:number, altitude:number, pitch:number, yaw:number, roll:number, resolutionPixels:128|256} | null} target
+     * @param {{longitude:number, latitude:number, altitude:number, pitch:number, yaw:number, roll:number, resolutionPixels:128|256, timeoutMs?:number} | null} target
      */
     setDestinationTilePrefetch(target: {
         longitude: number;
@@ -264,14 +354,50 @@ declare class Viewer extends EventDispatcher {
         yaw: number;
         roll: number;
         resolutionPixels: 128 | 256;
+        timeoutMs?: number;
     } | null): void;
+    /**
+     * Warm only active RAD layers at a WGS84 destination. This never changes the live camera.
+     * @param {{longitude:number, latitude:number, altitude:number, pitch:number, yaw:number, roll:number, layerIds:string[], mode:'desktop'|'xr', timeoutMs:number} | null} target
+     * @param {'cancel'|'arrival'} [clearReason]
+     */
+    setDestinationSplatPrefetch(target: {
+        longitude: number;
+        latitude: number;
+        altitude: number;
+        pitch: number;
+        yaw: number;
+        roll: number;
+        layerIds: string[];
+        mode: "desktop" | "xr";
+        timeoutMs: number;
+    } | null, clearReason?: "cancel" | "arrival"): void;
+    /** Optional viewer-owned counters, sampled by the app only while its stats setting is on.
+     * @param {boolean} enabled
+     */
+    setLoadingDiagnosticsEnabled(enabled: boolean): void;
+    getLoadingDiagnostics(): {
+        fps: number;
+        tilesVisible: number;
+        tilesPending: number;
+        tilesFailed: number;
+        radPages: number;
+        radPending: any;
+        gpuTextures: number;
+    };
+    /** Short numeric rows in a small lower-right panel for both XR eyes.
+     * @param {string[] | null} rows
+     */
+    setXRDiagnosticsPanel(rows: string[] | null): void;
     /**
      * @param {number} [pitch]
      * @param {number} [yaw]
      * @param {number} [duration]
+     * @returns {Promise<boolean>} Whether the requested transition completed.
      */
-    angleCamera(pitch?: number, yaw?: number, duration?: number): Promise<void>;
-    setViewMode(mode?: string): Promise<void>;
+    angleCamera(pitch?: number, yaw?: number, duration?: number): Promise<boolean>;
+    /** @param {'2d' | '3d'} [mode] @returns {Promise<boolean>} Whether the camera orientation transition completed. */
+    setViewMode(mode?: "2d" | "3d"): Promise<boolean>;
     exportScene(): void;
     saveScreenshot(name?: string): void;
     dispose(): void;
@@ -297,11 +423,13 @@ import { PerspectiveCamera } from 'three';
 import { Vector3 } from 'three';
 import { Scene } from 'three';
 import { Group } from 'three';
+import { ContentLayerRegistry } from './ContentLayer/ContentLayerRegistry.js';
+import { SplatDestinationPrefetch } from './SplatDestinationPrefetch.js';
 import { GlobeControls } from './GlobeControls';
+import { DesktopLookControls } from './DesktopLookControls.js';
 import { TransitionControls } from './TransitionControls';
 import { TileDecoders } from './TileDecoders.js';
 import { GlobeManager } from './GlobeManager';
 import { Sky } from './Sky';
 import { Raycaster } from 'three';
-import Stats from 'stats.js';
 export { Viewer as default };

package/build/types/src/viewer/loadingDiagnostics.d.ts

@@ -0,0 +1,10 @@
+/** Counts are viewer-owned snapshots, not a percentage or total device memory. */
+export function readLoadingDiagnostics(viewer: any): {
+    fps: number;
+    tilesVisible: number;
+    tilesPending: number;
+    tilesFailed: number;
+    radPages: number;
+    radPending: any;
+    gpuTextures: number;
+};

package/build/types/src/workers/WorkerPool.d.ts

@@ -3,14 +3,20 @@ export class WorkerPool {
     limit: number;
     queue: any[];
     workers: any[];
-    workersResolve: any[];
+    active: any[];
     workerStatus: number;
     workerCreator: any;
+    disposed: boolean;
     initWorker(workerId: any): void;
     getIdleWorker(): number;
-    onMessage(workerId: any, msg: any): void;
+    finishJob(workerId: any, job: any): boolean;
+    onMessage(workerId: any, worker: any, event: any): void;
+    onError(workerId: any, worker: any, event: any): void;
+    cancelJob(job: any): void;
+    startJob(workerId: any, job: any): void;
+    drain(): void;
     setWorkerCreator(workerCreator: any): void;
     setWorkerLimit(limit: any): void;
-    postMessage(msg: any, transfer: any): Promise<any>;
+    postMessage(msg: any, transfer: any, { signal }?: {}): Promise<any>;
     dispose(): void;
 }

package/build/viewer.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./main-CNVle6K1.cjs"),t=require("./index-XZNzHig1.cjs");exports.Viewer=e.Viewer,exports.ViewerEvents=e.ViewerEvents,exports.computeElevation=t.computeElevation;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./main-DXC7nIw_.cjs"),t=require("./index-XZNzHig1.cjs");exports.Viewer=e.Viewer,exports.ViewerEvents=e.ViewerEvents,exports.computeElevation=t.computeElevation;

package/build/viewer.js

@@ -1,4 +1,4 @@
-import { V, a } from "./main-DZ2oJmQ9.js";
+import { V, a } from "./main-DCLbtFn7.js";
 import { by } from "./index-a8PLKOvo.js";
 export {
   V as Viewer,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@splnlss/3d-story-viewer",
-    "version": "0.8.4",
+    "version": "0.8.5",
     "publishConfig": {
         "access": "public",
         "registry": "https://registry.npmjs.org/"