Deprecate TexMobject and TextMobject in favour of MathTex and Tex (#391)

* Rename TexMobject to MathTex
Rename TextMobject to Tex
Replace all instances of TexMobject with MathTex and TextMobject with Tex.
Get rid of single-use TexSymbol.
Rename SingleStringTexMobject to SingleStringMathTex.
Add Deprecation warnings to TexMobject and TextMobject.

* Edit __all__ for tex_mobject.py

* Re-add TexSymbol by request of devs.

* Docstring Modifications by @PgBiel

Co-authored-by: Pg Biel <[email protected]>

* Import logger differently, by @leotrs

* Run updated Black on files changed.

Co-authored-by: Pg Biel <[email protected]>

Author: Aathish04

docs/source/installation/linux.rst

@@ -8,7 +8,7 @@ dependencies are installed correctly.  All distributions will follow the same
 instructions in `Certifying a clean install`_.
 
 The two necessary dependencies are cairo and ffmpeg.  LaTeX is strongly
-recommended, as it is necessary to have access to the ``TexMobject`` class.
+recommended, as it is necessary to have access to the ``Tex`` and ``MathTex`` classes.
 Sox is only required if you want manim to play sounds when rendering scenes.
 
 Ubuntu/Debian

example_scenes/basic.py

@@ -17,15 +17,15 @@
 
 class OpeningManimExample(Scene):
     def construct(self):
-        title = TextMobject("This is some \\LaTeX")
-        basel = TexMobject("\\sum_{n=1}^\\infty " "\\frac{1}{n^2} = \\frac{\\pi^2}{6}")
+        title = Tex("This is some \\LaTeX")
+        basel = MathTex("\\sum_{n=1}^\\infty " "\\frac{1}{n^2} = \\frac{\\pi^2}{6}")
         VGroup(title, basel).arrange(DOWN)
         self.play(
             Write(title), FadeInFrom(basel, UP),
         )
         self.wait()
 
-        transform_title = TextMobject("That was a transform")
+        transform_title = Tex("That was a transform")
         transform_title.to_corner(UP + LEFT)
         self.play(
             Transform(title, transform_title),
@@ -34,7 +34,7 @@ def construct(self):
         self.wait()
 
         grid = NumberPlane()
-        grid_title = TextMobject("This is a grid")
+        grid_title = Tex("This is a grid")
         grid_title.scale(1.5)
         grid_title.move_to(transform_title)
 
@@ -46,7 +46,7 @@ def construct(self):
         )
         self.wait()
 
-        grid_transform_title = TextMobject(
+        grid_transform_title = Tex(
             "That was a non-linear function \\\\" "applied to the grid"
         )
         grid_transform_title.move_to(grid_title, UL)
@@ -87,12 +87,8 @@ def construct(self):
 
 class WriteStuff(Scene):
     def construct(self):
-        example_text = TextMobject(
-            "This is a some text", tex_to_color_map={"text": YELLOW}
-        )
-        example_tex = TexMobject(
-            "\\sum_{k=1}^\\infty {1 \\over k^2} = {\\pi^2 \\over 6}",
-        )
+        example_text = Tex("This is a some text", tex_to_color_map={"text": YELLOW})
+        example_tex = MathTex("\\sum_{k=1}^\\infty {1 \\over k^2} = {\\pi^2 \\over 6}",)
         group = VGroup(example_text, example_tex)
         group.arrange(DOWN)
         group.set_width(config["frame_width"] - 2 * LARGE_BUFF)
@@ -131,7 +127,7 @@ def construct(self):
         self.play(ShowCreation(my_dict))
         self.wait()
 
-        text = TextMobject("Some text").set_color(GREEN).next_to(square, DOWN)
+        text = Tex("Some text").set_color(GREEN).next_to(square, DOWN)
 
         # add a key-value pair by wrapping it in a single-element list of tuple
         # after attrs branch is merged, it will be easier like `.add(t=text)`
@@ -148,7 +144,7 @@ def construct(self):
         self.wait()
 
         # also supports python dict styled reassignment
-        my_dict["t"] = TextMobject("Some other text").set_color(BLUE)
+        my_dict["t"] = Tex("Some other text").set_color(BLUE)
         self.wait()
 
         # remove submoject by key

example_scenes/customtex.py

@@ -11,8 +11,8 @@ class TexTemplateFromCLI(Scene):
     """
 
     def construct(self):
-        text = TexMobject(r"\vv{vb}")
-        # text=TextMobject(r"$\vv{vb}$")
+        text = MathTex(r"\vv{vb}")
+        # text=Tex(r"$\vv{vb}$")
         self.play(Write(text))
 
 
@@ -26,6 +26,6 @@ def construct(self):
         tpl.append_package(["esvect", ["f"]])
         config["tex_template"] = tpl
 
-        # text=TextMobject(r"$\vv{vb}$")
-        text = TexMobject(r"\vv{vb}")
+        # text=Tex(r"$\vv{vb}$")
+        text = MathTex(r"\vv{vb}")
         self.play(Write(text))

logo/logo.py

@@ -74,10 +74,10 @@ def get_h_line(input_tracker):
             triangle.scale(0.1)
 
         #
-        x_label_p1 = TexMobject("a")
-        output_label_p1 = TexMobject("f(a)")
-        x_label_p2 = TexMobject("b")
-        output_label_p2 = TexMobject("f(b)")
+        x_label_p1 = MathTex("a")
+        output_label_p1 = MathTex("f(a)")
+        x_label_p2 = MathTex("b")
+        output_label_p2 = MathTex("f(b)")
         v_line_p1 = get_v_line(input_tracker_p1)
         v_line_p2 = get_v_line(input_tracker_p2)
         h_line_p1 = get_h_line(input_tracker_p1)
@@ -181,10 +181,5 @@ def get_h_line(input_tracker):
         # adding manim
         picture = Group(*self.mobjects)
         picture.scale(0.6).to_edge(LEFT, buff=SMALL_BUFF)
-        manim = (
-            TextMobject("Manim")
-            .set_height(1.5)
-            .next_to(picture, RIGHT)
-            .shift(DOWN * 0.7)
-        )
+        manim = Tex("Manim").set_height(1.5).next_to(picture, RIGHT).shift(DOWN * 0.7)
         self.add(manim)

manim/mobject/coordinate_systems.py

@@ -10,7 +10,7 @@
 from ..mobject.geometry import Arrow
 from ..mobject.geometry import Line
 from ..mobject.number_line import NumberLine
-from ..mobject.svg.tex_mobject import TexMobject
+from ..mobject.svg.tex_mobject import MathTex
 from ..mobject.types.vectorized_mobject import VGroup
 from ..utils.config_ops import digest_config
 from ..utils.config_ops import merge_dicts_recursively
@@ -73,7 +73,7 @@ def get_y_axis_label(self, label_tex, edge=UP, direction=DR, **kwargs):
         )
 
     def get_axis_label(self, label_tex, axis, edge, direction, buff=MED_SMALL_BUFF):
-        label = TexMobject(label_tex)
+        label = MathTex(label_tex)
         label.next_to(axis.get_edge_center(edge), direction, buff=buff)
         label.shift_onto_screen(buff=MED_SMALL_BUFF)
         return label

manim/mobject/matrix.py

@@ -16,8 +16,8 @@
 from ..mobject.numbers import DecimalNumber
 from ..mobject.numbers import Integer
 from ..mobject.shape_matchers import BackgroundRectangle
-from ..mobject.svg.tex_mobject import TexMobject
-from ..mobject.svg.tex_mobject import TextMobject
+from ..mobject.svg.tex_mobject import MathTex
+from ..mobject.svg.tex_mobject import Tex
 from ..mobject.types.vectorized_mobject import VGroup
 from ..mobject.types.vectorized_mobject import VMobject
 
@@ -36,7 +36,7 @@ def matrix_to_tex_string(matrix):
 
 
 def matrix_to_mobject(matrix):
-    return TexMobject(matrix_to_tex_string(matrix))
+    return MathTex(matrix_to_tex_string(matrix))
 
 
 def vector_coordinate_label(vector_mob, integer_labels=True, n_dim=2, color=WHITE):
@@ -68,7 +68,7 @@ class Matrix(VMobject):
         "bracket_v_buff": MED_SMALL_BUFF,
         "add_background_rectangles_to_entries": False,
         "include_background_rectangle": False,
-        "element_to_mobject": TexMobject,
+        "element_to_mobject": MathTex,
         "element_to_mobject_config": {},
         "element_alignment_corner": DR,
         "left_bracket": "\\big[",
@@ -111,7 +111,7 @@ def organize_mob_matrix(self, matrix):
         return self
 
     def add_brackets(self, left="\\big[", right="\\big]"):
-        bracket_pair = TexMobject(left, right)
+        bracket_pair = MathTex(left, right)
         bracket_pair.scale(2)
         bracket_pair.stretch_to_fit_height(self.get_height() + 2 * self.bracket_v_buff)
         l_bracket, r_bracket = bracket_pair.split()
@@ -199,22 +199,22 @@ class MobjectMatrix(Matrix):
 def get_det_text(
     matrix, determinant=None, background_rect=False, initial_scale_factor=2
 ):
-    parens = TexMobject("(", ")")
+    parens = MathTex("(", ")")
     parens.scale(initial_scale_factor)
     parens.stretch_to_fit_height(matrix.get_height())
     l_paren, r_paren = parens.split()
     l_paren.next_to(matrix, LEFT, buff=0.1)
     r_paren.next_to(matrix, RIGHT, buff=0.1)
-    det = TextMobject("det")
+    det = Tex("det")
     det.scale(initial_scale_factor)
     det.next_to(l_paren, LEFT, buff=0.1)
     if background_rect:
         det.add_background_rectangle()
     det_text = VGroup(det, l_paren, r_paren)
     if determinant is not None:
-        eq = TexMobject("=")
+        eq = MathTex("=")
         eq.next_to(r_paren, RIGHT, buff=0.1)
-        result = TexMobject(str(determinant))
+        result = MathTex(str(determinant))
         result.next_to(eq, RIGHT, buff=0.2)
         det_text.add(eq, result)
     return det_text

manim/mobject/numbers.py

@@ -2,7 +2,7 @@
 
 
 from ..constants import *
-from ..mobject.svg.tex_mobject import SingleStringTexMobject
+from ..mobject.svg.tex_mobject import SingleStringMathTex
 from ..mobject.types.vectorized_mobject import VMobject
 
 
@@ -36,18 +36,18 @@ def __init__(self, number=0, **kwargs):
             else:
                 num_string = num_string[1:]
 
-        self.add(*[SingleStringTexMobject(char, **kwargs) for char in num_string])
+        self.add(*[SingleStringMathTex(char, **kwargs) for char in num_string])
 
         # Add non-numerical bits
         if self.show_ellipsis:
-            self.add(SingleStringTexMobject("\\dots"))
+            self.add(SingleStringMathTex("\\dots"))
 
         if num_string.startswith("-"):
             minus = self.submobjects[0]
             minus.next_to(self.submobjects[1], LEFT, buff=self.digit_to_digit_buff)
 
         if self.unit is not None:
-            self.unit_sign = SingleStringTexMobject(self.unit, color=self.color)
+            self.unit_sign = SingleStringMathTex(self.unit, color=self.color)
             self.add(self.unit_sign)
 
         self.arrange(buff=self.digit_to_digit_buff, aligned_edge=DOWN)
@@ -79,7 +79,11 @@ def get_formatter(self, **kwargs):
         config = dict(
             [
                 (attr, getattr(self, attr))
-                for attr in ["include_sign", "group_with_commas", "num_decimal_places",]
+                for attr in [
+                    "include_sign",
+                    "group_with_commas",
+                    "num_decimal_places",
+                ]
             ]
         )
         config.update(kwargs)

manim/mobject/probability.py

@@ -6,8 +6,8 @@
 from ..mobject.geometry import Rectangle
 from ..mobject.mobject import Mobject
 from ..mobject.svg.brace import Brace
-from ..mobject.svg.tex_mobject import TexMobject
-from ..mobject.svg.tex_mobject import TextMobject
+from ..mobject.svg.tex_mobject import MathTex
+from ..mobject.svg.tex_mobject import Tex
 from ..mobject.types.vectorized_mobject import VGroup
 from ..utils.color import color_gradient
 from ..utils.iterables import tuplify
@@ -29,7 +29,7 @@ class SampleSpace(Rectangle):
 
     def add_title(self, title="Sample space", buff=MED_SMALL_BUFF):
         # TODO, should this really exist in SampleSpaceScene
-        title_mob = TextMobject(title)
+        title_mob = Tex(title)
         if title_mob.get_width() > self.get_width():
             title_mob.set_width(self.get_width())
         title_mob.next_to(self, UP, buff=buff)
@@ -86,7 +86,7 @@ def get_subdivision_braces_and_labels(
             if isinstance(label, Mobject):
                 label_mob = label
             else:
-                label_mob = TexMobject(label)
+                label_mob = MathTex(label)
                 label_mob.scale(self.default_label_scale_val)
             label_mob.next_to(brace, direction, buff)
 
@@ -179,7 +179,7 @@ def add_axes(self):
         if self.label_y_axis:
             labels = VGroup()
             for tick, value in zip(ticks, values):
-                label = TexMobject(str(np.round(value, 2)))
+                label = MathTex(str(np.round(value, 2)))
                 label.set_height(self.y_axis_label_height)
                 label.next_to(tick, LEFT, SMALL_BUFF)
                 labels.add(label)
@@ -202,7 +202,7 @@ def add_bars(self, values):
 
         bar_labels = VGroup()
         for bar, name in zip(bars, self.bar_names):
-            label = TexMobject(str(name))
+            label = MathTex(str(name))
             label.scale(self.bar_label_scale_val)
             label.next_to(bar, DOWN, SMALL_BUFF)
             bar_labels.add(label)

manim/mobject/svg/brace.py

@@ -7,14 +7,14 @@
 from ...constants import *
 from ...animation.fading import FadeIn
 from ...animation.growing import GrowFromCenter
-from ...mobject.svg.tex_mobject import TexMobject
-from ...mobject.svg.tex_mobject import TextMobject
+from ...mobject.svg.tex_mobject import MathTex
+from ...mobject.svg.tex_mobject import Tex
 from ...mobject.types.vectorized_mobject import VMobject
 from ...utils.config_ops import digest_config
 from ...utils.space_ops import get_norm
 
 
-class Brace(TexMobject):
+class Brace(MathTex):
     CONFIG = {
         "buff": 0.2,
         "width_multiplier": 2,
@@ -38,7 +38,7 @@ def __init__(self, mobject, direction=DOWN, **kwargs):
             self.max_num_quads,
         )
         tex_string = "\\underbrace{%s}" % (num_quads * "\\qquad")
-        TexMobject.__init__(self, tex_string, **kwargs)
+        MathTex.__init__(self, tex_string, **kwargs)
         self.tip_point_index = np.argmin(self.get_all_points()[:, 1])
         self.stretch_to_fit_width(target_width)
         self.shift(left - self.get_corner(UP + LEFT) + self.buff * DOWN)
@@ -56,12 +56,12 @@ def put_at_tip(self, mob, use_next_to=True, **kwargs):
         return self
 
     def get_text(self, *text, **kwargs):
-        text_mob = TextMobject(*text)
+        text_mob = Tex(*text)
         self.put_at_tip(text_mob, **kwargs)
         return text_mob
 
     def get_tex(self, *tex, **kwargs):
-        tex_mob = TexMobject(*tex)
+        tex_mob = MathTex(*tex)
         self.put_at_tip(tex_mob, **kwargs)
         return tex_mob
 
@@ -78,7 +78,7 @@ def get_direction(self):
 
 class BraceLabel(VMobject):
     CONFIG = {
-        "label_constructor": TexMobject,
+        "label_constructor": MathTex,
         "label_scale": 1,
     }
 
@@ -126,4 +126,4 @@ def change_brace_label(self, obj, *text):
 
 
 class BraceText(BraceLabel):
-    CONFIG = {"label_constructor": TextMobject}
+    CONFIG = {"label_constructor": Tex}