SurroundingRectangle¶

Qualified name: algan.mobs.shapes\_2d.SurroundingRectangle

class SurroundingRectangle(*mobjects, color=None, buff=None, corner_radius=0.0, buffer=None, bottom_buffer=None, **kwargs)[source]¶

Bases: Quad

A rectangle sized to enclose one or more other Mobs.

The rectangle is built around the Mobs’ combined bounding box at construction time, so it does not track them afterwards – rebuild it, or add an updater, if the contents move.

Parameters:

*mobjects – The Mobs to enclose. At least one is required.
color – Color of the rectangle. Defaults to None, meaning the class default.
buff – Gap between the contents and the rectangle, in world units. A (horizontal, vertical) pair sets the two axes separately. Defaults to None, meaning half of SETTINGS.style.buffer (0.3).
corner_radius – Corner rounding in world units. Defaults to 0.0, i.e. square corners.
buffer – Alias of buff, for consistency with Algan’s other spacing parameters. When both are given, this one wins. Defaults to None.
bottom_buffer – Additional gap below the contents, in world units, for leaving room for a caption. Defaults to None, meaning none.
**kwargs – Passed to BezierCircuitCubic – notably stroke_color, stroke_width and filled=False for an outline-only frame.

Raises:

ValueError – If no Mobs are given.

Methods

Attributes

`animation_manager`	This mob's scene-owned animation manager.
`basis`	The Mob's orientation and scale, as a flattened 3x3 matrix of shape `(*, 9)`.
`casts_shadows`	Whether this Mob's geometry blocks light on its way from a light source to another surface -- whether it casts a shadow.
`children`	The Mobs attached below this one, in attachment order.
`closed_shell`	Whether this Mob's triangles form a CLOSED shell -- every camera ray that enters the geometry crosses a second time on its way out.
`draws_descendants`	Whether `get_render_primitives` returns geometry belonging to this Mob's DESCENDANTS as well as its own.
`forward`	Get the direction the Mob is facing.
`lifespan`	This mob's [spawn, despawn) interval on its Scene timeline (a `Lifespan`).
`location`	The Mob's position in world space, shape `(*, 3)`.
`normalized_basis`	The Mob's orientation with scale divided out, shape `(*, 9)`.
`parents`	The Mobs this one is attached to, in attachment order.
`receives_shadows`	Whether this Mob's surfaces are darkened by shadows cast onto them.
`right`	Get the Mob's own rightward direction.
`scale_coefficient`	The Mob's scale along its own right, up and forward axes, shape `(*, 3)`.
`stroke_color`	The color of the circuit's border stroke.
`two_sided`	Whether this Mob's geometry should be lit from whichever side the ray arrives on.
`up`	Get the Mob's own upward direction.
`x`	The Mob's x coordinate in world units, shape `(*, 1)`.
`xy`	The Mob's x and y coordinates in world units, shape `(*, 2)`.
`y`	The Mob's y coordinate in world units, shape `(*, 1)`.
`z`	The Mob's z coordinate in world units, shape `(*, 1)`.
`z_index`	Which of two exactly coplanar circuits draws in front (higher wins).