LabeledPolygram

Qualified name: algan.mobs.manim\_compat.LabeledPolygram

class LabeledPolygram(*vertex_groups, label, precision=0.01, label_config=None, box_config=None, frame_config=None, **kwargs)

Bases: ManimCompatMob

Constructs a polygram containing a label box at its pole of inaccessibility.

Parameters:

• vertex_groups (Point3DLike_Array) – Vertices passed to the Polygram constructor.

• label (str | ManimTextLabel) – Label that will be displayed on the Polygram.

• precision (float) – The precision used by the PolyLabel algorithm.

• label_config (dict[str, Any] | None) – A dictionary containing the configuration for the label. This is only applied if label is of type str.

• box_config (dict[str, Any] | None) – A dictionary containing the configuration for the background box.

• frame_config (dict[str, Any] | None) –

  A dictionary containing the configuration for the frame.

  Note

  The PolyLabel Algorithm expects each vertex group to form a closed ring. If the input is open, LabeledPolygram will attempt to close it. This may cause the polygon to intersect itself leading to unexpected results.

  Tip

  Make sure the precision corresponds to the scale of your inputs! For instance, if the bounding box of your polygon stretches from 0 to 10,000, a precision of 1.0 or 10.0 should be sufficient.

• kwargs (Any)

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).