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

manim/mobject/text/numbers.py

@@ -4,9 +4,10 @@ from __future__ import annotations
 
 __all__ = ["DecimalNumber", "Integer", "Variable"]
 
-from typing import Sequence
+from typing import Any
 
 import numpy as np
+from typing_extensions import Self
 
 from manim import config
 from manim.constants import *
@@ -15,12 +16,41 @@ from manim.mobject.text.tex_mobject import MathTex, SingleStringMathTex, Tex
 from manim.mobject.text.text_mobject import Text
 from manim.mobject.types.vectorized_mobject import VMobject
 from manim.mobject.value_tracker import ValueTracker
+from manim.typing import Vector3DLike
 
-string_to_mob_map = {}
+string_to_mob_map: dict[str, SingleStringMathTex] = {}
 
 
 class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
-    """An mobject representing a decimal number.
+    r"""An mobject representing a decimal number.
+
+    Parameters
+    ----------
+    number
+        The numeric value to be displayed. It can later be modified using :meth:`.set_value`.
+    num_decimal_places
+        The number of decimal places after the decimal separator. Values are automatically rounded.
+    mob_class
+        The class for rendering digits and units, by default :class:`.MathTex`.
+    include_sign
+        Set to ``True`` to include a sign for positive numbers and zero.
+    group_with_commas
+        When ``True`` thousands groups are separated by commas for readability.
+    digit_buff_per_font_unit
+        Additional spacing between digits. Scales with font size.
+    show_ellipsis
+        When a number has been truncated by rounding, indicate with an ellipsis (``...``).
+    unit
+        A unit string which can be placed to the right of the numerical values.
+    unit_buff_per_font_unit
+        An additional spacing between the numerical values and the unit. A value
+        of ``unit_buff_per_font_unit=0.003`` gives a decent spacing. Scales with font size.
+    include_background_rectangle
+        Adds a background rectangle to increase contrast on busy scenes.
+    edge_to_fix
+        Assuring right- or left-alignment of the full object.
+    font_size
+        Size of the font.
 
     Examples
     --------
@@ -34,6 +64,8 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
                     show_ellipsis=True,
                     num_decimal_places=3,
                     include_sign=True,
+                    unit=r"\text{M-Units}",
+                    unit_buff_per_font_unit=0.003
                 )
                 square = Square().to_edge(UP)
 
@@ -53,20 +85,21 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
         self,
         number: float = 0,
         num_decimal_places: int = 2,
-        mob_class: VMobject = MathTex,
+        mob_class: type[SingleStringMathTex] = MathTex,
         include_sign: bool = False,
         group_with_commas: bool = True,
         digit_buff_per_font_unit: float = 0.001,
         show_ellipsis: bool = False,
         unit: str | None = None,  # Aligned to bottom unless it starts with "^"
+        unit_buff_per_font_unit: float = 0,
         include_background_rectangle: bool = False,
-        edge_to_fix: Sequence[float] = LEFT,
+        edge_to_fix: Vector3DLike = LEFT,
         font_size: float = DEFAULT_FONT_SIZE,
         stroke_width: float = 0,
         fill_opacity: float = 1.0,
-        **kwargs,
+        **kwargs: Any,
     ):
-        super().__init__(**kwargs)
+        super().__init__(**kwargs, fill_opacity=fill_opacity, stroke_width=stroke_width)
         self.number = number
         self.num_decimal_places = num_decimal_places
         self.include_sign = include_sign
@@ -75,10 +108,10 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
         self.digit_buff_per_font_unit = digit_buff_per_font_unit
         self.show_ellipsis = show_ellipsis
         self.unit = unit
+        self.unit_buff_per_font_unit = unit_buff_per_font_unit
         self.include_background_rectangle = include_background_rectangle
         self.edge_to_fix = edge_to_fix
         self._font_size = font_size
-        self.stroke_width = stroke_width
         self.fill_opacity = fill_opacity
 
         self.initial_config = kwargs.copy()
@@ -90,6 +123,7 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
                 "digit_buff_per_font_unit": digit_buff_per_font_unit,
                 "show_ellipsis": show_ellipsis,
                 "unit": unit,
+                "unit_buff_per_font_unit": unit_buff_per_font_unit,
                 "include_background_rectangle": include_background_rectangle,
                 "edge_to_fix": edge_to_fix,
                 "font_size": font_size,
@@ -102,12 +136,13 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
         self.init_colors()
 
     @property
-    def font_size(self):
+    def font_size(self) -> float:
         """The font size of the tex mobject."""
-        return self.height / self.initial_height * self._font_size
+        return_value: float = self.height / self.initial_height * self._font_size
+        return return_value
 
     @font_size.setter
-    def font_size(self, font_val):
+    def font_size(self, font_val: float) -> None:
         if font_val <= 0:
             raise ValueError("font_size must be greater than 0.")
         elif self.height > 0:
@@ -118,7 +153,7 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
             # font_size does not depend on current size.
             self.scale(font_val / self.font_size)
 
-    def _set_submobjects_from_number(self, number):
+    def _set_submobjects_from_number(self, number: float) -> None:
         self.number = number
         self.submobjects = []
 
@@ -131,15 +166,25 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
                 self._string_to_mob("\\dots", SingleStringMathTex, color=self.color),
             )
 
-        if self.unit is not None:
-            self.unit_sign = self._string_to_mob(self.unit, SingleStringMathTex)
-            self.add(self.unit_sign)
-
         self.arrange(
             buff=self.digit_buff_per_font_unit * self._font_size,
             aligned_edge=DOWN,
         )
 
+        if self.unit is not None:
+            self.unit_sign = self._string_to_mob(self.unit, SingleStringMathTex)
+            self.add(
+                self.unit_sign.next_to(
+                    self,
+                    direction=RIGHT,
+                    buff=(self.unit_buff_per_font_unit + self.digit_buff_per_font_unit)
+                    * self._font_size,
+                    aligned_edge=DOWN,
+                )
+            )
+
+        self.move_to(ORIGIN)
+
         # Handle alignment of parts that should be aligned
         # to the bottom
         for i, c in enumerate(num_string):
@@ -152,12 +197,12 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
             self.unit_sign.align_to(self, UP)
 
         # track the initial height to enable scaling via font_size
-        self.initial_height = self.height
+        self.initial_height: float = self.height
 
         if self.include_background_rectangle:
             self.add_background_rectangle()
 
-    def _get_num_string(self, number):
+    def _get_num_string(self, number: float | complex) -> str:
         if isinstance(number, complex):
             formatter = self._get_complex_formatter()
         else:
@@ -166,15 +211,16 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
 
         rounded_num = np.round(number, self.num_decimal_places)
         if num_string.startswith("-") and rounded_num == 0:
-            if self.include_sign:
-                num_string = "+" + num_string[1:]
-            else:
-                num_string = num_string[1:]
+            num_string = "+" + num_string[1:] if self.include_sign else num_string[1:]
 
         return num_string
 
-    def _string_to_mob(self, string: str, mob_class: VMobject | None = None, **kwargs):
-
+    def _string_to_mob(
+        self,
+        string: str,
+        mob_class: type[SingleStringMathTex] | None = None,
+        **kwargs: Any,
+    ) -> VMobject:
         if mob_class is None:
             mob_class = self.mob_class
 
@@ -184,7 +230,7 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
         mob.font_size = self._font_size
         return mob
 
-    def _get_formatter(self, **kwargs):
+    def _get_formatter(self, **kwargs: Any) -> str:
         """
         Configuration is based first off instance attributes,
         but overwritten by any kew word argument.  Relevant
@@ -217,7 +263,7 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
             ],
         )
 
-    def _get_complex_formatter(self):
+    def _get_complex_formatter(self) -> str:
         return "".join(
             [
                 self._get_formatter(field_name="0.real"),
@@ -226,7 +272,7 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
             ],
         )
 
-    def set_value(self, number: float):
+    def set_value(self, number: float) -> Self:
         """Set the value of the :class:`~.DecimalNumber` to a new number.
 
         Parameters
@@ -263,10 +309,10 @@ class DecimalNumber(VMobject, metaclass=ConvertToOpenGL):
         self.init_colors()
         return self
 
-    def get_value(self):
+    def get_value(self) -> float:
         return self.number
 
-    def increment_value(self, delta_t=1):
+    def increment_value(self, delta_t: float = 1) -> None:
         self.set_value(self.get_value() + delta_t)
 
 
@@ -287,10 +333,12 @@ class Integer(DecimalNumber):
                 self.add(Integer(number=6.28).set_x(-1.5).set_y(-2).set_color(YELLOW).scale(1.4))
     """
 
-    def __init__(self, number=0, num_decimal_places=0, **kwargs):
+    def __init__(
+        self, number: float = 0, num_decimal_places: int = 0, **kwargs: Any
+    ) -> None:
         super().__init__(number=number, num_decimal_places=num_decimal_places, **kwargs)
 
-    def get_value(self):
+    def get_value(self) -> int:
         return int(np.round(super().get_value()))
 
 
@@ -401,11 +449,10 @@ class Variable(VMobject, metaclass=ConvertToOpenGL):
         self,
         var: float,
         label: str | Tex | MathTex | Text | SingleStringMathTex,
-        var_type: DecimalNumber | Integer = DecimalNumber,
+        var_type: type[DecimalNumber | Integer] = DecimalNumber,
         num_decimal_places: int = 2,
-        **kwargs,
+        **kwargs: Any,
     ):
-
         self.label = MathTex(label) if isinstance(label, str) else label
         equals = MathTex("=").next_to(self.label, RIGHT)
         self.label.add(equals)