PolarPlane¶
Qualified name: algan.mobs.manim\_compat.PolarPlane
- class PolarPlane(radius_max=4.0, size=None, radius_step=1, azimuth_step=None, azimuth_units='PI radians', azimuth_compact_fraction=True, azimuth_offset=0, azimuth_direction='CCW', azimuth_label_buff=0.1, azimuth_label_font_size=24, radius_config=None, background_line_style=None, faded_line_style=None, faded_line_ratio=1, make_smooth_after_applying_functions=True, **kwargs)¶
Bases:
ManimCompatMobCreates a polar plane with background lines.
- Parameters:
azimuth_step (float | None) –
The number of divisions in the azimuth (also known as the angular coordinate or polar angle). If
Noneis specified then it will use the default specified byazimuth_units:"PI radians"or"TAU radians": 20"degrees": 36"gradians": 40None: 1
A non-integer value will result in a partial division at the end of the circle.
size (float | None) – The diameter of the plane.
radius_step (float) – The distance between faded radius lines.
radius_max (float) – The maximum value of the radius.
azimuth_units (str) –
Specifies a default labelling system for the azimuth. Choices are:
"PI radians": Fractional labels in the interval \(\left[0, 2\pi\right]\) with \(\pi\) as a constant."TAU radians": Fractional labels in the interval \(\left[0, \tau\right]\) (where \(\tau = 2\pi\)) with \(\tau\) as a constant."degrees": Decimal labels in the interval \(\left[0, 360\right]\) with a degree (\(^{\circ}\)) symbol."gradians": Decimal labels in the interval \(\left[0, 400\right]\) with a superscript “g” (\(^{g}\)).None: Decimal labels in the interval \(\left[0, 1\right]\).
azimuth_compact_fraction (bool) – If the
azimuth_unitschoice has fractional labels, choose whether to combine the constant in a compact form \(\tfrac{xu}{y}\) as opposed to \(\tfrac{x}{y}u\), where \(u\) is the constant.azimuth_offset (float) – The angle offset of the azimuth, expressed in radians.
azimuth_direction (str) –
The direction of the azimuth.
"CW": Clockwise."CCW": Anti-clockwise.
azimuth_label_buff (float) – The buffer for the azimuth labels.
azimuth_label_font_size (float) – The font size of the azimuth labels.
radius_config (dict[str, Any] | None) – The axis config for the radius.
background_line_style (dict[str, Any] | None)
faded_line_style (dict[str, Any] | None)
faded_line_ratio (int)
make_smooth_after_applying_functions (bool)
kwargs (Any)
Methods
Attributes
animation_managerThis mob's scene-owned animation manager.
basisThe Mob's orientation and scale, as a flattened 3x3 matrix of shape
(*, 9).casts_shadowsWhether this Mob's geometry blocks light on its way from a light source to another surface -- whether it casts a shadow.
childrenThe Mobs attached below this one, in attachment order.
closed_shellWhether this Mob's triangles form a CLOSED shell -- every camera ray that enters the geometry crosses a second time on its way out.
draws_descendantsWhether
get_render_primitivesreturns geometry belonging to this Mob's DESCENDANTS as well as its own.forwardGet the direction the Mob is facing.
lifespanThis mob's [spawn, despawn) interval on its Scene timeline (a
Lifespan).locationThe Mob's position in world space, shape
(*, 3).normalized_basisThe Mob's orientation with scale divided out, shape
(*, 9).parentsThe Mobs this one is attached to, in attachment order.
receives_shadowsWhether this Mob's surfaces are darkened by shadows cast onto them.
rightGet the Mob's own rightward direction.
scale_coefficientThe Mob's scale along its own right, up and forward axes, shape
(*, 3).stroke_colorThe color of the circuit's border stroke.
two_sidedWhether this Mob's geometry should be lit from whichever side the ray arrives on.
upGet the Mob's own upward direction.
xThe Mob's x coordinate in world units, shape
(*, 1).xyThe Mob's x and y coordinates in world units, shape
(*, 2).yThe Mob's y coordinate in world units, shape
(*, 1).zThe Mob's z coordinate in world units, shape
(*, 1).z_indexWhich of two exactly coplanar circuits draws in front (higher wins).