WebGLRenderer rename schedule_render to schedule_render_auto

This is needed because we want to introduce a new `WebGLRenderer` method `schedule_render` which will allow users to schedule a render on next AnimationFrame manually (once). Beside that, it feels more consistent, because we have `schedule_render_always` for mode `always` and and now also `schedule_render_auto` for mode `auto` (`schedule_render` was used in mode `auto` logic only).
vatro · Jun 19, 2022 · 30f5a51 · 30f5a51
1 parent 832abf3
commit 30f5a51
Show file tree

Hide file tree

Showing 16 changed files with 18 additions and 18 deletions.
diff --git a/src/components/AmbientLight.svelte b/src/components/AmbientLight.svelte
@@ -463,7 +463,7 @@ AmbientLight cannot be used to cast shadows as it doesn't have a direction. Posi
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/CubeCamera.svelte b/src/components/CubeCamera.svelte
@@ -790,7 +790,7 @@ Renders a CubeMap for usage with **non-PBR** materials which have an `.envMap` p
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/DirectionalLight.svelte b/src/components/DirectionalLight.svelte
@@ -625,7 +625,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/Empty.svelte b/src/components/Empty.svelte
@@ -614,7 +614,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/HemisphereLight.svelte b/src/components/HemisphereLight.svelte
@@ -511,7 +511,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/LoadedGLTF.svelte b/src/components/LoadedGLTF.svelte
@@ -845,7 +845,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/Mesh.svelte b/src/components/Mesh.svelte
@@ -940,7 +940,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/OrbitControls.svelte b/src/components/OrbitControls.svelte
@@ -125,7 +125,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 	// schedule render
 	function on_orbitcontrols_change(e: any): void {
 		orbitcontrols.object.userData.root_scene.userData.dirty = true
-		$svelthreeStores[sti].rendererComponent.schedule_render(orbitcontrols.object.userData.root_scene)
+		$svelthreeStores[sti].rendererComponent.schedule_render_auto(orbitcontrols.object.userData.root_scene)
 
 		// schedule next render (loop) if function was not called by an event
 		if (e === null) rAF.id = requestAnimationFrame(() => on_orbitcontrols_change(null))

diff --git a/src/components/OrthographicCamera.svelte b/src/components/OrthographicCamera.svelte
@@ -718,7 +718,7 @@ If you use this approach you'll see a warning in the console if you define left,
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/PerspectiveCamera.svelte b/src/components/PerspectiveCamera.svelte
@@ -739,7 +739,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/PointLight.svelte b/src/components/PointLight.svelte
@@ -592,7 +592,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/Points.svelte b/src/components/Points.svelte
@@ -950,7 +950,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/RectAreaLight.svelte b/src/components/RectAreaLight.svelte
@@ -587,7 +587,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/Scene.svelte b/src/components/Scene.svelte
@@ -986,11 +986,11 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						if (root_scene) {
 							root_scene.userData.dirty = true
-							$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+							$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 						} else {
 							// we are the root scene
 							scene.userData.dirty = true
-							$svelthreeStores[sti].rendererComponent.schedule_render(scene)
+							$svelthreeStores[sti].rendererComponent.schedule_render_auto(scene)
 						}
 					}
 

diff --git a/src/components/SpotLight.svelte b/src/components/SpotLight.svelte
@@ -668,7 +668,7 @@ svelthree uses svelte-accmod, where accessors are always `true`, regardless of `
 
 					if ($svelthreeStores[sti].rendererComponent?.mode === "auto") {
 						root_scene.userData.dirty = true
-						$svelthreeStores[sti].rendererComponent.schedule_render(root_scene)
+						$svelthreeStores[sti].rendererComponent.schedule_render_auto(root_scene)
 					}
 
 					if (afterUpdate_inject_after) afterUpdate_inject_after()

diff --git a/src/components/WebGLRenderer.svelte b/src/components/WebGLRenderer.svelte
@@ -719,7 +719,7 @@ This is a **svelthree** _WebGLRenderer_ Component.
 	 * Schedules a render if the current scene has been marked as `dirty`. \
 	 * _Primarly called internally by components if `WebGLRenderer` component's `mode` is set to `"auto"`_.
 	 */
-	export function schedule_render(scene: Scene = null): void {
+	export function schedule_render_auto(scene: Scene = null): void {
 		if (enabled && render_scheduled.status === false) {
 			const scene_to_check: Scene = scene ? scene : current_scene
 			if (scene_to_check) {
@@ -730,7 +730,7 @@ This is a **svelthree** _WebGLRenderer_ Component.
 				}
 			} else {
 				console.error(
-					"SVELTHREE > WebGLRenderer > schedule_render : no scene to check 'dirty' status available!"
+					"SVELTHREE > WebGLRenderer > schedule_render_auto : no scene to check 'dirty' status available!"
 				)
 			}
 		}