manim 0.17.3__py3-none-any.whl → 0.18.0.post0__py3-none-any.whl

manim/mobject/geometry/shape_matchers.py

@@ -4,13 +4,17 @@ from __future__ import annotations
 
 __all__ = ["SurroundingRectangle", "BackgroundRectangle", "Cross", "Underline"]
 
+from typing import Any
+
+from typing_extensions import Self
+
 from manim import config, logger
 from manim.constants import *
 from manim.mobject.geometry.line import Line
 from manim.mobject.geometry.polygram import RoundedRectangle
 from manim.mobject.mobject import Mobject
 from manim.mobject.types.vectorized_mobject import VGroup
-from manim.utils.color import BLACK, RED, YELLOW, Color, Colors
+from manim.utils.color import BLACK, RED, YELLOW, ManimColor, ParsableManimColor
 
 
 class SurroundingRectangle(RoundedRectangle):
@@ -38,8 +42,13 @@ class SurroundingRectangle(RoundedRectangle):
     """
 
     def __init__(
-        self, mobject, color=YELLOW, buff=SMALL_BUFF, corner_radius=0.0, **kwargs
-    ):
+        self,
+        mobject: Mobject,
+        color: ParsableManimColor = YELLOW,
+        buff: float = SMALL_BUFF,
+        corner_radius: float = 0.0,
+        **kwargs,
+    ) -> None:
         super().__init__(
             color=color,
             width=mobject.width + 2 * buff,
@@ -78,8 +87,8 @@ class BackgroundRectangle(SurroundingRectangle):
 
     def __init__(
         self,
-        mobject,
-        color: Colors | None = None,
+        mobject: Mobject,
+        color: ParsableManimColor | None = None,
         stroke_width: float = 0,
         stroke_opacity: float = 0,
         fill_opacity: float = 0.75,
@@ -98,13 +107,13 @@ class BackgroundRectangle(SurroundingRectangle):
             buff=buff,
             **kwargs,
         )
-        self.original_fill_opacity = self.fill_opacity
+        self.original_fill_opacity: float = self.fill_opacity
 
-    def pointwise_become_partial(self, mobject, a, b):
+    def pointwise_become_partial(self, mobject: Mobject, a: Any, b: float) -> Self:
         self.set_fill(opacity=b * self.original_fill_opacity)
         return self
 
-    def set_style(self, fill_opacity, **kwargs):
+    def set_style(self, fill_opacity: float, **kwargs) -> Self:
         # Unchangeable style, except for fill_opacity
         # All other style arguments are ignored
         super().set_style(
@@ -120,8 +129,8 @@ class BackgroundRectangle(SurroundingRectangle):
             )
         return self
 
-    def get_fill_color(self):
-        return Color(self.color)
+    def get_fill_color(self) -> ManimColor:
+        return self.color
 
 
 class Cross(VGroup):
@@ -152,11 +161,11 @@ class Cross(VGroup):
     def __init__(
         self,
         mobject: Mobject | None = None,
-        stroke_color: Color = RED,
-        stroke_width: float = 6,
-        scale_factor: float = 1,
+        stroke_color: ParsableManimColor = RED,
+        stroke_width: float = 6.0,
+        scale_factor: float = 1.0,
         **kwargs,
-    ):
+    ) -> None:
         super().__init__(
             Line(UP + LEFT, DOWN + RIGHT), Line(UP + RIGHT, DOWN + LEFT), **kwargs
         )
@@ -181,7 +190,7 @@ class Underline(Line):
                 self.add(man, ul)
     """
 
-    def __init__(self, mobject, buff=SMALL_BUFF, **kwargs):
+    def __init__(self, mobject: Mobject, buff: float = SMALL_BUFF, **kwargs) -> None:
         super().__init__(LEFT, RIGHT, buff=buff, **kwargs)
         self.match_width(mobject)
         self.next_to(mobject, DOWN, buff=self.buff)

manim/mobject/geometry/tips.py

@@ -13,6 +13,8 @@ __all__ = [
     "StealthTip",
 ]
 
+from typing import TYPE_CHECKING
+
 import numpy as np
 
 from manim.constants import *
@@ -22,6 +24,9 @@ from manim.mobject.opengl.opengl_compatibility import ConvertToOpenGL
 from manim.mobject.types.vectorized_mobject import VMobject
 from manim.utils.space_ops import angle_of_vector
 
+if TYPE_CHECKING:
+    from manim.typing import Point3D, Vector
+
 
 class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
     r"""Base class for arrow tips.
@@ -76,30 +81,41 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
     .. manim:: ArrowTipsShowcase
         :save_last_frame:
 
-        from manim.mobject.geometry.tips import ArrowTriangleTip,\
-                                                ArrowSquareTip, ArrowSquareFilledTip,\
-                                                ArrowCircleTip, ArrowCircleFilledTip
         class ArrowTipsShowcase(Scene):
             def construct(self):
-                a00 = Arrow(start=[-2, 3, 0], end=[2, 3, 0], color=YELLOW)
-                a11 = Arrow(start=[-2, 2, 0], end=[2, 2, 0], tip_shape=ArrowTriangleTip)
-                a12 = Arrow(start=[-2, 1, 0], end=[2, 1, 0])
-                a21 = Arrow(start=[-2, 0, 0], end=[2, 0, 0], tip_shape=ArrowSquareTip)
-                a22 = Arrow([-2, -1, 0], [2, -1, 0], tip_shape=ArrowSquareFilledTip)
-                a31 = Arrow([-2, -2, 0], [2, -2, 0], tip_shape=ArrowCircleTip)
-                a32 = Arrow([-2, -3, 0], [2, -3, 0], tip_shape=ArrowCircleFilledTip)
-                b11 = a11.copy().scale(0.5, scale_tips=True).next_to(a11, RIGHT)
-                b12 = a12.copy().scale(0.5, scale_tips=True).next_to(a12, RIGHT)
-                b21 = a21.copy().scale(0.5, scale_tips=True).next_to(a21, RIGHT)
-                self.add(a00, a11, a12, a21, a22, a31, a32, b11, b12, b21)
-
+                tip_names = [
+                    'Default (YELLOW)', 'ArrowTriangleTip', 'Default', 'ArrowSquareTip',
+                    'ArrowSquareFilledTip', 'ArrowCircleTip', 'ArrowCircleFilledTip', 'StealthTip'
+                ]
+
+                big_arrows = [
+                    Arrow(start=[-4, 3.5, 0], end=[2, 3.5, 0], color=YELLOW),
+                    Arrow(start=[-4, 2.5, 0], end=[2, 2.5, 0], tip_shape=ArrowTriangleTip),
+                    Arrow(start=[-4, 1.5, 0], end=[2, 1.5, 0]),
+                    Arrow(start=[-4, 0.5, 0], end=[2, 0.5, 0], tip_shape=ArrowSquareTip),
+
+                    Arrow([-4, -0.5, 0], [2, -0.5, 0], tip_shape=ArrowSquareFilledTip),
+                    Arrow([-4, -1.5, 0], [2, -1.5, 0], tip_shape=ArrowCircleTip),
+                    Arrow([-4, -2.5, 0], [2, -2.5, 0], tip_shape=ArrowCircleFilledTip),
+                    Arrow([-4, -3.5, 0], [2, -3.5, 0], tip_shape=StealthTip)
+                ]
+
+                small_arrows = (
+                    arrow.copy().scale(0.5, scale_tips=True).next_to(arrow, RIGHT) for arrow in big_arrows
+                )
+
+                labels = (
+                    Text(tip_names[i], font='monospace', font_size=20, color=BLUE).next_to(big_arrows[i], LEFT) for i in range(len(big_arrows))
+                )
+
+                self.add(*big_arrows, *small_arrows, *labels)
     """
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         raise NotImplementedError("Has to be implemented in inheriting subclasses.")
 
     @property
-    def base(self):
+    def base(self) -> Point3D:
         r"""The base point of the arrow tip.
 
         This is the point connecting to the arrow line.
@@ -117,7 +133,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         return self.point_from_proportion(0.5)
 
     @property
-    def tip_point(self):
+    def tip_point(self) -> Point3D:
         r"""The tip point of the arrow tip.
 
         Examples
@@ -133,7 +149,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         return self.points[0]
 
     @property
-    def vector(self):
+    def vector(self) -> Vector:
         r"""The vector pointing from the base point to the tip point.
 
         Examples
@@ -149,7 +165,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         return self.tip_point - self.base
 
     @property
-    def tip_angle(self):
+    def tip_angle(self) -> float:
         r"""The angle of the arrow tip.
 
         Examples
@@ -165,7 +181,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         return angle_of_vector(self.vector)
 
     @property
-    def length(self):
+    def length(self) -> np.floating:
         r"""The length of the arrow tip.
 
         Examples
@@ -227,13 +243,13 @@ class ArrowTriangleTip(ArrowTip, Triangle):
 
     def __init__(
         self,
-        fill_opacity=0,
-        stroke_width=3,
-        length=DEFAULT_ARROW_TIP_LENGTH,
-        width=DEFAULT_ARROW_TIP_LENGTH,
-        start_angle=PI,
+        fill_opacity: float = 0,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH,
+        width: float = DEFAULT_ARROW_TIP_LENGTH,
+        start_angle: float = PI,
         **kwargs,
-    ):
+    ) -> None:
         Triangle.__init__(
             self,
             fill_opacity=fill_opacity,
@@ -253,7 +269,9 @@ class ArrowTriangleFilledTip(ArrowTriangleTip):
     This is the default arrow tip shape.
     """
 
-    def __init__(self, fill_opacity=1, stroke_width=0, **kwargs):
+    def __init__(
+        self, fill_opacity: float = 1, stroke_width: float = 0, **kwargs
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)
 
 
@@ -262,12 +280,12 @@ class ArrowCircleTip(ArrowTip, Circle):
 
     def __init__(
         self,
-        fill_opacity=0,
-        stroke_width=3,
-        length=DEFAULT_ARROW_TIP_LENGTH,
-        start_angle=PI,
+        fill_opacity: float = 0,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH,
+        start_angle: float = PI,
         **kwargs,
-    ):
+    ) -> None:
         self.start_angle = start_angle
         Circle.__init__(
             self, fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs
@@ -279,7 +297,9 @@ class ArrowCircleTip(ArrowTip, Circle):
 class ArrowCircleFilledTip(ArrowCircleTip):
     r"""Circular arrow tip with filled tip."""
 
-    def __init__(self, fill_opacity=1, stroke_width=0, **kwargs):
+    def __init__(
+        self, fill_opacity: float = 1, stroke_width: float = 0, **kwargs
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)
 
 
@@ -288,12 +308,12 @@ class ArrowSquareTip(ArrowTip, Square):
 
     def __init__(
         self,
-        fill_opacity=0,
-        stroke_width=3,
-        length=DEFAULT_ARROW_TIP_LENGTH,
-        start_angle=PI,
+        fill_opacity: float = 0,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH,
+        start_angle: float = PI,
         **kwargs,
-    ):
+    ) -> None:
         self.start_angle = start_angle
         Square.__init__(
             self,
@@ -309,5 +329,7 @@ class ArrowSquareTip(ArrowTip, Square):
 class ArrowSquareFilledTip(ArrowSquareTip):
     r"""Square arrow tip with filled tip."""
 
-    def __init__(self, fill_opacity=1, stroke_width=0, **kwargs):
+    def __init__(
+        self, fill_opacity: float = 1, stroke_width: float = 0, **kwargs
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)

manim/mobject/graph.py

@@ -112,13 +112,12 @@ def _tree_layout(
     vertex_spacing: tuple | None = None,
     orientation: str = "down",
 ):
-    children = {root_vertex: list(T.neighbors(root_vertex))}
-
-    if not nx.is_tree(T):
-        raise ValueError("The tree layout must be used with trees")
     if root_vertex is None:
         raise ValueError("The tree layout requires the root_vertex parameter")
+    if not nx.is_tree(T):
+        raise ValueError("The tree layout must be used with trees")
 
+    children = {root_vertex: list(T.neighbors(root_vertex))}
     # The following code is SageMath's tree layout implementation, taken from
     # https://github.com/sagemath/sage/blob/cc60cfebc4576fed8b01f0fc487271bdee3cefed/src/sage/graphs/graph_plot.py#L1447