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

manim/mobject/geometry/tips.py

@@ -8,8 +8,13 @@ __all__ = [
     "ArrowCircleTip",
     "ArrowSquareTip",
     "ArrowSquareFilledTip",
+    "ArrowTriangleTip",
+    "ArrowTriangleFilledTip",
+    "StealthTip",
 ]
 
+from typing import TYPE_CHECKING, Any
+
 import numpy as np
 
 from manim.constants import *
@@ -19,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, Vector3D
+
 
 class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
     r"""Base class for arrow tips.
@@ -30,6 +38,7 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         :class:`ArrowCircleFilledTip`
         :class:`ArrowSquareTip`
         :class:`ArrowSquareFilledTip`
+        :class:`StealthTip`
 
     Examples
     --------
@@ -51,8 +60,9 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
         ...         RegularPolygon.__init__(self, n=5, **kwargs)
         ...         self.width = length
         ...         self.stretch_to_fit_height(length)
-        >>> arr = Arrow(np.array([-2, -2, 0]), np.array([2, 2, 0]),
-        ...             tip_shape=MyCustomArrowTip)
+        >>> arr = Arrow(
+        ...     np.array([-2, -2, 0]), np.array([2, 2, 0]), tip_shape=MyCustomArrowTip
+        ... )
         >>> isinstance(arr.tip, RegularPolygon)
         True
         >>> from manim import Scene, Create
@@ -72,30 +82,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: Any, **kwargs: Any) -> 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.
@@ -113,7 +134,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
@@ -126,10 +147,14 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
             array([2., 0., 0.])
 
         """
-        return self.points[0]
+        # Type inference of extracting an element from a list, is not
+        # supported by numpy, see this numpy issue
+        # https://github.com/numpy/numpy/issues/16544
+        tip_point: Point3D = self.points[0]
+        return tip_point
 
     @property
-    def vector(self):
+    def vector(self) -> Vector3D:
         r"""The vector pointing from the base point to the tip point.
 
         Examples
@@ -145,7 +170,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
@@ -154,14 +179,14 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
 
             >>> from manim import Arrow
             >>> arrow = Arrow(np.array([0, 0, 0]), np.array([1, 1, 0]), buff=0)
-            >>> round(arrow.tip.tip_angle, 5) == round(PI/4, 5)
+            >>> bool(round(arrow.tip.tip_angle, 5) == round(PI/4, 5))
             True
 
         """
         return angle_of_vector(self.vector)
 
     @property
-    def length(self):
+    def length(self) -> float:
         r"""The length of the arrow tip.
 
         Examples
@@ -174,7 +199,50 @@ class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
             0.35
 
         """
-        return np.linalg.norm(self.vector)
+        return float(np.linalg.norm(self.vector))
+
+
+class StealthTip(ArrowTip):
+    r"""'Stealth' fighter / kite arrow shape.
+
+    Naming is inspired by the corresponding
+    `TikZ arrow shape <https://tikz.dev/tikz-arrows#sec-16.3>`__.
+    """
+
+    def __init__(
+        self,
+        fill_opacity: float = 1,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH / 2,
+        start_angle: float = PI,
+        **kwargs: Any,
+    ):
+        self.start_angle = start_angle
+        VMobject.__init__(
+            self, fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs
+        )
+        self.set_points_as_corners(
+            np.array(
+                [
+                    [2, 0, 0],  # tip
+                    [-1.2, 1.6, 0],
+                    [0, 0, 0],  # base
+                    [-1.2, -1.6, 0],
+                    [2, 0, 0],  # close path, back to tip
+                ]
+            )
+        )
+        self.scale(length / self.length)
+
+    @property
+    def length(self) -> float:
+        """The length of the arrow tip.
+
+        In this case, the length is computed as the height of
+        the triangle encompassing the stealth tip (otherwise,
+        the tip is scaled too large).
+        """
+        return float(np.linalg.norm(self.vector) * 1.6)
 
 
 class ArrowTriangleTip(ArrowTip, Triangle):
@@ -182,13 +250,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,
-        **kwargs,
-    ):
+        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: Any,
+    ) -> None:
         Triangle.__init__(
             self,
             fill_opacity=fill_opacity,
@@ -208,7 +276,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: Any
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)
 
 
@@ -217,12 +287,12 @@ class ArrowCircleTip(ArrowTip, Circle):
 
     def __init__(
         self,
-        fill_opacity=0,
-        stroke_width=3,
-        length=DEFAULT_ARROW_TIP_LENGTH,
-        start_angle=PI,
-        **kwargs,
-    ):
+        fill_opacity: float = 0,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH,
+        start_angle: float = PI,
+        **kwargs: Any,
+    ) -> None:
         self.start_angle = start_angle
         Circle.__init__(
             self, fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs
@@ -234,7 +304,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: Any
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)
 
 
@@ -243,12 +315,12 @@ class ArrowSquareTip(ArrowTip, Square):
 
     def __init__(
         self,
-        fill_opacity=0,
-        stroke_width=3,
-        length=DEFAULT_ARROW_TIP_LENGTH,
-        start_angle=PI,
-        **kwargs,
-    ):
+        fill_opacity: float = 0,
+        stroke_width: float = 3,
+        length: float = DEFAULT_ARROW_TIP_LENGTH,
+        start_angle: float = PI,
+        **kwargs: Any,
+    ) -> None:
         self.start_angle = start_angle
         Square.__init__(
             self,
@@ -264,5 +336,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: Any
+    ) -> None:
         super().__init__(fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs)