mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-07-15 00:52:15 +08:00
Merge branch 'main' into reorganize
This commit is contained in:
@ -13,10 +13,43 @@ from .base import BaseSlide
|
||||
|
||||
class Slide(BaseSlide, Scene): # type: ignore[misc]
|
||||
"""
|
||||
Inherits from :class:`Scene<manim.scene.scene.Scene>` and provide necessary tools
|
||||
Inherits from :class:`Scene<manim.scene.scene.Scene>` and provides necessary tools
|
||||
for slides rendering.
|
||||
|
||||
:param args: Positional arguments passed to scene object.
|
||||
:param pathlib.Path output_folder: Where the slide animation files should be written.
|
||||
:param kwargs: Keyword arguments passed to scene object.
|
||||
:cvar bool disable_caching: :data:`False`: Whether to disable the use of
|
||||
cached animation files.
|
||||
:cvar bool flush_cache: :data:`False`: Whether to flush the cache.
|
||||
Unlike with Manim, flushing is performed before rendering.
|
||||
:cvar bool skip_reversing: :data:`False`: Whether to generate reversed animations.
|
||||
If set to :data:`False`, and no cached reversed animation
|
||||
exists (or caching is disabled) for a given slide,
|
||||
then the reversed animation will be simply the same
|
||||
as the original one, i.e., ``rev_file = file``,
|
||||
for the current slide config.
|
||||
:cvar typing.Optional[float] max_duration_before_split_reverse: :data:`4.0`: Maximum duration
|
||||
before of a video animation before it is reversed by splitting the file into smaller chunks.
|
||||
Generating reversed animations can require an important amount of
|
||||
memory (because the whole video needs to be kept in memory),
|
||||
and splitting the video into multiple chunks usually speeds
|
||||
up the process (because it can be done in parallel) while taking
|
||||
less memory.
|
||||
Set this to :data:`None` to disable splitting the file into chunks.
|
||||
:cvar typing.Optional[int] num_processes: :data:`None`: Number of processes
|
||||
to use for parallelizable operations.
|
||||
If :data:`None`, defaults to :func:`os.process_cpu_count`.
|
||||
This is currently used when generating reversed animations, and can
|
||||
increase memory consumption.
|
||||
"""
|
||||
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||
# OpenGL renderer disables 'write_to_movie' by default
|
||||
# which is required for saving the animations
|
||||
config["write_to_movie"] = True
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
@property
|
||||
def _frame_shape(self) -> tuple[float, float]:
|
||||
if isinstance(self.renderer, OpenGLRenderer):
|
||||
@ -75,6 +108,15 @@ class Slide(BaseSlide, Scene): # type: ignore[misc]
|
||||
def _start_at_animation_number(self) -> Optional[int]:
|
||||
return config["from_animation_number"] # type: ignore
|
||||
|
||||
def play(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""Overload 'self.play' and increment animation count."""
|
||||
super().play(*args, **kwargs)
|
||||
|
||||
if self._base_slide_config.skip_animations:
|
||||
# Manim will not render the animations, so we reset the animation
|
||||
# counter to the previous value
|
||||
self._current_animation -= 1
|
||||
|
||||
def next_section(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""
|
||||
Alias to :meth:`next_slide`.
|
||||
@ -97,23 +139,41 @@ class Slide(BaseSlide, Scene): # type: ignore[misc]
|
||||
base_slide_config: BaseSlideConfig,
|
||||
**kwargs: Any,
|
||||
) -> None:
|
||||
Scene.next_section(self, *args, **kwargs)
|
||||
Scene.next_section(
|
||||
self,
|
||||
*args,
|
||||
skip_animations=base_slide_config.skip_animations | self._skip_animations,
|
||||
**kwargs,
|
||||
)
|
||||
BaseSlide.next_slide.__wrapped__(
|
||||
self,
|
||||
base_slide_config=base_slide_config,
|
||||
)
|
||||
|
||||
def render(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""MANIM render."""
|
||||
"""MANIM renderer."""
|
||||
# We need to disable the caching limit since we rely on intermediate files
|
||||
max_files_cached = config["max_files_cached"]
|
||||
config["max_files_cached"] = float("inf")
|
||||
|
||||
flush_manim_cache = config["flush_cache"]
|
||||
|
||||
if flush_manim_cache:
|
||||
# We need to postpone flushing *after* we saved slides
|
||||
config["flush_cache"] = False
|
||||
|
||||
super().render(*args, **kwargs)
|
||||
|
||||
config["max_files_cached"] = max_files_cached
|
||||
|
||||
self._save_slides()
|
||||
self._save_slides(
|
||||
use_cache=not (config["disable_caching"] or self.disable_caching),
|
||||
flush_cache=(config["flush_cache"] or self.flush_cache),
|
||||
skip_reversing=self.skip_reversing,
|
||||
)
|
||||
|
||||
if flush_manim_cache:
|
||||
self.renderer.file_writer.flush_cache_directory()
|
||||
|
||||
|
||||
class ThreeDSlide(Slide, ThreeDScene): # type: ignore[misc]
|
||||
|
Reference in New Issue
Block a user