Enhancement: Migrate width/height/depth to properties (#1024)

* Migrate width/height/depth to properties

* Fix examples

* Fix typos

* Import manim for doctests

* Expect Square for doctests

* Improve docs for width/height/depth properties

Author: friedkeenan

docs/source/examples.rst

@@ -330,7 +330,7 @@ Plotting with Manim
                 y_max=6,
                 x_labeled_nums=[0,2,3],
                 **kwargs)
-        
+
         def construct(self):
             self.setup_axes()
             curve1 = self.get_graph(lambda x: 4 * x - x ** 2, x_min=0, x_max=4)
@@ -435,7 +435,7 @@ Special Camera Settings
             dot = Dot().shift(UL * 2)
             image = ImageMobject(np.uint8([[0, 100, 30, 200],
                                            [255, 0, 5, 33]]))
-            image.set_height(7)
+            image.height = 7
             frame_text = Text("Frame", color=PURPLE).scale(1.4)
             zoomed_camera_text = Text("Zoomed camera", color=RED).scale(1.4)
 

example_scenes/basic.py

@@ -101,7 +101,7 @@ def construct(self):
         )
         group = VGroup(example_text, example_tex)
         group.arrange(DOWN)
-        group.set_width(config["frame_width"] - 2 * LARGE_BUFF)
+        group.width = config["frame_width"] - 2 * LARGE_BUFF
 
         self.play(Write(example_text))
         self.play(Write(example_tex))

manim/camera/moving_camera.py

@@ -69,7 +69,7 @@ def frame_height(self):
         float
             The height of the frame.
         """
-        return self.frame.get_height()
+        return self.frame.height
 
     @property
     def frame_width(self):
@@ -80,7 +80,7 @@ def frame_width(self):
         float
             The width of the frame.
         """
-        return self.frame.get_width()
+        return self.frame.width
 
     @property
     def frame_center(self):
@@ -158,9 +158,9 @@ def cache_cairo_context(self, pixel_array, ctx):
     # def realign_frame_shape(self):
     #     height, width = self.frame_shape
     #     if self.fixed_dimension == 0:
-    #         self.frame_shape = (height, self.frame.get_width())
+    #         self.frame_shape = (height, self.frame.width
     #     else:
-    #         self.frame_shape = (self.frame.get_height(), width)
+    #         self.frame_shape = (self.frame.height, width)
     #     self.resize_frame_shape(fixed_dimension=self.fixed_dimension)
 
     def get_mobjects_indicating_movement(self):

manim/camera/multi_camera.py

@@ -54,12 +54,12 @@ def update_sub_cameras(self):
         for imfc in self.image_mobjects_from_cameras:
             pixel_height, pixel_width = self.pixel_array.shape[:2]
             imfc.camera.frame_shape = (
-                imfc.camera.frame.get_height(),
-                imfc.camera.frame.get_width(),
+                imfc.camera.frame.height,
+                imfc.camera.frame.width,
             )
             imfc.camera.reset_pixel_shape(
-                int(pixel_height * imfc.get_height() / self.frame_height),
-                int(pixel_width * imfc.get_width() / self.frame_width),
+                int(pixel_height * imfc.height / self.frame_height),
+                int(pixel_width * imfc.width / self.frame_width),
             )
 
     def reset(self):

manim/grpc/impl/frame_server_impl.py

@@ -404,8 +404,8 @@ def serialize_mobject(mobject):
             logger.info(
                 f"Expected path {mobject.path} to be under the assets dir ({assets_dir_path})"
             )
-        mob_proto.image_mobject_data.height = mobject.get_height()
-        mob_proto.image_mobject_data.width = mobject.get_width()
+        mob_proto.image_mobject_data.height = mobject.height
+        mob_proto.image_mobject_data.width = mobject.width
         mob_center = mobject.get_center()
         mob_proto.image_mobject_data.center.x = mob_center[0]
         mob_proto.image_mobject_data.center.y = mob_center[1]

manim/mobject/frame.py

@@ -16,16 +16,27 @@
 
 class ScreenRectangle(Rectangle):
     def __init__(self, aspect_ratio=16.0 / 9.0, height=4, **kwargs):
-        self.aspect_ratio = aspect_ratio
-        self.height = height
-        Rectangle.__init__(self, **kwargs)
-        self.set_width(self.aspect_ratio * self.get_height(), stretch=True)
+        Rectangle.__init__(self, width=aspect_ratio * height, height=height, **kwargs)
+
+    @property
+    def aspect_ratio(self):
+        """The aspect ratio.
+
+        When set, the width is stretched to accommodate
+        the new aspect ratio.
+        """
+
+        return self.width / self.height
+
+    @aspect_ratio.setter
+    def aspect_ratio(self, value):
+        self.stretch_to_fit_width(value * self.height)
 
 
 class FullScreenRectangle(ScreenRectangle):
     def __init__(self, **kwargs):
         ScreenRectangle.__init__(self, **kwargs)
-        self.set_height(config["frame_height"])
+        self.height = config["frame_height"]
 
 
 class FullScreenFadeRectangle(FullScreenRectangle):
@@ -41,8 +52,18 @@ def __init__(self, stroke_width=0, fill_color=BLACK, fill_opacity=0.7, **kwargs)
 
 class PictureInPictureFrame(Rectangle):
     def __init__(self, height=3, aspect_ratio=16.0 / 9.0, **kwargs):
-        self.height = height
-        self.aspect_ratio = aspect_ratio
-        Rectangle.__init__(
-            self, width=self.aspect_ratio * self.height, height=self.height, **kwargs
-        )
+        Rectangle.__init__(self, width=aspect_ratio * height, height=height, **kwargs)
+
+    @property
+    def aspect_ratio(self):
+        """The aspect ratio.
+
+        When set, the width is stretched to accommodate
+        the new aspect ratio.
+        """
+
+        return self.width / self.height
+
+    @aspect_ratio.setter
+    def aspect_ratio(self, value):
+        self.stretch_to_fit_width(value * self.height)

manim/mobject/geometry.py

@@ -413,7 +413,7 @@ def surround(self, mobject, dim_to_match=0, stretch=False, buffer_factor=1.2):
         # TODO: Figure out and fix
         self.replace(mobject, dim_to_match, stretch)
 
-        self.set_width(np.sqrt(mobject.get_width() ** 2 + mobject.get_height() ** 2))
+        self.width = np.sqrt(mobject.width ** 2 + mobject.height ** 2)
         return self.scale(buffer_factor)
 
     def point_at_angle(self, angle):
@@ -519,9 +519,7 @@ def __init__(self, label, radius=None, **kwargs) -> None:
             rendered_label = label
 
         if radius is None:
-            radius = (
-                0.1 + max(rendered_label.get_width(), rendered_label.get_height()) / 2
-            )
+            radius = 0.1 + max(rendered_label.width, rendered_label.height) / 2
         Dot.__init__(self, radius=radius, **kwargs)
         rendered_label.move_to(self.get_center())
         self.add(rendered_label)
@@ -530,10 +528,8 @@ def __init__(self, label, radius=None, **kwargs) -> None:
 class Ellipse(Circle):
     def __init__(self, width=2, height=1, **kwargs):
         Circle.__init__(self, **kwargs)
-        self.width = width
-        self.height = height
-        self.set_width(self.width, stretch=True)
-        self.set_height(self.height, stretch=True)
+        self.stretch_to_fit_width(width)
+        self.stretch_to_fit_height(height)
 
 
 class AnnularSector(Arc):
@@ -788,11 +784,10 @@ def __init__(self, vmob, alpha, length=1, d_alpha=1e-6, **kwargs):
 
 class Elbow(VMobject):
     def __init__(self, width=0.2, angle=0, **kwargs):
-        self.width = width
         self.angle = angle
         VMobject.__init__(self, **kwargs)
         self.set_points_as_corners([UP, UP + RIGHT, RIGHT])
-        self.set_width(self.width, about_point=ORIGIN)
+        self.scale_to_fit_width(width, about_point=ORIGIN)
         self.rotate(self.angle, about_point=ORIGIN)
 
 
@@ -1227,20 +1222,27 @@ def __init__(
         close_new_points=True,
         **kwargs
     ):
-        self.height = height
-        self.width = width
         self.mark_paths_closed = mark_paths_closed
         self.close_new_points = close_new_points
         Polygon.__init__(self, UL, UR, DR, DL, color=color, **kwargs)
-        self.set_width(self.width, stretch=True)
-        self.set_height(self.height, stretch=True)
+        self.stretch_to_fit_width(width)
+        self.stretch_to_fit_height(height)
 
 
 class Square(Rectangle):
     def __init__(self, side_length=2.0, **kwargs):
-        self.side_length = side_length
         Rectangle.__init__(self, height=side_length, width=side_length, **kwargs)
 
+    @property
+    def side_length(self):
+        """The square's side length."""
+
+        return self.width
+
+    @side_length.setter
+    def side_length(self, value):
+        self.width = value
+
 
 class RoundedRectangle(Rectangle):
     def __init__(self, corner_radius=0.5, **kwargs):
@@ -1279,8 +1281,8 @@ class ArrowTip(VMobject):
         ...     def __init__(self, **kwargs):
         ...         RegularPolygon.__init__(self, n=5, **kwargs)
         ...         length = 0.35
-        ...         self.set_width(length)
-        ...         self.set_height(length, stretch=True)
+        ...         self.width = length
+        ...         self.stretch_to_fit_height(length)
         >>> arr = Arrow(np.array([-2, -2, 0]), np.array([2, 2, 0]),
         ...             tip_shape=MyCustomArrowTip)
         >>> isinstance(arr.tip, RegularPolygon)
@@ -1419,8 +1421,8 @@ def __init__(
             start_angle=start_angle,
             **kwargs
         )
-        self.set_width(length)
-        self.set_height(length, stretch=True)
+        self.width = length
+        self.stretch_to_fit_height(length)
 
 
 class ArrowTriangleFilledTip(ArrowTriangleTip):
@@ -1450,8 +1452,8 @@ def __init__(
         Circle.__init__(
             self, fill_opacity=fill_opacity, stroke_width=stroke_width, **kwargs
         )
-        self.set_width(length)
-        self.set_height(length, stretch=True)
+        self.width = length
+        self.stretch_to_fit_height(length)
 
 
 class ArrowCircleFilledTip(ArrowCircleTip):
@@ -1482,8 +1484,8 @@ def __init__(
             side_length=length,
             **kwargs
         )
-        self.set_width(length)
-        self.set_height(length, stretch=True)
+        self.width = length
+        self.stretch_to_fit_height(length)
 
 
 class ArrowSquareFilledTip(ArrowSquareTip):

manim/mobject/logo.py

@@ -84,9 +84,8 @@ def __init__(self, dark_theme: bool = True):
                 tex.next_to(anim, buff=0.01)
             tex.align_to(self.M, DOWN)
             anim.add(tex)
-        anim.set_color(self.font_color).set_height(
-            m_height_over_anim_height * self.M.get_height()
-        )
+        anim.set_color(self.font_color)
+        anim.height = m_height_over_anim_height * self.M.height
 
         # Note: "anim" is only shown in the expanded state
         # and thus not yet added to the submobjects of self.

manim/mobject/matrix.py

@@ -132,7 +132,7 @@ def organize_mob_matrix(self, matrix):
     def add_brackets(self, left="\\big[", right="\\big]"):
         bracket_pair = MathTex(left, right)
         bracket_pair.scale(2)
-        bracket_pair.stretch_to_fit_height(self.get_height() + 2 * self.bracket_v_buff)
+        bracket_pair.stretch_to_fit_height(self.height + 2 * self.bracket_v_buff)
         l_bracket, r_bracket = bracket_pair.split()
         l_bracket.next_to(self, LEFT, self.bracket_h_buff)
         r_bracket.next_to(self, RIGHT, self.bracket_h_buff)
@@ -228,7 +228,7 @@ def get_det_text(
 ):
     parens = MathTex("(", ")")
     parens.scale(initial_scale_factor)
-    parens.stretch_to_fit_height(matrix.get_height())
+    parens.stretch_to_fit_height(matrix.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)