manim 0.17.0__py3-none-any.whl → 0.19.1__py3-none-any.whl

manim/constants.py

@@ -1,15 +1,16 @@
-"""
-Constant definitions.
-"""
+"""Constant definitions."""
 
 from __future__ import annotations
 
 from enum import Enum
+from typing import TypedDict
 
 import numpy as np
 from cloup import Context
 from PIL.Image import Resampling
 
+from manim.typing import Vector3D
+
 __all__ = [
     "SCENE_NOT_FOUND_MESSAGE",
     "CHOOSE_NUMBER_MESSAGE",
@@ -62,6 +63,7 @@ __all__ = [
     "DEFAULT_POINT_DENSITY_1D",
     "DEFAULT_STROKE_WIDTH",
     "DEFAULT_FONT_SIZE",
+    "SCALE_FACTOR_PER_FONT_POINT",
     "PI",
     "TAU",
     "DEGREES",
@@ -73,37 +75,38 @@ __all__ = [
     "CTRL_VALUE",
     "RendererType",
     "LineJointType",
+    "CapStyleType",
 ]
 # Messages
 
-SCENE_NOT_FOUND_MESSAGE: str = """
+SCENE_NOT_FOUND_MESSAGE = """
    {} is not in the script
 """
-CHOOSE_NUMBER_MESSAGE: str = """
+CHOOSE_NUMBER_MESSAGE = """
 Choose number corresponding to desired scene/arguments.
-(Use comma separated list for multiple entries)
+(Use comma separated list for multiple entries or use "*" to select all scenes.)
 Choice(s): """
-INVALID_NUMBER_MESSAGE: str = "Invalid scene numbers have been specified. Aborting."
-NO_SCENE_MESSAGE: str = """
+INVALID_NUMBER_MESSAGE = "Invalid scene numbers have been specified. Aborting."
+NO_SCENE_MESSAGE = """
    There are no scenes inside that module
 """
 
 # Pango stuff
-NORMAL: str = "NORMAL"
-ITALIC: str = "ITALIC"
-OBLIQUE: str = "OBLIQUE"
-BOLD: str = "BOLD"
+NORMAL = "NORMAL"
+ITALIC = "ITALIC"
+OBLIQUE = "OBLIQUE"
+BOLD = "BOLD"
 # Only for Pango from below
-THIN: str = "THIN"
-ULTRALIGHT: str = "ULTRALIGHT"
-LIGHT: str = "LIGHT"
-SEMILIGHT: str = "SEMILIGHT"
-BOOK: str = "BOOK"
-MEDIUM: str = "MEDIUM"
-SEMIBOLD: str = "SEMIBOLD"
-ULTRABOLD: str = "ULTRABOLD"
-HEAVY: str = "HEAVY"
-ULTRAHEAVY: str = "ULTRAHEAVY"
+THIN = "THIN"
+ULTRALIGHT = "ULTRALIGHT"
+LIGHT = "LIGHT"
+SEMILIGHT = "SEMILIGHT"
+BOOK = "BOOK"
+MEDIUM = "MEDIUM"
+SEMIBOLD = "SEMIBOLD"
+ULTRABOLD = "ULTRABOLD"
+HEAVY = "HEAVY"
+ULTRAHEAVY = "ULTRAHEAVY"
 
 RESAMPLING_ALGORITHMS = {
     "nearest": Resampling.NEAREST,
@@ -119,83 +122,92 @@ RESAMPLING_ALGORITHMS = {
 }
 
 # Geometry: directions
-ORIGIN: np.ndarray = np.array((0.0, 0.0, 0.0))
+ORIGIN: Vector3D = np.array((0.0, 0.0, 0.0))
 """The center of the coordinate system."""
 
-UP: np.ndarray = np.array((0.0, 1.0, 0.0))
+UP: Vector3D = np.array((0.0, 1.0, 0.0))
 """One unit step in the positive Y direction."""
 
-DOWN: np.ndarray = np.array((0.0, -1.0, 0.0))
+DOWN: Vector3D = np.array((0.0, -1.0, 0.0))
 """One unit step in the negative Y direction."""
 
-RIGHT: np.ndarray = np.array((1.0, 0.0, 0.0))
+RIGHT: Vector3D = np.array((1.0, 0.0, 0.0))
 """One unit step in the positive X direction."""
 
-LEFT: np.ndarray = np.array((-1.0, 0.0, 0.0))
+LEFT: Vector3D = np.array((-1.0, 0.0, 0.0))
 """One unit step in the negative X direction."""
 
-IN: np.ndarray = np.array((0.0, 0.0, -1.0))
+IN: Vector3D = np.array((0.0, 0.0, -1.0))
 """One unit step in the negative Z direction."""
 
-OUT: np.ndarray = np.array((0.0, 0.0, 1.0))
+OUT: Vector3D = np.array((0.0, 0.0, 1.0))
 """One unit step in the positive Z direction."""
 
 # Geometry: axes
-X_AXIS: np.ndarray = np.array((1.0, 0.0, 0.0))
-Y_AXIS: np.ndarray = np.array((0.0, 1.0, 0.0))
-Z_AXIS: np.ndarray = np.array((0.0, 0.0, 1.0))
+X_AXIS: Vector3D = np.array((1.0, 0.0, 0.0))
+Y_AXIS: Vector3D = np.array((0.0, 1.0, 0.0))
+Z_AXIS: Vector3D = np.array((0.0, 0.0, 1.0))
 
 # Geometry: useful abbreviations for diagonals
-UL: np.ndarray = UP + LEFT
+UL: Vector3D = UP + LEFT
 """One step up plus one step left."""
 
-UR: np.ndarray = UP + RIGHT
+UR: Vector3D = UP + RIGHT
 """One step up plus one step right."""
 
-DL: np.ndarray = DOWN + LEFT
+DL: Vector3D = DOWN + LEFT
 """One step down plus one step left."""
 
-DR: np.ndarray = DOWN + RIGHT
+DR: Vector3D = DOWN + RIGHT
 """One step down plus one step right."""
 
 # Geometry
-START_X: int = 30
-START_Y: int = 20
-DEFAULT_DOT_RADIUS: float = 0.08
-DEFAULT_SMALL_DOT_RADIUS: float = 0.04
-DEFAULT_DASH_LENGTH: float = 0.05
-DEFAULT_ARROW_TIP_LENGTH: float = 0.35
+START_X = 30
+START_Y = 20
+DEFAULT_DOT_RADIUS = 0.08
+DEFAULT_SMALL_DOT_RADIUS = 0.04
+DEFAULT_DASH_LENGTH = 0.05
+DEFAULT_ARROW_TIP_LENGTH = 0.35
 
 # Default buffers (padding)
-SMALL_BUFF: float = 0.1
-MED_SMALL_BUFF: float = 0.25
-MED_LARGE_BUFF: float = 0.5
-LARGE_BUFF: float = 1
-DEFAULT_MOBJECT_TO_EDGE_BUFFER: float = MED_LARGE_BUFF
-DEFAULT_MOBJECT_TO_MOBJECT_BUFFER: float = MED_SMALL_BUFF
+SMALL_BUFF = 0.1
+MED_SMALL_BUFF = 0.25
+MED_LARGE_BUFF = 0.5
+LARGE_BUFF = 1
+DEFAULT_MOBJECT_TO_EDGE_BUFFER = MED_LARGE_BUFF
+DEFAULT_MOBJECT_TO_MOBJECT_BUFFER = MED_SMALL_BUFF
 
 # Times in seconds
-DEFAULT_POINTWISE_FUNCTION_RUN_TIME: float = 3.0
-DEFAULT_WAIT_TIME: float = 1.0
+DEFAULT_POINTWISE_FUNCTION_RUN_TIME = 3.0
+DEFAULT_WAIT_TIME = 1.0
 
 # Misc
-DEFAULT_POINT_DENSITY_2D: int = 25
-DEFAULT_POINT_DENSITY_1D: int = 10
-DEFAULT_STROKE_WIDTH: int = 4
-DEFAULT_FONT_SIZE: float = 48
+DEFAULT_POINT_DENSITY_2D = 25
+DEFAULT_POINT_DENSITY_1D = 10
+DEFAULT_STROKE_WIDTH = 4
+DEFAULT_FONT_SIZE = 48
+SCALE_FACTOR_PER_FONT_POINT = 1 / 960
 
 # Mathematical constants
-PI: float = np.pi
+PI = np.pi
 """The ratio of the circumference of a circle to its diameter."""
 
-TAU: float = 2 * PI
+TAU = 2 * PI
 """The ratio of the circumference of a circle to its radius."""
 
-DEGREES: float = TAU / 360
+DEGREES = TAU / 360
 """The exchange rate between radians and degrees."""
 
+
+class QualityDict(TypedDict):
+    flag: str | None
+    pixel_height: int
+    pixel_width: int
+    frame_rate: int
+
+
 # Video qualities
-QUALITIES: dict[str, dict[str, str | int | None]] = {
+QUALITIES: dict[str, QualityDict] = {
     "fourk_quality": {
         "flag": "k",
         "pixel_height": 2160,
@@ -234,7 +246,7 @@ QUALITIES: dict[str, dict[str, str | int | None]] = {
     },
 }
 
-DEFAULT_QUALITY: str = "high_quality"
+DEFAULT_QUALITY = "high_quality"
 
 EPILOG = "Made with <3 by Manim Community developers."
 SHIFT_VALUE = 65505
@@ -301,3 +313,41 @@ class LineJointType(Enum):
     ROUND = 1
     BEVEL = 2
     MITER = 3
+
+
+class CapStyleType(Enum):
+    """Collection of available cap styles.
+
+    See the example below for a visual illustration of the different
+    cap styles.
+
+    Examples
+    --------
+
+    .. manim:: CapStyleVariants
+        :save_last_frame:
+
+        class CapStyleVariants(Scene):
+            def construct(self):
+                arcs = VGroup(*[
+                    Arc(
+                        radius=1,
+                        start_angle=0,
+                        angle=TAU / 4,
+                        stroke_width=20,
+                        color=GREEN,
+                        cap_style=cap_style,
+                    )
+                    for cap_style in CapStyleType
+                ])
+                arcs.arrange(RIGHT, buff=1)
+                self.add(arcs)
+                for arc in arcs:
+                    label = Text(arc.cap_style.name, font_size=24).next_to(arc, DOWN)
+                    self.add(label)
+    """
+
+    AUTO = 0
+    ROUND = 1
+    BUTT = 2
+    SQUARE = 3

manim/data_structures.py

@@ -0,0 +1,31 @@
+"""Data classes and other necessary data structures for use in Manim."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from dataclasses import dataclass
+from types import MethodType
+from typing import Any
+
+
+@dataclass
+class MethodWithArgs:
+    """Object containing a :attr:`method` which is intended to be called later
+    with the positional arguments :attr:`args` and the keyword arguments
+    :attr:`kwargs`.
+
+    Attributes
+    ----------
+    method : MethodType
+        A callable representing a method of some class.
+    args : Iterable[Any]
+        Positional arguments for :attr:`method`.
+    kwargs : dict[str, Any]
+        Keyword arguments for :attr:`method`.
+    """
+
+    __slots__ = ["method", "args", "kwargs"]
+
+    method: MethodType
+    args: Iterable[Any]
+    kwargs: dict[str, Any]

manim/mobject/frame.py

@@ -8,31 +8,34 @@ __all__ = [
 ]
 
 
+from typing import Any
+
 from manim.mobject.geometry.polygram import Rectangle
 
 from .. import config
 
 
 class ScreenRectangle(Rectangle):
-    def __init__(self, aspect_ratio=16.0 / 9.0, height=4, **kwargs):
+    def __init__(
+        self, aspect_ratio: float = 16.0 / 9.0, height: float = 4, **kwargs: Any
+    ) -> None:
         super().__init__(width=aspect_ratio * height, height=height, **kwargs)
 
     @property
-    def aspect_ratio(self):
+    def aspect_ratio(self) -> float:
         """The aspect ratio.
 
         When set, the width is stretched to accommodate
         the new aspect ratio.
         """
-
         return self.width / self.height
 
     @aspect_ratio.setter
-    def aspect_ratio(self, value):
+    def aspect_ratio(self, value: float) -> None:
         self.stretch_to_fit_width(value * self.height)
 
 
 class FullScreenRectangle(ScreenRectangle):
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
         self.height = config["frame_height"]

manim/mobject/geometry/__init__.py

@@ -8,6 +8,7 @@ Modules
 
     ~arc
     ~boolean_ops
+    ~labeled
     ~line
     ~polygram
     ~shape_matchers