@@ -893,8 +893,10 @@ def display_point_cloud(
893893 thickness : float ,
894894 pixel_array : np .ndarray ,
895895 ):
896- """Displays a PMobject by modifying the Pixel array suitably..
896+ """Displays a PMobject by modifying the pixel array suitably.
897+
897898 TODO: Write a description for the rgbas argument.
899+
898900 Parameters
899901 ----------
900902 pmobject
@@ -1129,17 +1131,19 @@ def on_screen_pixels(self, pixel_coords: np.ndarray):
11291131 ],
11301132 )
11311133
1132- def adjusted_thickness (self , thickness : float ):
1133- """
1134+ def adjusted_thickness (self , thickness : float ) -> float :
1135+ """Computes the adjusted stroke width for a zoomed camera.
11341136
11351137 Parameters
11361138 ----------
11371139 thickness
1140+ The stroke width of a mobject.
11381141
11391142 Returns
11401143 -------
11411144 float
1142-
1145+ The adjusted stroke width that reflects zooming in with
1146+ the camera.
11431147 """
11441148 # TODO: This seems...unsystematic
11451149 big_sum = op .add (config ["pixel_height" ], config ["pixel_width" ])
@@ -1148,7 +1152,8 @@ def adjusted_thickness(self, thickness: float):
11481152 return 1 + (thickness - 1 ) * factor
11491153
11501154 def get_thickening_nudges (self , thickness : float ):
1151- """
1155+ """Determine a list of vectors used to nudge
1156+ two-dimensional pixel coordinates.
11521157
11531158 Parameters
11541159 ----------
@@ -1222,13 +1227,16 @@ def get_coords_of_all_pixels(self):
12221227# NOTE: The methods of the following class have not been mentioned outside of their definitions.
12231228# Their DocStrings are not as detailed as preferred.
12241229class BackgroundColoredVMobjectDisplayer :
1230+ """Auxiliary class that handles displaying vectorized mobjects with
1231+ a set background image.
1232+
1233+ Parameters
1234+ ----------
1235+ camera
1236+ Camera object to use.
1237+ """
1238+
12251239 def __init__ (self , camera : Camera ):
1226- """
1227- Parameters
1228- ----------
1229- camera
1230- Camera object to use.
1231- """
12321240 self .camera = camera
12331241 self .file_name_to_pixel_array_map = {}
12341242 self .pixel_array = np .array (camera .pixel_array )
0 commit comments