@splinetool/runtime 0.9.342 → 0.9.344

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splinetool/runtime",
-  "version": "0.9.342",
+  "version": "0.9.344",
   "type": "module",
   "main": "./build/runtime.js",
   "module": "./build/runtime.js",

package/runtime.d.ts

@@ -19,7 +19,8 @@ declare module '@splinetool/runtime' {
 		| 'lookAt'
 		| 'follow'
 		| 'scroll'
-		| 'collision';
+		| 'collision'
+		| 'rendered';
 
 	export type SPEObject = {
 		name: string;
@@ -47,10 +48,26 @@ declare module '@splinetool/runtime' {
 	export class Application {
 		_controls: any;
 		renderOnDemand: boolean;
+
 		canvas: HTMLCanvasElement;
 		constructor(
 			canvas: HTMLCanvasElement,
-			{ renderOnDemand }?: { renderOnDemand: boolean }
+			{
+				renderOnDemand,
+			}?: {
+				/**
+				 * @deprecated use options.renderMode instead
+				 */
+				renderOnDemand?: boolean;
+
+				/**
+				 * Can either be:
+				 * - `auto` runtime tries to only render when necessary (default).
+				 * - `manual` only renders when spline.requestRender() is called.
+				 * - `continuous` continuously render, once per frame.
+				 */
+				renderMode?: 'auto' | 'manual' | 'continuous';
+			}
 		);
 		/**
 		 * Loads an exported Spline scene
@@ -74,6 +91,11 @@ declare module '@splinetool/runtime' {
 		 * @returns {Object} SPEObject
 		 */
 		findObjectByName(name: string): SPEObject | undefined;
+		/**
+		 * A flat list of all scene objects
+		 * @returns {Array.<SPEObject>}
+		 */
+		getAllObjects(): SPEObject[];
 		/**
 		 * Returns an array of Spline events
 		 * @returns {Array.<Object>}
@@ -128,6 +150,12 @@ declare module '@splinetool/runtime' {
 		 */
 		setBackgroundColor(color: string): void;
 
+		/**
+		 * Change the event type to global when passing true and local when passing false
+		 * @param global 
+		 */
+		setGlobalEvents(global:boolean):void;
+
 		/**
 		 * Manually sets the canvas size to a specific value.
 		 * When this is called, the canvas will no longer be
@@ -140,5 +168,27 @@ declare module '@splinetool/runtime' {
 		get data(): DocumentData;
 		get eventManager(): EventManager;
 		get controls(): ControlsManager;
+
+		/**
+		 * Returns true if spline.stop() was previously called
+		 */
+		get isStopped(): boolean;
+
+		/**
+		 * Stop/Pause all rendering controls and events
+		 */
+		stop(): void;
+
+		/**
+		 * Play/Resume rendering, controls and events
+		 */
+		play(): void;
+
+		/**
+		 * To be used concurrently with spline.renderMode = 'manual
+		 * When called this function will flag the render to dirty which means that
+		 * the scene will be rendered on next animation frame. Calling this more than once per frame will not trigger multiple render.
+		 */
+		requestRender(): void;
 	}
 }