@splnlss/3d-story-viewer 0.5.5 → 0.5.7

package/README.md

@@ -75,6 +75,38 @@ viewer.enableContentLayers(['default']);
 viewer.alignCamera(-105.18896, 39.93, 9000);
 ```
 
+## Gaussian Splat Layers
+
+Gaussian splat content layers support `ply`, `sog`, `spz`, and `rad` data. Every
+layer uses an explicit WGS84 anchor plus an optional local ENU transform:
+
+```js
+viewer.defineContentLayers([
+    {
+        id: 'site-scan',
+        name: 'Site scan',
+        type: 'gaussian-splat',
+        labels: ['default'],
+        data: { url: 'https://assets.example.com/site.rad', format: 'rad' },
+        options: {
+            transform: {
+                anchor: { longitude: -105.1, latitude: 40.1, altitude: 1600 },
+                translationENU: [0, 0, 0],
+                rotationDegrees: [0, 0, 0],
+                scale: 1,
+            },
+        },
+    },
+]);
+```
+
+PLY, SOG, and SPZ files stream directly and report byte progress. RAD uses
+Spark's paged loader: becoming ready means its metadata is valid and LOD
+streaming can begin, while detail continues to load in response to the camera.
+RAD hosts must support HTTP byte ranges and cross-origin `GET`/`HEAD` requests.
+Expose `Content-Length`, `Content-Range`, and `Accept-Ranges`; relative RAD
+sidecar files must use the same policy.
+
 ## Environment Variables
 
 Viewer tokens can be passed directly in the constructor or provided through Vite environment variables:

package/build/types/src/main.d.ts

@@ -1,4 +1,12 @@
 export type Vector3Tuple = [number, number, number];
+export type ViewerOptions = {
+    cesiumToken?: string;
+    googleMapsToken?: string;
+    /**
+     * Defaults to true.
+     */
+    transparentBackground?: boolean;
+};
 export type GaussianSplatLayerDefinition = {
     id: string;
     name: string;
@@ -6,7 +14,7 @@ export type GaussianSplatLayerDefinition = {
     labels: string[];
     data: {
         url: string;
-        format: "ply" | "sog";
+        format: "ply" | "sog" | "spz" | "rad";
     };
     options: {
         renderOrder?: 0;

package/build/types/src/viewer/ContentLayer/GaussianSplatLayer.d.ts

@@ -11,6 +11,8 @@ export class GaussianSplatLayer extends ContentLayer {
     visible: boolean;
     transformMatrix: any;
     load(): Promise<void>;
+    createPagedMesh(): SplatMesh;
+    createDirectMesh(attempt: any): Promise<SplatMesh>;
     disposeMesh(mesh: any): void;
 }
 import { ContentLayer } from '.';

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

@@ -4,8 +4,14 @@ export class TransitionControls extends EventDispatcher {
     lookAt: any;
     cameraTween: any;
     lookAtTween: any;
+    activeTransition: {
+        resolve: (value: any) => void;
+        toPosition: any;
+        toQuaternion: any;
+    };
     is2D: boolean;
     animateTo(position: any, quaternion: any, duration?: number): Promise<any>;
+    complete(transition: any): void;
     update(time: any): void;
     cancel(): void;
     cameraUpTween: any;

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

@@ -16,11 +16,16 @@ export type ViewerCoords = {
  * @property {number} [roll]
  */
 declare class Viewer extends EventDispatcher {
-    constructor(container: any, options?: {});
+    /**
+     * @param {HTMLElement | null} container
+     * @param {import('../main.js').ViewerOptions} [options]
+     */
+    constructor(container: HTMLElement | null, options?: import("../main.js").ViewerOptions);
     isViewer: boolean;
     type: string;
     disposed: boolean;
     sparkRenderer: SparkRenderer;
+    transparentBackground: boolean;
     state: StateDispatcher;
     renderer: any;
     css2DRenderer: any;
@@ -102,7 +107,7 @@ declare class Viewer extends EventDispatcher {
     alignCamera(lon: any, lat: any, alt: any, pitch?: number, yaw?: number, roll?: number, duration?: number): Promise<void>;
     focusCamera(lon: any, lat: any, alt: any, distance?: number, pitch?: number, duration?: number): Promise<void>;
     angleCamera(pitch?: number, yaw?: number, duration?: number): Promise<void>;
-    setViewMode(mode?: string): void;
+    setViewMode(mode?: string): Promise<void>;
     exportScene(): void;
     saveScreenshot(name?: string): void;
     dispose(): void;