Merge remote-tracking branch 'upstream/master'

Author: XorUnison

docs/source/changelog.rst

@@ -18,6 +18,9 @@ Fixes
 Configuration
 ^^^^^^^^^^^^^
 
+#. Removed the ``skip_animations`` config option and added the
+   ``Renderer.skip_animations`` attribute instead (via :pr:`696`).
+
 #. The global ``config`` dict has been replaced by a global ``config`` instance
    of the new class :class:`~.ManimConfig`.  This class has a dict-like API, so
    this should not break user code, only make it more robust.  See the

docs/source/manim_directive.py

@@ -78,6 +78,8 @@ def construct(self):
 
 import shutil
 
+from manim import QUALITIES
+
 classnamedict = {}
 
 
@@ -150,29 +152,13 @@ def run(self):
         else:
             ref_block = ""
 
-        frame_rate = 30
-        pixel_height = 480
-        pixel_width = 854
-
         if "quality" in self.options:
-            quality = self.options["quality"]
-            if quality == "low":
-                pixel_height = 480
-                pixel_width = 854
-                frame_rate = 15
-            elif quality == "medium":
-                pixel_height = 720
-                pixel_width = 1280
-                frame_rate = 30
-            elif quality == "high":
-                pixel_height = 1440
-                pixel_width = 2560
-                frame_rate = 60
-            elif quality == "fourk":
-                pixel_height = 2160
-                pixel_width = 3840
-                frame_rate = 60
-
+            quality = f'{self.options["quality"]}_quality'
+        else:
+            quality = "example_quality"
+        frame_rate = QUALITIES[quality]["frame_rate"]
+        pixel_height = QUALITIES[quality]["pixel_height"]
+        pixel_width = QUALITIES[quality]["pixel_width"]
         qualitydir = f"{pixel_height}p{frame_rate}"
 
         state_machine = self.state_machine

manim/_config/main_utils.py

@@ -317,7 +317,11 @@ def _parse_args_no_subcmd(args):
     parser.add_argument(
         "-q",
         "--quality",
-        choices=[constants.QUALITIES[q]["flag"] for q in constants.QUALITIES],
+        choices=[
+            constants.QUALITIES[q]["flag"]
+            for q in constants.QUALITIES
+            if constants.QUALITIES[q]["flag"]
+        ],
         default=constants.DEFAULT_QUALITY_SHORT,
         help="Render at specific quality, short form of the --*_quality flags",
     )

manim/_config/utils.py

@@ -126,6 +126,7 @@ def _determine_quality(args):
             pass
         elif getattr(args, quality, None) or (
             hasattr(args, "quality")
+            and args.quality is not None
             and args.quality == constants.QUALITIES[quality]["flag"]
         ):
             return quality
@@ -278,7 +279,6 @@ class MyScene(Scene):
         "save_pngs",
         "scene_names",
         "show_in_file_browser",
-        "skip_animations",
         "sound",
         "tex_dir",
         "tex_template_file",
@@ -506,7 +506,6 @@ def digest_parser(self, parser):
             "disable_caching",
             "flush_cache",
             "custom_folders",
-            "skip_animations",
             "use_js_renderer",
         ]:
             setattr(self, key, parser["CLI"].getboolean(key, fallback=False))
@@ -906,12 +905,6 @@ def verbosity(self, val):
         doc="Stop rendering animations at this nmber.  Use -1 to avoid skipping (-n).",
     )
 
-    skip_animations = property(
-        lambda self: self._d["skip_animations"],
-        lambda self, val: self._set_boolean("skip_animations", val),
-        doc="Whether to skip the next animation.  Internal use only.",
-    )
-
     max_files_cached = property(
         lambda self: self._d["max_files_cached"],
         lambda self, val: self._set_pos_number("max_files_cached", val, True),

manim/constants.py

@@ -171,6 +171,12 @@ class MyText(Text):
         "pixel_width": 854,
         "frame_rate": 15,
     },
+    "example_quality": {
+        "flag": None,
+        "pixel_height": 480,
+        "pixel_width": 854,
+        "frame_rate": 30,
+    },
 }
 
 DEFAULT_QUALITY = "high_quality"

manim/grpc/impl/frame_server_impl.py

@@ -124,7 +124,7 @@ def GetFrameAtTime(self, request, context):
                     frame_response.frame_pending = True
                     selected_scene.renderer_waiting = True
                 return frame_response
-            elif selected_scene.skip_animations:
+            elif selected_scene.renderer.skip_animations:
                 # Do nothing
                 return
             else:

manim/mobject/svg/tex_mobject.py

@@ -27,7 +27,7 @@ def construct(self):
 
     class HelloTex(Scene):
         def construct(self):
-            tex = Tex(r'$\xrightarrow{Hello}$ \LaTeX').scale(3)
+            tex = Tex(r'$\xrightarrow{x^2y^3}$ \LaTeX').scale(3)
             self.add(tex)
 
 Whereas in a :class:`~.MathTex` mobject everything is math-mode by default.
@@ -61,14 +61,14 @@ def construct(self):
 
 LaTeX commands and keyword arguments
 ++++++++++++++++++++++++++++++++++++
-We can use any standard LaTeX commands in the AMS maths packages. For example the ``mathtt`` text type.
+We can use any standard LaTeX commands in the AMS maths packages. For example the ``mathtt`` math-text type, or the ``looparrowright`` arrow.
 
 .. manim:: AMSLaTeX
     :save_last_frame:
 
     class AMSLaTeX(Scene):
         def construct(self):
-            tex = Tex(r'$\mathtt{Hello}$ \LaTeX').scale(3)
+            tex = Tex(r'$\mathtt{H} \looparrowright$ \LaTeX').scale(3)
             self.add(tex)
 
 On the manim side, the :class:`~.Tex` class also accepts attributes to change the appearance of the output.
@@ -125,7 +125,7 @@ def construct(self):
 
     class LaTeXMathFonts(Scene):
         def construct(self):
-            tex = Tex(r'$f: A \rightarrow B$', tex_template=TexFontTemplates.french_cursive).scale(3)
+            tex = Tex(r'$x^2 + y^2 = z^2$', tex_template=TexFontTemplates.french_cursive).scale(3)
             self.add(tex)
 
 Manim also has a :class:`~.TexTemplateLibrary` containing the TeX templates used by 3Blue1Brown. One example

manim/renderer/cairo_renderer.py

@@ -37,10 +37,9 @@ def handle_play_like_call(func):
     """
 
     def wrapper(self, scene, *args, **kwargs):
-        allow_write = not config["skip_animations"]
-        self.file_writer.begin_animation(allow_write)
+        self.file_writer.begin_animation(not self.skip_animations)
         func(self, scene, *args, **kwargs)
-        self.file_writer.end_animation(allow_write)
+        self.file_writer.end_animation(not self.skip_animations)
         self.num_plays += 1
 
     return wrapper
@@ -53,7 +52,7 @@ class CairoRenderer:
     time: time elapsed since initialisation of scene.
     """
 
-    def __init__(self, camera_class=None, **kwargs):
+    def __init__(self, camera_class=None, skip_animations=False, **kwargs):
         # All of the following are set to EITHER the value passed via kwargs,
         # OR the value stored in the global config dict at the time of
         # _instance construction_.  Before, they were in the CONFIG dict, which
@@ -72,7 +71,8 @@ def __init__(self, camera_class=None, **kwargs):
             self.video_quality_config[attr] = kwargs.get(attr, config[attr])
         camera_cls = camera_class if camera_class is not None else Camera
         self.camera = camera_cls(self.video_quality_config)
-        self.original_skipping_status = config["skip_animations"]
+        self.original_skipping_status = skip_animations
+        self.skip_animations = skip_animations
         self.animations_hashes = []
         self.num_plays = 0
         self.time = 0
@@ -116,7 +116,7 @@ def update_frame(  # TODO Description in Docstring
         **kwargs
 
         """
-        if config["skip_animations"] and not ignore_skipping:
+        if self.skip_animations and not ignore_skipping:
             return
         if mobjects is None:
             mobjects = list_update(
@@ -156,7 +156,7 @@ def add_frame(self, frame, num_frames=1):
         """
         dt = 1 / self.camera.frame_rate
         self.time += num_frames * dt
-        if config["skip_animations"]:
+        if self.skip_animations:
             return
         for _ in range(num_frames):
             self.file_writer.write_frame(frame)
@@ -179,29 +179,14 @@ def update_skipping_status(self):
         """
         if config["from_animation_number"]:
             if self.num_plays < config["from_animation_number"]:
-                config["skip_animations"] = True
+                self.skip_animations = True
         if config["upto_animation_number"]:
             if self.num_plays > config["upto_animation_number"]:
-                config["skip_animations"] = True
+                self.skip_animations = True
                 raise EndSceneEarlyException()
 
-    def revert_to_original_skipping_status(self):
-        """
-        Forces the scene to go back to its original skipping status,
-        by setting skip_animations to whatever it reads
-        from original_skipping_status.
-
-        Returns
-        -------
-        Scene
-            The Scene, with the original skipping status.
-        """
-        if hasattr(self, "original_skipping_status"):
-            config["skip_animations"] = self.original_skipping_status
-        return self
-
     def finish(self, scene):
-        config["skip_animations"] = False
+        self.skip_animations = self.original_skipping_status
         self.file_writer.finish()
         if config["save_last_frame"]:
             self.update_frame(scene, ignore_skipping=False)

manim/scene/scene.py

@@ -58,15 +58,17 @@ def construct(self):
 
     CONFIG = {
         "camera_class": Camera,
-        "skip_animations": False,
         "always_update_mobjects": False,
         "random_seed": 0,
     }
 
     def __init__(self, renderer=None, **kwargs):
         Container.__init__(self, **kwargs)
         if renderer is None:
-            self.renderer = CairoRenderer(camera_class=self.camera_class)
+            self.renderer = CairoRenderer(
+                camera_class=self.camera_class,
+                skip_animations=kwargs.get("skip_animations", False),
+            )
         else:
             self.renderer = renderer
         self.renderer.init(self)
@@ -78,8 +80,6 @@ def __init__(self, renderer=None, **kwargs):
             random.seed(self.random_seed)
             np.random.seed(self.random_seed)
 
-        self.setup()
-
     @property
     def camera(self):
         return self.renderer.camera
@@ -88,14 +88,12 @@ def render(self):
         """
         Render this Scene.
         """
-        self.original_skipping_status = config["skip_animations"]
+        self.setup()
         try:
             self.construct()
         except EndSceneEarlyException:
             pass
         self.tear_down()
-        # We have to reset these settings in case of multiple renders.
-        config["skip_animations"] = self.original_skipping_status
         self.renderer.finish(self)
         logger.info(
             f"Rendered {str(self)}\nPlayed {self.renderer.num_plays} animations"
@@ -642,7 +640,7 @@ def get_time_progression(
         ProgressDisplay
             The CommandLine Progress Bar.
         """
-        if config["skip_animations"] and not override_skip_animations:
+        if self.renderer.skip_animations and not override_skip_animations:
             times = [run_time]
         else:
             step = 1 / self.renderer.camera.frame_rate
@@ -858,7 +856,7 @@ def add_sound(self, sound_file, time_offset=0, gain=None, **kwargs):
         gain :
 
         """
-        if config["skip_animations"]:
+        if self.renderer.skip_animations:
             return
         time = self.time + time_offset
         self.renderer.file_writer.add_sound(sound_file, time, gain, **kwargs)

manim/utils/caching.py

@@ -19,11 +19,11 @@ def handle_caching_play(func):
     """
 
     def wrapper(self, scene, *args, **kwargs):
-        self.revert_to_original_skipping_status()
+        self.skip_animations = self.original_skipping_status
         self.update_skipping_status()
         animations = scene.compile_play_args_to_animation_list(*args, **kwargs)
         scene.add_mobjects_from_animations(animations)
-        if config["skip_animations"]:
+        if self.skip_animations:
             logger.debug(f"Skipping animation {self.num_plays}")
             func(self, scene, *args, **kwargs)
             # If the animation is skipped, we mark its hash as None.
@@ -41,7 +41,7 @@ def wrapper(self, scene, *args, **kwargs):
                     f"Animation {self.num_plays} : Using cached data (hash : %(hash_play)s)",
                     {"hash_play": hash_play},
                 )
-                config["skip_animations"] = True
+                self.skip_animations = True
         else:
             hash_play = "uncached_{:05}".format(self.num_plays)
         self.animations_hashes.append(hash_play)