worldorbit 2.5.17 → 3.0.0

package/packages/viewer/dist/types.d.ts

@@ -1,6 +1,7 @@
-import type { CoordinatePoint, RenderOrbitVisual, RenderPresetName, RenderSceneEvent, RenderSceneGroup, RenderSceneLabel, RenderScaleModel, RenderScene, RenderSceneObject, RenderSceneViewpoint, SceneRenderOptions, ViewProjection, WorldOrbitObject, WorldOrbitDocument } from "@worldorbit/core";
+import type { CoordinatePoint, RenderOrbitVisual, RenderProjectionFallback, RenderPresetName, RenderSceneEvent, RenderSceneGroup, RenderSceneLabel, RenderScaleModel, RenderScene, RenderSceneObject, RenderSceneViewpoint, SceneRenderOptions, SpatialScene, ViewProjection, WorldOrbitObject, WorldOrbitDocument, WorldOrbitViewCamera } from "@worldorbit/core";
 export type WorldOrbitThemeName = "atlas" | "nightglass" | "ember";
-export type WorldOrbitEmbedMode = "static" | "interactive";
+export type WorldOrbitViewMode = "2d" | "3d";
+export type WorldOrbitEmbedMode = "static" | "interactive" | "interactive-2d" | "interactive-3d";
 export type TooltipMode = "hover" | "pinned" | "disabled";
 export interface WorldOrbitTheme {
     name: string;
@@ -62,6 +63,7 @@ export interface SvgRenderOptions extends SceneRenderOptions {
 export interface ViewerRenderOptions extends Omit<SvgRenderOptions, "selectedObjectId"> {
     projection?: "document" | ViewProjection;
     scaleModel?: Partial<RenderScaleModel>;
+    viewMode?: WorldOrbitViewMode;
 }
 export interface ViewerState {
     scale: number;
@@ -104,19 +106,27 @@ export interface ViewerTooltipDetails {
     details: ViewerObjectDetails;
 }
 export interface ViewerAtlasState {
-    version: "2.0";
+    version: "2.0" | "2.5";
     viewpointId: string | null;
     activeEventId?: string | null;
     viewerState: ViewerState;
     renderOptions: {
         preset?: RenderPresetName;
         projection?: "document" | ViewProjection;
+        camera?: WorldOrbitViewCamera | null;
         layers?: ViewerLayerOptions;
         scaleModel?: Partial<RenderScaleModel>;
         activeEventId?: string | null;
+        viewMode?: WorldOrbitViewMode;
     };
     filter: ViewerFilter | null;
 }
+export interface ViewerAnimationState {
+    playing: boolean;
+    speed: number;
+    timeSeconds: number;
+    frozenByEvent: boolean;
+}
 export interface ViewerBookmark {
     id: string;
     label: string;
@@ -139,6 +149,8 @@ export interface AtlasInspectorSnapshot {
     scene: {
         title: string;
         projection: ViewProjection;
+        renderProjection: RenderProjectionFallback;
+        camera: WorldOrbitViewCamera | null;
         renderPreset: RenderPresetName | null;
         groupCount: number;
         semanticGroupCount: number;
@@ -151,6 +163,7 @@ export interface InteractiveViewerOptions extends ViewerRenderOptions {
     source?: string;
     document?: WorldOrbitDocument;
     scene?: RenderScene;
+    spatialScene?: SpatialScene;
     initialViewpointId?: string;
     initialSelectionObjectId?: string;
     initialFilter?: ViewerFilter | null;
@@ -191,11 +204,18 @@ export interface WorldOrbitViewer {
     getScene(): RenderScene;
     getRenderOptions(): ViewerRenderOptions;
     setRenderOptions(options: Partial<ViewerRenderOptions>): void;
+    getViewMode(): WorldOrbitViewMode;
+    setViewMode(mode: WorldOrbitViewMode): void;
     listViewpoints(): RenderSceneViewpoint[];
     getActiveViewpoint(): RenderSceneViewpoint | null;
     goToViewpoint(id: string): boolean;
     getActiveEventId(): string | null;
     setActiveEvent(id: string | null): void;
+    playAnimation(): void;
+    pauseAnimation(): void;
+    resetAnimation(): void;
+    setAnimationSpeed(multiplier: number): void;
+    getAnimationState(): ViewerAnimationState;
     search(query: string, limit?: number): ViewerSearchResult[];
     getFilter(): ViewerFilter | null;
     setFilter(filter: ViewerFilter | null): void;
@@ -247,11 +267,13 @@ export interface WorldOrbitEmbedPayload {
     version: "2.0";
     mode: WorldOrbitEmbedMode;
     scene: RenderScene;
+    spatialScene?: SpatialScene;
     options?: {
         theme?: WorldOrbitTheme | WorldOrbitThemeName;
         layers?: ViewerLayerOptions;
         subtitle?: string;
         preset?: SceneRenderOptions["preset"];
+        viewMode?: WorldOrbitViewMode;
         initialViewpointId?: string;
         initialSelectionObjectId?: string;
         initialFilter?: ViewerFilter | null;