papers-context/agent_workspace/manim_docs/reference/manim.camera.moving_camera.MovingCamera.md

MovingCamera

Qualified name: manim.camera.moving\_camera.MovingCamera

class MovingCamera(frame=None, fixed_dimension=0, default_frame_stroke_color=ManimColor('#FFFFFF'), default_frame_stroke_width=0, **kwargs)

Bases: Camera

A camera that follows and matches the size and position of its ‘frame’, a Rectangle (or similar Mobject).

The frame defines the region of space the camera displays and can move or resize dynamically.

SEE ALSO

MovingCameraScene

Frame is a Mobject, (should almost certainly be a rectangle) determining which region of space the camera displays

Methods

auto_zoom	Zooms on to a given array of mobjects (or a singular mobject) and automatically resizes to frame all the mobjects.
cache_cairo_context	Since the frame can be moving around, the cairo context used for updating should be regenerated at each frame.
capture_mobjects	Capture mobjects by printing them on pixel_array.
get_cached_cairo_context	Since the frame can be moving around, the cairo context used for updating should be regenerated at each frame.
get_mobjects_indicating_movement	Returns all mobjects whose movement implies that the camera should think of all other mobjects on the screen as moving

Attributes

background_color
background_opacity
frame_center	Returns the centerpoint of the frame in cartesian coordinates.
frame_height	Returns the height of the frame.
frame_width	Returns the width of the frame

• Parameters:
  • frame (Mobject | None)
  • fixed_dimension (int)
  • default_frame_stroke_color (ManimColor)
  • default_frame_stroke_width (int)
  • kwargs (Any)

auto_zoom(mobjects, margin=0, only_mobjects_in_frame=False, animate=True)

Zooms on to a given array of mobjects (or a singular mobject) and automatically resizes to frame all the mobjects.

NOTE

This method only works when 2D-objects in the XY-plane are considered, it will not work correctly when the camera has been rotated.

• Parameters:
  • mobjects (Iterable *[*Mobject ]) – The mobject or array of mobjects that the camera will focus on.
  • margin (float) – The width of the margin that is added to the frame (optional, 0 by default).
  • only_mobjects_in_frame (bool) – If set to True, only allows focusing on mobjects that are already in frame.
  • animate (bool) – If set to False, applies the changes instead of returning the corresponding animation
• Returns: _AnimationBuilder that zooms the camera view to a given list of mobjects or ScreenRectangle with position and size updated to zoomed position.
• Return type: Union[_AnimationBuilder, ScreenRectangle]

cache_cairo_context(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.

• Parameters:
  • pixel_array (PixelArray)
  • ctx (Context)
• Return type: None

capture_mobjects(mobjects, **kwargs)

Capture mobjects by printing them on pixel_array.

This is the essential function that converts the contents of a Scene into an array, which is then converted to an image or video.

• Parameters:
  • mobjects (Iterable *[*Mobject ]) – Mobjects to capture.
  • kwargs (Any) – Keyword arguments to be passed to get_mobjects_to_display().
• Return type: None

Notes

For a list of classes that can currently be rendered, see display_funcs().

property frame_center : Point3D

Returns the centerpoint of the frame in cartesian coordinates.

• Returns: The cartesian coordinates of the center of the frame.
• Return type: np.array

property frame_height : float

Returns the height of the frame.

• Returns: The height of the frame.
• Return type: float

property frame_width : float

Returns the width of the frame

• Returns: The width of the frame.
• Return type: float

get_cached_cairo_context(pixel_array)

Since the frame can be moving around, the cairo context used for updating should be regenerated at each frame. So no caching.

• Parameters: pixel_array (PixelArray)
• Return type: None

get_mobjects_indicating_movement()

Returns all mobjects whose movement implies that the camera should think of all other mobjects on the screen as moving

• Return type: list[Mobject]