Skip to content

The animation engine for agents: blazingly fast math and 3D videos with Manim's Python API, on a Rust GPU core.

Python

Use table cells and concrete number storage as authoring authorities

Sina Atalay30f916e491af
diff --git a/src/manimgx/mobjects/grid.py b/src/manimgx/mobjects/grid.py
index 4860206d..3cb0afbb 100644
--- a/src/manimgx/mobjects/grid.py
+++ b/src/manimgx/mobjects/grid.py
@@ -23,6 +23,7 @@ from manimgx.drawing.paint import (
ManimColor,
ParsableManimColor,
Style,
+ _Style,
)
from manimgx.mobject import (
GridArrangement,
@@ -59,7 +60,7 @@ with the keywords of `element_to_mobject_config` (a class, as
[MathTex][manimgx.MathTex], or any function)."""
-class MatrixOptions(Style, total=False):
+class MatrixOptions(_Style, total=False, closed=True):
"""A [Matrix][manimgx.Matrix]'s keywords but its entries, for the methods that pass
them on (a [vector's coordinate label][manimgx.Vector.coordinate_label]): its
entries' kind, with its layout, brackets and style."""
@@ -622,6 +623,7 @@ class Table(_Grid, VGroup):
)
self.elements_without_labels = VGroup(*it.chain(*cells))
"""The entries but the labels, row by row."""
+ empty_corner = None
if self.row_labels is not None:
for k in range(len(self.row_labels)):
cells[k] = [self.row_labels[k]] + cells[k]
@@ -631,8 +633,8 @@ class Table(_Grid, VGroup):
col_labels = [self.top_left_entry] + self.col_labels
cells.insert(0, col_labels)
else:
- dummy_mobject = VMobject()
- col_labels = [dummy_mobject] + self.col_labels
+ empty_corner = VMobject()
+ col_labels = [empty_corner] + self.col_labels
cells.insert(0, col_labels)
else:
cells.insert(0, self.col_labels)
@@ -644,8 +646,8 @@ class Table(_Grid, VGroup):
rows=len(self.cells), cols=len(self.cells[0]), buff=(h_buff, v_buff)
)
self.elements.arrange_in_grid(**(layout | arrange_in_grid_config))
- if len(self.elements[0].get_all_points()) == 0:
- self.elements.remove(self.elements[0])
+ if empty_corner is not None:
+ self.elements.remove(empty_corner)
self.add(self.elements)
self.center()
for axis in (0, 1):
@@ -725,6 +727,8 @@ class Table(_Grid, VGroup):
Returns:
The entry; or every entry, row by row, in a group.
+ The absent corner between row and column labels is an empty mobject,
+ omitted from the group.
Examples:
```python
@@ -744,18 +748,8 @@ class Table(_Grid, VGroup):
```
"""
if pos is not None:
- if (
- self.row_labels is not None
- and self.col_labels is not None
- and (self.top_left_entry is None)
- ):
- index = len(self.cells[0]) * (pos[0] - 1) + pos[1] - 2
- return self.elements[index]
- else:
- index = len(self.cells[0]) * (pos[0] - 1) + pos[1] - 1
- return self.elements[index]
- else:
- return self.elements
+ return self.cells[pos[0] - 1][pos[1] - 1]
+ return self.elements
def get_entries_without_labels(self, pos: Sequence[int] | None = None) -> Mobject:
"""The table's entries but its labels, or the one at a position among them.
@@ -787,10 +781,10 @@ class Table(_Grid, VGroup):
```
"""
if pos is not None:
- index = self.col_dim * (pos[0] - 1) + pos[1] - 1
- return self.elements_without_labels[index]
- else:
- return self.elements_without_labels
+ row = pos[0] - 1 + (self.col_labels is not None)
+ column = pos[1] - 1 + (self.row_labels is not None)
+ return self.cells[row][column]
+ return self.elements_without_labels
def get_row_labels(self) -> VGroup:
"""The table's row labels, from the top down.
diff --git a/src/manimgx/mobjects/numbers.py b/src/manimgx/mobjects/numbers.py
index 74306358..e560a1d5 100644
--- a/src/manimgx/mobjects/numbers.py
+++ b/src/manimgx/mobjects/numbers.py
@@ -15,7 +15,7 @@ import numpy as np
from manimgx.caches import Memo
from manimgx.constants import DEFAULT_FONT_SIZE, DOWN, LEFT, ORIGIN, RIGHT, UP
from manimgx.drawing.geometry import Blend
-from manimgx.drawing.paint import BLACK, Paint, Style
+from manimgx.drawing.paint import BLACK, Paint, Style, _Style
from manimgx.mobject import Mobject, ValueTracker, VGroup, VMobject, copied, prototype
from manimgx.mobjects.text import MathTex, SingleStringMathTex, Text
from manimgx.typing import ManimTextLabel, Vector3DLike
@@ -26,12 +26,8 @@ _ROWS: Memo[tuple[object, ...], dict[str, object]] = Memo(1 << 12)
_ROW = ("submobjects", "initial_height", "background_rectangle")
-class NumberStyle(Style, total=False):
- """How a number is written: [DecimalNumber][manimgx.DecimalNumber]'s keywords but
- its number of decimal places, for the classes that pass them on.
-
- Beyond these, they take the [style keywords][manimgx.drawing.paint.Style].
- """
+class _NumberStyle(_Style, total=False):
+ """NumberStyle's keys, open, for the keywords that add to them."""
mob_class: type[ManimTextLabel]
"""The class each character is typeset with (default [MathTex][manimgx.MathTex])."""
@@ -61,7 +57,15 @@ class NumberStyle(Style, total=False):
"""The characters' font size, as `mob_class` measures it (default 48)."""
-class DecimalNumberOptions(NumberStyle, total=False):
+class NumberStyle(_NumberStyle, total=False, closed=True):
+ """How a number is written: [DecimalNumber][manimgx.DecimalNumber]'s keywords but
+ its number of decimal places, for the classes that pass them on.
+
+ Beyond these, they take the [style keywords][manimgx.drawing.paint.Style].
+ """
+
+
+class DecimalNumberOptions(_NumberStyle, total=False, closed=True):
"""[DecimalNumber][manimgx.DecimalNumber]'s keywords, for the classes that pass them
on: a number line's labels.
@@ -73,7 +77,7 @@ class DecimalNumberOptions(NumberStyle, total=False):
"""How many digits follow the decimal point (default 2)."""
-class DecimalNumber(VMobject):
+class DecimalNumber[V: (float, complex) = float](VMobject):
r"""A number, written with a fixed number of decimal places: white and filled
unless styled.
@@ -87,6 +91,10 @@ class DecimalNumber(VMobject):
driven by a [value tracker][manimgx.ValueTracker], or by
[ChangeDecimalToValue][manimgx.ChangeDecimalToValue], the number counts on screen.
+ A type checker follows the initial value's kind: real by default, complex for a
+ complex initial value. Use `DecimalNumber[complex](0)` to start real and later
+ accept complex values.
+
Args:
number: The number to show; a complex one too.
num_decimal_places: How many digits follow the decimal point.
@@ -131,7 +139,7 @@ class DecimalNumber(VMobject):
@prototype
def __init__(
self,
- number: float = 0,
+ number: V = 0,
num_decimal_places: int = 2,
mob_class: type[ManimTextLabel] = MathTex,
include_sign: bool = False,
@@ -191,7 +199,7 @@ class DecimalNumber(VMobject):
self.show_ellipsis,
)
- def _set_submobjects_from_number(self, number: float) -> tuple[object, ...]:
+ def _set_submobjects_from_number(self, number: V) -> tuple[object, ...]:
"""The glyphs of `number` about the origin at the constructed font size: laid out once per
string and layout, then copied."""
self.number = number
@@ -282,11 +290,11 @@ class DecimalNumber(VMobject):
tuple[tuple[object, ...], tuple[tuple[Mobject, Blend, Paint], ...]] | None
) = None
- def get_value(self) -> float:
+ def get_value(self) -> V:
"""The number shown, as it was given: not rounded."""
return self.number
- def increment_value(self, delta_t: float = 1) -> Self:
+ def increment_value(self, delta_t: V = 1) -> Self:
"""Show the number plus `delta_t`.
Args:
@@ -294,7 +302,7 @@ class DecimalNumber(VMobject):
"""
return self.set_value(self.get_value() + delta_t)
- def set_value(self, number: float) -> Self:
+ def set_value(self, number: V) -> Self:
"""Show another number, keeping the look: the font size, the edge `edge_to_fix`
where it is, and the color — every character takes the number's own, so a color
given to single characters is not kept.
diff --git a/tests/unit/mobjects/test_grid.py b/tests/unit/mobjects/test_grid.py
index 00804cdb..bbf069ad 100644
--- a/tests/unit/mobjects/test_grid.py
+++ b/tests/unit/mobjects/test_grid.py
@@ -19,6 +19,69 @@ import manimgx as m
from manimgx.typing import Vector3D
+ ("row_labels", "col_labels", "corner"),
+ [
+ (False, False, None),
+ (True, False, None),
+ (False, True, None),
+ (True, True, None),
+ (True, True, "empty"),
+ (True, True, "visible"),
+ ],
+)
+def test_table_positions_retain_cell_identity_including_empty_entries(
+ row_labels: bool, col_labels: bool, corner: str | None
+) -> None:
+ data = [[m.VMobject(), m.Square()], [m.Circle(), m.VMobject()]]
+ top_left = m.VMobject() if corner == "empty" else m.Square() if corner else None
+ row_names = [m.Circle(), m.Circle()] if row_labels else []
+ column_names = [m.Square(), m.Square()] if col_labels else []
+ table = m.MobjectTable(
+ data,
+ row_labels=row_names,
+ col_labels=column_names,
+ top_left_entry=top_left,
+ )
+ expected = ([top_left] if top_left is not None else []) + column_names
+ for r, row in enumerate(data):
+ if row_labels:
+ expected.append(row_names[r])
+ expected.extend(row)
+ assert list(table.get_entries()) == expected
+ assert list(table.get_entries_without_labels()) == [
+ entry for row in data for entry in row
+ ]
+ for r, row in enumerate(data, 1):
+ for c, entry in enumerate(row, 1):
+ assert table.get_entries_without_labels((r, c)) is entry
+ assert table.get_entries((r + col_labels, c + row_labels)) is entry
+ for r, label in enumerate(row_names, 1):
+ assert table.get_entries((r + col_labels, 1)) is label
+ for c, label in enumerate(column_names, 1):
+ assert table.get_entries((1, c + row_labels)) is label
+ if row_labels and col_labels:
+ actual_corner = table.get_entries((1, 1))
+ if top_left is not None:
+ assert actual_corner is top_left
+ else:
+ assert actual_corner not in expected
+ assert actual_corner.get_all_points().size == 0
+
+
+def test_highlighting_an_empty_label_corner_does_not_change_a_data_entry() -> None:
+ entry = m.Square()
+ table = m.MobjectTable([[entry]], row_labels=[m.Circle()], col_labels=[m.Circle()])
+ table.add_highlighted_cell((1, 1))
+ corner = table.cells[0][0]
+ assert entry.background_rectangle is None
+ assert corner.background_rectangle is not None
+ assert corner.background_rectangle in table.submobjects
+ np.testing.assert_allclose(
+ corner.background_rectangle.get_center(), table.get_cell((1, 1)).get_center()
+ )
+
+
@pytest.mark.parametrize("corner", [m.DR, m.UL, m.ORIGIN])
@pytest.mark.parametrize("stretch", [True, False])
def test_matrix_cells_keep_constructor_grid_spacing(
diff --git a/tests/unit/mobjects/test_numbers.py b/tests/unit/mobjects/test_numbers.py
index e76dbbf1..de3dd452 100644
--- a/tests/unit/mobjects/test_numbers.py
+++ b/tests/unit/mobjects/test_numbers.py
@@ -35,7 +35,7 @@ def spelled(value: float, places: int, sign: bool = False, commas: bool = False)
return f"{rounded:{'+' if sign else ''}{',' if commas else ''}.{places}f}"
-def written(number: m.DecimalNumber) -> str:
+def written[V: (float, complex)](number: m.DecimalNumber[V]) -> str:
characters = []
for part in number:
assert isinstance(part, m.MathTex)
@@ -129,7 +129,7 @@ def test_a_complex_number_spells_each_part(
) -> None:
value = scalar(complex(real, imaginary))
number = m.DecimalNumber(
- value, # ty: ignore[invalid-argument-type] # (typed float, documented complex too)
+ value,
num_decimal_places=places,
include_sign=sign,
group_with_commas=commas,
@@ -223,3 +223,28 @@ def test_a_variable_shows_its_tracker_in_the_number_class_asked_for(
variable.update()
assert variable.value.number == 2.875
assert written(variable.value) == spelled(2.875, places)
+
+
[email protected]("targeted", [False, True])
+def test_complex_number_animations_preserve_both_components(targeted: bool) -> None:
+ start, target = 1 + 2j, -3 + 4j
+ number = m.DecimalNumber(start, num_decimal_places=3)
+
+ def value(alpha: float) -> complex:
+ return start + (target - start) * (alpha if targeted else alpha**2)
+
+ animation = (
+ m.ChangeDecimalToValue(number, target, rate_func=m.linear)
+ if targeted
+ else m.ChangingDecimal(number, value, rate_func=m.linear)
+ )
+ animation.begin()
+ for alpha in (0, 0.75, 0.25, 1):
+ animation.interpolate(alpha)
+ expected = value(alpha)
+ assert number.get_value() == expected
+ assert (
+ written(number)
+ == spelled(expected.real, 3) + spelled(expected.imag, 3, sign=True) + "i"
+ )
+ animation.finish()