Camera¶

def __init__(
    self,
    *,
    three_d: bool = False,
    frame_width: float | None = None,
    phi: float = 0,
    theta: float = -90 * DEGREES,
    gamma: float = 0,
    focal_distance: float = 20.0,
    zoom: float = 1,
    light_source_start_point: Point3D = 9 * DOWN + 7 * LEFT + 10 * OUT,
) -> None:
    from manimgx.mobject import Point

    self.three_d = three_d
    """Whether the camera sees in three dimensions: with perspective and depth, from
    its orbit."""
    self.frame = _view_rectangle(
        config.frame_height, frame_width or config.frame_width
    )
    """The view: a rectangle in the scene, centered on the point the camera looks
    at, as wide and as tall as what it shows.

    Move it, scale it or animate it to pan and zoom:
    `self.play(self.camera.frame.animate.scale(0.5))` zooms in, showing half as
    much, twice as large. Its outline is not drawn (a stroke width of 0).
    """
    self.phi_tracker, self.theta_tracker, self.gamma_tracker = (
        ValueTracker(phi),
        ValueTracker(theta),
        ValueTracker(gamma),
    )
    self.focal_distance_tracker, self.zoom_tracker = (
        ValueTracker(focal_distance),
        ValueTracker(zoom),
    )
    self.light_source = Point(light_source_start_point)
    """Where the light comes from: a point in the scene, which lights the mobjects
    shaded in three dimensions (`shade_in_3d`). Move it like any mobject."""
    # the mobjects pinned to the screen, as they were given: what they are made of
    # is read every frame (see `fixed_in_frame_mobjects`)
    self._fixed_in_frame: dict[Mobject, None] = {}
    self.background_color = config.background_color
    self.background_opacity = config.background_opacity
    """The opacity of the background, from 0 to 1: the configured one unless
    changed."""
    self.exposure = 1.0
    """How much the light that mobjects with a [material][manimgx.Material] reflect
    is scaled before it is shown: 2 is twice as bright (one stop)."""
    self.tone_mapping: Literal["linear", "agx"] = "linear"
    """How light brighter than white is shown: "linear" clips it (a lit surface's
    colors as they are, up to white), "agx" rolls it off as film does (AgX: highlights
    desaturate toward white, and nothing clips). The light lit surfaces send into a
    pixel is averaged first and shown once, as a camera records it."""
    self.ambient_occlusion = 0.0
    """How strongly the light from all around (an ambient or an environment light) is
    shut out of corners, creases and the ground under things, where the surfaces near
    them block it: 0 not at all (off), 1 Filament's strength, more darker. Only
    mobjects with a [material][manimgx.Material] are lit by that light, and only opaque
    ones shut it out or are darkened; a sun's, a point's or a spot's light is left as it
    is.

    It is found from what the view shows (Filament's screen-space ambient
    obscurance): a surface the view cannot see, such as a wall seen edge-on, shuts
    nothing out. Light bounces between the surfaces that shut it out, so light-colored
    ones darken less, and white ones hardly at all."""
    self.ambient_occlusion_radius = 0.3
    """How far around a point the surfaces that shut light out of it are sought, in
    scene units: about the size of the creases and contacts to darken."""
    self.bloom = 0.0
    """How much of the light that mobjects with a [material][manimgx.Material] send
    into the view the lens spreads around it, as a glow (bloom), from 0 to 1: 0 none
    (off), 0.05 a lens's faint glow, plain around light brighter than white, 1 all of
    it. What the glow spreads, the light leaves (Filament's interpolating bloom): the
    view keeps the light it has, spread.

    It is spread from the light the view shows: what lies nearer, a mobject fixed in
    the frame too, hides the light behind it. It falls off with the distance from
    the light: half of it lies within a twentieth of the view's height, nearly all of
    it within a quarter. It is light, over everything the view shows: over a lit
    surface, it adds to the surface's light before the tone mapping shows them; over
    display paint (the background, mobjects without a material, mobjects fixed in the
    frame), the tone mapping shows it on its own and it adds to the paint, as a screen
    adds light (white stays white); where the view shows nothing (a transparent
    background), it shows alone, as opaque as it is bright. Mobjects without a material
    send no light: they never glow."""