Add Docstrings to viable methods of all classes in manimlib/camera

Some methods were not mentioned outside of their definitions, and have less detailed docstrings.

Author: Aathish Sivasubrahmanian

manimlib/camera/camera.py

@@ -30,6 +30,14 @@ class Camera(object):
     Base Camera class.
     This is the object which takes care of what exactly is displayed
     on screen at any given moment.
+
+    Some important CONFIG values and local variables to note are:
+
+    self.background_image : str, optional
+        The path to an image that should be the background image.
+        If not set, the background is filled with `self.background_color`
+    
+    self.pixel_height
     """
     CONFIG = {
         "background_image": None,
@@ -56,6 +64,15 @@ class Camera(object):
     }
 
     def __init__(self, background=None, **kwargs):
+        """Initialises the Camera.
+
+        Parameters
+        ----------
+        background : optional
+            What self.background should be, by default None as will be set later.
+        **kwargs
+            Any local variables to be set.
+        """
         digest_config(self, kwargs, locals())
         self.rgb_max_val = np.iinfo(self.pixel_array_dtype).max
         self.pixel_array_to_cairo_context = {}
@@ -200,7 +217,7 @@ def resize_frame_shape(self, fixed_dimension=0):
 
     def init_background(self):
         """Initialize the background.
-        If self.background image is the path of an image
+        If self.background_image is the path of an image
         the image is set as background; else, the default
         background color fills the background.
         """

manimlib/camera/mapping_camera.py

@@ -10,6 +10,9 @@
 
 
 class MappingCamera(Camera):
+    """Camera object that allows mapping
+    between objects.
+    """
     CONFIG = {
         "mapping_func": lambda p: p,
         "min_num_curves": 50,

manimlib/camera/moving_camera.py

@@ -48,21 +48,65 @@ def __init__(self, frame=None, **kwargs):
 
     # TODO, make these work for a rotated frame
     def get_frame_height(self):
+        """Returns the height of the frame.
+
+        Returns
+        -------
+        float
+            The height of the frame.
+        """
         return self.frame.get_height()
 
     def get_frame_width(self):
+        """Returns the width of the frame
+
+        Returns
+        -------
+        float
+            The width of the frame.
+        """
         return self.frame.get_width()
 
     def get_frame_center(self):
+        """Returns the centerpoint of the frame in cartesian coordinates.
+
+        Returns
+        -------
+        np.array
+            The cartesian coordinates of the center of the frame.
+        """
         return self.frame.get_center()
 
     def set_frame_height(self, frame_height):
+        """Sets the height of the frame in MUnits.
+
+        Parameters
+        ----------
+        frame_height : int, float
+            The new frame_height.
+        """
         self.frame.stretch_to_fit_height(frame_height)
 
     def set_frame_width(self, frame_width):
+        """Sets the width of the frame in MUnits.
+
+        Parameters
+        ----------
+        frame_width : int, float
+            The new frame_width.
+        """
         self.frame.stretch_to_fit_width(frame_width)
 
     def set_frame_center(self, frame_center):
+        """Sets the centerpoint of the frame.
+
+        Parameters
+        ----------
+        frame_center : np.array, list, tuple, Mobject
+            The point to which the frame must be moved.
+            If is of type mobject, the frame will be moved to
+            the center of that mobject.
+        """
         self.frame.move_to(frame_center)
 
     def capture_mobjects(self, mobjects, **kwargs):
@@ -74,9 +118,19 @@ def capture_mobjects(self, mobjects, **kwargs):
     # context used for updating should be regenerated
     # at each frame.  So no caching.
     def get_cached_cairo_context(self, pixel_array):
+        """
+        Since the frame can be moving around, the cairo
+        context used for updating should be regenerated
+        at each frame.  So no caching.
+        """
         return None
 
     def cache_cairo_context(self, pixel_array, ctx):
+        """
+        Since the frame can be moving around, the cairo
+        context used for updating should be regenerated
+        at each frame.  So no caching.
+        """
         pass
 
     # def reset_frame_center(self):
@@ -94,5 +148,9 @@ def get_mobjects_indicating_movement(self):
         """
         Returns all mobjets whose movement implies that the camera
         should think of all other mobjects on the screen as moving
+
+        Returns
+        -------
+        list
         """
         return [self.frame]

manimlib/camera/multi_camera.py

@@ -3,17 +3,36 @@
 
 
 class MultiCamera(MovingCamera):
+    """Camera Object that allows for multiple perspectives.
+    """
     CONFIG = {
         "allow_cameras_to_capture_their_own_display": False,
     }
 
     def __init__(self, *image_mobjects_from_cameras, **kwargs):
+        """Initalises the MultiCamera
+
+        Parameters:
+        -----------
+        *image_mobjects_from_cameras : ImageMobject
+
+        **kwargs
+            Any valid keyword arguments of MovingCamera.
+        """
         self.image_mobjects_from_cameras = []
         for imfc in image_mobjects_from_cameras:
             self.add_image_mobject_from_camera(imfc)
         MovingCamera.__init__(self, **kwargs)
 
     def add_image_mobject_from_camera(self, image_mobject_from_camera):
+        """Adds an ImageMobject that's been obtained from the camera
+        into the list `self.image_mobject_from_cameras`
+
+        Parameters
+        ----------
+        image_mobject_from_camera : ImageMobject
+            The ImageMobject to add to self.image_mobject_from_cameras
+        """
         # A silly method to have right now, but maybe there are things
         # we want to guarantee about any imfc's added later.
         imfc = image_mobject_from_camera
@@ -34,6 +53,13 @@ def update_sub_cameras(self):
             )
 
     def reset(self):
+        """Resets the MultiCamera.
+
+        Returns
+        -------
+        MultiCamera
+            The reset MultiCamera
+        """
         for imfc in self.image_mobjects_from_cameras:
             imfc.camera.reset()
         MovingCamera.reset(self)
@@ -51,6 +77,13 @@ def capture_mobjects(self, mobjects, **kwargs):
         MovingCamera.capture_mobjects(self, mobjects, **kwargs)
 
     def get_mobjects_indicating_movement(self):
+        """Returns all mobjets whose movement implies that the camera
+        should think of all other mobjects on the screen as moving
+
+        Returns
+        -------
+        list
+        """
         return [self.frame] + [
             imfc.camera.frame
             for imfc in self.image_mobjects_from_cameras