@omrips/viewstl 2.0.0-rc.4 → 2.0.0-rc.5

package/build/{v2/viewstl.d.cts → viewstl.d.cts}

@@ -88,12 +88,45 @@ export interface SceneExportResult {
 }
 export interface AnimationTrack extends Transform {
   msec?: number;
+  /** Continuous accumulation; applies to delta only. */
   loop?: boolean;
 }
 export interface Animation {
   delta?: AnimationTrack;
   exact?: AnimationTrack;
 }
+export interface AnimationPlaybackState {
+  status: "idle" | "running" | "paused" | "stopped" | "completed";
+  elapsed_ms: number;
+  /** Temporarily suspended by a hidden document or lost graphics context. */
+  suspended: boolean;
+  tracks: Array<{
+    mode: "delta" | "exact";
+    msec: number;
+    loop: boolean;
+    progress: number;
+  }>;
+}
+export type AnimationStateReason =
+  | "started"
+  | "restored"
+  | "replaced"
+  | "paused"
+  | "resumed"
+  | "completed"
+  | "stopped"
+  | "manual"
+  | "removed"
+  | "clean"
+  | "error";
+/** Serialized scene playback. Normally created by get_vsj/export_scene. */
+export interface SavedAnimationState {
+  version: 1;
+  elapsed_ms: number;
+  paused: boolean;
+  origin: Required<Omit<Transform, "scale">>;
+  center: [number, number, number];
+}
 export interface GeometryData {
   positions: Float32Array | number[];
   colors?: Float32Array | number[] | null;
@@ -116,6 +149,7 @@ export interface ModelOptions extends Transform {
   view_edges?: boolean;
   units?: Units;
   animation?: Animation | null;
+  animation_state?: SavedAnimationState | null;
 }
 export type ModelClick = (
   id: number | null,
@@ -173,6 +207,15 @@ export interface ViewerOptions {
   on_model_drop?: (filename: string) => void;
   on_model_mouseclick?: ModelClick;
   on_model_mousedown?: ModelClick;
+  animation_state_callback?: (
+    id: number,
+    state: AnimationPlaybackState,
+    reason: AnimationStateReason,
+  ) => void;
+  animation_complete_callback?: (
+    id: number,
+    state: AnimationPlaybackState,
+  ) => void;
 }
 export interface ModelInfo {
   name: string;
@@ -328,11 +371,17 @@ export class StlViewer {
   download_vsb(filename?: string): Promise<void | null>;
   load_vsb(source: string | File | Blob): void;
   animate_model(id: number, animation: Animation | null): void;
+  pause_model_animation(id: number): void;
+  resume_model_animation(id: number): void;
+  get_model_animation_state(id: number): AnimationPlaybackState | null;
   get_image_blob(type?: string): Promise<Blob>;
 }
 export default StlViewer;
 
 export interface ViewstlAppOptions {
+  /** Composed with the app's own playback controls and reduced-motion policy. */
+  animation_state_callback?: ViewerOptions["animation_state_callback"];
+  animation_complete_callback?: ViewerOptions["animation_complete_callback"];
   url_import_endpoint?: string;
   worker_url?: string | URL;
   worker_factory?: () => Worker;
@@ -357,6 +406,7 @@ export interface ViewstlAppState {
     /** Euler XYZ angles in degrees, about the model's own center. */
     rotation: Vector3;
     color: string | null;
+    animation: AnimationPlaybackState;
   }>;
 }
 export interface ViewstlApp {

package/build/{v2/viewstl.d.ts → viewstl.d.ts}

@@ -88,12 +88,45 @@ export interface SceneExportResult {
 }
 export interface AnimationTrack extends Transform {
   msec?: number;
+  /** Continuous accumulation; applies to delta only. */
   loop?: boolean;
 }
 export interface Animation {
   delta?: AnimationTrack;
   exact?: AnimationTrack;
 }
+export interface AnimationPlaybackState {
+  status: "idle" | "running" | "paused" | "stopped" | "completed";
+  elapsed_ms: number;
+  /** Temporarily suspended by a hidden document or lost graphics context. */
+  suspended: boolean;
+  tracks: Array<{
+    mode: "delta" | "exact";
+    msec: number;
+    loop: boolean;
+    progress: number;
+  }>;
+}
+export type AnimationStateReason =
+  | "started"
+  | "restored"
+  | "replaced"
+  | "paused"
+  | "resumed"
+  | "completed"
+  | "stopped"
+  | "manual"
+  | "removed"
+  | "clean"
+  | "error";
+/** Serialized scene playback. Normally created by get_vsj/export_scene. */
+export interface SavedAnimationState {
+  version: 1;
+  elapsed_ms: number;
+  paused: boolean;
+  origin: Required<Omit<Transform, "scale">>;
+  center: [number, number, number];
+}
 export interface GeometryData {
   positions: Float32Array | number[];
   colors?: Float32Array | number[] | null;
@@ -116,6 +149,7 @@ export interface ModelOptions extends Transform {
   view_edges?: boolean;
   units?: Units;
   animation?: Animation | null;
+  animation_state?: SavedAnimationState | null;
 }
 export type ModelClick = (
   id: number | null,
@@ -173,6 +207,15 @@ export interface ViewerOptions {
   on_model_drop?: (filename: string) => void;
   on_model_mouseclick?: ModelClick;
   on_model_mousedown?: ModelClick;
+  animation_state_callback?: (
+    id: number,
+    state: AnimationPlaybackState,
+    reason: AnimationStateReason,
+  ) => void;
+  animation_complete_callback?: (
+    id: number,
+    state: AnimationPlaybackState,
+  ) => void;
 }
 export interface ModelInfo {
   name: string;
@@ -328,11 +371,17 @@ export class StlViewer {
   download_vsb(filename?: string): Promise<void | null>;
   load_vsb(source: string | File | Blob): void;
   animate_model(id: number, animation: Animation | null): void;
+  pause_model_animation(id: number): void;
+  resume_model_animation(id: number): void;
+  get_model_animation_state(id: number): AnimationPlaybackState | null;
   get_image_blob(type?: string): Promise<Blob>;
 }
 export default StlViewer;
 
 export interface ViewstlAppOptions {
+  /** Composed with the app's own playback controls and reduced-motion policy. */
+  animation_state_callback?: ViewerOptions["animation_state_callback"];
+  animation_complete_callback?: ViewerOptions["animation_complete_callback"];
   url_import_endpoint?: string;
   worker_url?: string | URL;
   worker_factory?: () => Worker;
@@ -357,6 +406,7 @@ export interface ViewstlAppState {
     /** Euler XYZ angles in degrees, about the model's own center. */
     rotation: Vector3;
     color: string | null;
+    animation: AnimationPlaybackState;
   }>;
 }
 export interface ViewstlApp {