From 82e9264925bd8d30dbd47d7b57fb076ac9143ed2 Mon Sep 17 00:00:00 2001
From: alvarosabu <alvaro.saburido@gmail.com>
Date: Sun, 7 Jan 2024 11:45:22 +0100
Subject: [PATCH] feat: add advance method for manual mode

---
 src/composables/useRenderer/index.ts          | 11 +++++--
 .../useTresContextProvider/index.ts           | 33 +++++++++++++++----
 2 files changed, 34 insertions(+), 10 deletions(-)

diff --git a/src/composables/useRenderer/index.ts b/src/composables/useRenderer/index.ts
index 6428bdbb3..91db4aff3 100644
--- a/src/composables/useRenderer/index.ts
+++ b/src/composables/useRenderer/index.ts
@@ -111,13 +111,14 @@ export function useRenderer(
     options,
     disableRender,
     emit,
-    contextParts: { sizes, camera, internal, invalidate },
+    contextParts: { sizes, camera, internal, invalidate, advance },
   }:
   {
     canvas: MaybeRef<HTMLCanvasElement>
     scene: Scene
     options: UseRendererOptions
-    contextParts: Pick<TresContext, 'sizes' | 'camera'>
+    emit: (event: string, ...args: any[]) => void
+    contextParts: Pick<TresContext, 'sizes' | 'camera' | 'internal'> & { invalidate: () => void; advance: () => void }
     disableRender: MaybeRefOrGetter<boolean>
   },
 ) {
@@ -185,7 +186,11 @@ export function useRenderer(
     // Reset priority
     internal.priority.value = 0
 
-    internal.frames.value = Math.max(0, internal.frames.value - 1)
+    // If renderMode is not 'manual', auto-decrement frames
+    // If it is 'manual', frames will be managed by the advance function
+    if (renderMode !== 'manual') {
+      internal.frames.value = Math.max(0, internal.frames.value - 1)
+    }
 
     if (toValue(options.renderMode) === 'always') {
       internal.frames.value = 1
diff --git a/src/composables/useTresContextProvider/index.ts b/src/composables/useTresContextProvider/index.ts
index cbb1b0962..6a814410a 100644
--- a/src/composables/useTresContextProvider/index.ts
+++ b/src/composables/useTresContextProvider/index.ts
@@ -38,9 +38,21 @@ export interface TresContext {
   renderer: ShallowRef<WebGLRenderer>
   raycaster: ShallowRef<Raycaster>
   perf: PerformanceState
-  renderMode: MaybeRefOrGetter<'always' | 'on-demand' | 'manual'>
+  /**
+   * If set to 'on-demand', the scene will only be rendered when the current frame is invalidated
+   * If set to 'manual', the scene will only be rendered when advance() is called
+   * If set to 'always', the scene will be rendered every frame
+   */
+  renderMode: Ref<'always' | 'on-demand' | 'manual'>
   internal: InternalState
+  /**
+   * Invalidates the current frame when renderMode === 'on-demand'
+   */
   invalidate: () => void
+  /**
+   * Advance one frame when renderMode === 'manual'
+   */
+  advance: () => void
   registerCamera: (camera: Camera) => void
   setCameraActive: (cameraOrUuid: Camera | string) => void
   deregisterCamera: (camera: Camera) => void
@@ -94,21 +106,27 @@ export function useTresContextProvider({
     maxFrames: 60,
   }
 
+  function invalidate(frames = 1) {
+    // Increase the frame count, ensuring not to exceed a maximum if desired
+    internal.frames.value = Math.min(internal.maxFrames, internal.frames.value + frames)
+  }
+
+  function advance() {
+    if (rendererOptions.renderMode === 'manual') {
+      invalidate()
+    }
+  }
+
   const { renderer } = useRenderer(
     {
       scene,
       canvas,
       options: rendererOptions,
       emit,
-      contextParts: { sizes, camera, internal, invalidate },
+      contextParts: { sizes, camera, internal, invalidate, advance },
       disableRender,
     })
 
-  function invalidate(frames = 1) {
-    // Increase the frame count, ensuring not to exceed a maximum if desired
-    internal.frames.value = Math.min(internal.maxFrames, internal.frames.value + frames)
-  }
-
   const toProvide: TresContext = {
     sizes,
     scene: localScene,
@@ -131,6 +149,7 @@ export function useTresContextProvider({
     },
     renderMode: ref(rendererOptions.renderMode || 'always'),
     internal,
+    advance,
     extend,
     invalidate,
     registerCamera,