Add type annotations for most of camera and mobject.graphing (#4125)

Co-authored-by: Francisco Manríquez Novoa <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

manim/camera/camera.py

@@ -9,14 +9,17 @@
 
 __all__ = ["MovingCamera"]
 
+from collections.abc import Iterable
+from typing import Any
+
 import numpy as np
 
 from .. import config
 from ..camera.camera import Camera
 from ..constants import DOWN, LEFT, RIGHT, UP
 from ..mobject.frame import ScreenRectangle
 from ..mobject.mobject import Mobject
-from ..utils.color import WHITE
+from ..utils.color import WHITE, ManimColor
 
 
 class MovingCamera(Camera):
@@ -32,10 +35,10 @@ class MovingCamera(Camera):
     def __init__(
         self,
         frame=None,
-        fixed_dimension=0,  # width
-        default_frame_stroke_color=WHITE,
-        default_frame_stroke_width=0,
-        **kwargs,
+        fixed_dimension: int = 0,  # width
+        default_frame_stroke_color: ManimColor = WHITE,
+        default_frame_stroke_width: int = 0,
+        **kwargs: Any,
     ) -> None:
         """Frame is a Mobject, (should almost certainly be a rectangle)
         determining which region of space the camera displays
@@ -121,7 +124,7 @@ def frame_center(self, frame_center: np.ndarray | list | tuple | Mobject):
         """
         self.frame.move_to(frame_center)
 
-    def capture_mobjects(self, mobjects, **kwargs):
+    def capture_mobjects(self, mobjects: Iterable[Mobject], **kwargs: Any) -> None:
         # self.reset_frame_center()
         # self.realign_frame_shape()
         super().capture_mobjects(mobjects, **kwargs)

manim/camera/moving_camera.py

@@ -5,7 +5,13 @@
 __all__ = ["MultiCamera"]
 
 
-from manim.mobject.types.image_mobject import ImageMobject
+from collections.abc import Iterable
+from typing import Any
+
+from typing_extensions import Self
+
+from manim.mobject.mobject import Mobject
+from manim.mobject.types.image_mobject import ImageMobjectFromCamera
 
 from ..camera.moving_camera import MovingCamera
 from ..utils.iterables import list_difference_update
@@ -16,10 +22,10 @@ class MultiCamera(MovingCamera):
 
     def __init__(
         self,
-        image_mobjects_from_cameras: ImageMobject | None = None,
-        allow_cameras_to_capture_their_own_display=False,
-        **kwargs,
-    ):
+        image_mobjects_from_cameras: Iterable[ImageMobjectFromCamera] | None = None,
+        allow_cameras_to_capture_their_own_display: bool = False,
+        **kwargs: Any,
+    ) -> None:
         """Initialises the MultiCamera
 
         Parameters
@@ -29,7 +35,7 @@ def __init__(
         kwargs
             Any valid keyword arguments of MovingCamera.
         """
-        self.image_mobjects_from_cameras = []
+        self.image_mobjects_from_cameras: list[ImageMobjectFromCamera] = []
         if image_mobjects_from_cameras is not None:
             for imfc in image_mobjects_from_cameras:
                 self.add_image_mobject_from_camera(imfc)
@@ -38,7 +44,9 @@ def __init__(
         )
         super().__init__(**kwargs)
 
-    def add_image_mobject_from_camera(self, image_mobject_from_camera: ImageMobject):
+    def add_image_mobject_from_camera(
+        self, image_mobject_from_camera: ImageMobjectFromCamera
+    ) -> None:
         """Adds an ImageMobject that's been obtained from the camera
         into the list ``self.image_mobject_from_cameras``
 
@@ -53,20 +61,20 @@ def add_image_mobject_from_camera(self, image_mobject_from_camera: ImageMobject)
         assert isinstance(imfc.camera, MovingCamera)
         self.image_mobjects_from_cameras.append(imfc)
 
-    def update_sub_cameras(self):
+    def update_sub_cameras(self) -> None:
         """Reshape sub_camera pixel_arrays"""
         for imfc in self.image_mobjects_from_cameras:
             pixel_height, pixel_width = self.pixel_array.shape[:2]
-            imfc.camera.frame_shape = (
-                imfc.camera.frame.height,
-                imfc.camera.frame.width,
-            )
+            # imfc.camera.frame_shape = (
+            #     imfc.camera.frame.height,
+            #     imfc.camera.frame.width,
+            # )
             imfc.camera.reset_pixel_shape(
                 int(pixel_height * imfc.height / self.frame_height),
                 int(pixel_width * imfc.width / self.frame_width),
             )
 
-    def reset(self):
+    def reset(self) -> Self:
         """Resets the MultiCamera.
 
         Returns
@@ -79,7 +87,7 @@ def reset(self):
         super().reset()
         return self
 
-    def capture_mobjects(self, mobjects, **kwargs):
+    def capture_mobjects(self, mobjects: Iterable[Mobject], **kwargs: Any) -> None:
         self.update_sub_cameras()
         for imfc in self.image_mobjects_from_cameras:
             to_add = list(mobjects)
@@ -88,7 +96,7 @@ def capture_mobjects(self, mobjects, **kwargs):
             imfc.camera.capture_mobjects(to_add, **kwargs)
         super().capture_mobjects(mobjects, **kwargs)
 
-    def get_mobjects_indicating_movement(self):
+    def get_mobjects_indicating_movement(self) -> list[Mobject]:
         """Returns all mobjects whose movement implies that the camera
         should think of all other mobjects on the screen as moving