Rewrite Animation Loop (#3785)

* Initial restructuring

* Revamp exceptions

* Got render loop working

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Implement self.wait

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add note

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tristan Schulz <[email protected]>

Author: 3 people

example_scenes/new_test_new.py

@@ -22,18 +22,6 @@
 from manim.mobject.text.text_mobject import Text
 from manim.renderer.opengl_renderer import OpenGLRenderer
 
-
-def progress_through_animations(animations):
-    dt = t - last_t
-    last_t = t
-    for animation in animations:
-        animation.update_mobjects(dt)
-        alpha = t / animation.run_time
-        animation.interpolate(alpha)
-    self.update_frame(dt)
-    self.emit_frame()
-
-
 if __name__ == "__main__":
     with tempconfig({"renderer": "opengl"}):
         win = Window(

example_scenes/test_new_rendering.py

@@ -10,4 +10,4 @@ def construct(self) -> None:
 
 
 with tempconfig({"renderer": "opengl", "preview": True, "parallel": False}):
-    Test().render()
+    Manager(Test).render()

manim/__init__.py

@@ -72,6 +72,7 @@
 from .mobject.types.vectorized_mobject import *
 from .mobject.value_tracker import *
 from .mobject.vector_field import *
+from .renderer.render_manager import *
 from .scene.scene import *
 from .scene.scene_file_writer import *
 from .scene.section import *

manim/cli/render/render_options.py

@@ -100,7 +100,7 @@ def validate_resolution(ctx, param, value):
             case_sensitive=False,
         ),
         help="Select a renderer for your Scene.",
-        default="cairo",
+        default="opengl",
     ),
     option(
         "-g",

manim/renderer/cairo_renderer.py

@@ -8,7 +8,6 @@
 from manim.utils.hashing import get_hash_from_play_call
 
 from .. import config, logger
-from ..camera.cairo_camera import CairoCamera as Camera
 from ..mobject.mobject import Mobject
 from ..scene.scene_file_writer import SceneFileWriter
 from ..utils.exceptions import EndSceneEarlyException

manim/renderer/opengl_renderer.py

@@ -11,7 +11,7 @@
 from manim.mobject.opengl.opengl_vectorized_mobject import OpenGLVMobject
 from manim.renderer.buffers.buffer import STD140BufferFormat
 from manim.renderer.opengl_shader_program import load_shader_program_by_folder
-from manim.renderer.renderer import ImageType, Renderer, RendererData
+from manim.renderer.renderer import ImageType, Renderer, RendererData, RendererProtocol
 from manim.utils.iterables import listify
 from manim.utils.space_ops import cross2d, earclip_triangulation, z_to_vector
 
@@ -203,14 +203,14 @@ def bind_to_uniform_block(uniform_buffer_object: gl.Buffer, idx: int = 0):
         uniform_buffer_object.bind_to_uniform_block(idx)
 
 
-class OpenGLRenderer(Renderer):
+class OpenGLRenderer(Renderer, RendererProtocol):
     pixel_array_dtype = np.uint8
 
     def __init__(
         self,
         pixel_width: int = config.pixel_width,
         pixel_height: int = config.pixel_height,
-        samples=4,
+        samples: int = 4,
         background_color: c.ManimColor = color.BLACK,
         background_opacity: float = 1.0,
         background_image: str | None = None,
@@ -407,6 +407,12 @@ def render_program(self, prog, data, indices=None):
         vao.release()
         # return data, data_size
 
+    def render_image(self, mob):
+        raise NotImplementedError  # TODO
+
+    def render_previous(self, camera: Camera) -> None:
+        raise NotImplementedError
+
     def render_vmobject(self, mob: OpenGLVMobject) -> None:  # type: ignore
         self.stencil_buffer_fbo.use()
         self.stencil_buffer_fbo.clear()

manim/renderer/opengl_renderer_window.py

@@ -10,9 +10,6 @@
 
 from .. import __version__, config
 
-if TYPE_CHECKING:
-    import manim.scene as m_scene
-
 
 class Window(FunWindow):
     fullscreen: bool = False

manim/renderer/opengl_shader_program.py

@@ -85,9 +85,8 @@ def load_shader_program_by_folder(ctx: gl.Context, folder_name: str):
         raise RuntimeError("Loading Shader Program Error")
     if geometry_code is None:
         return ctx.program(vertex_shader=vertex_code, fragment_shader=fragment_code)
-    elif geometry_code is not None:
-        return ctx.program(
-            vertex_shader=vertex_code,
-            geometry_shader=geometry_code,
-            fragment_shader=fragment_code,
-        )
+    return ctx.program(
+        vertex_shader=vertex_code,
+        geometry_shader=geometry_code,
+        fragment_shader=fragment_code,
+    )