ArrowVectorField

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

class ArrowVectorField(func, color=None, color_scheme=None, min_color_scheme_value=0, max_color_scheme_value=2, colors=[ManimColor('#236B8E'), ManimColor('#83C167'), ManimColor('#F7D96F'), ManimColor('#FC6255')], x_range=None, y_range=None, z_range=None, three_dimensions=False, length_func=<function ArrowVectorField.<lambda>>, opacity=1.0, vector_config=None, **kwargs)

Bases: ManimCompatMob

A VectorField represented by a set of change vectors.

Vector fields are always based on a function defining the Vector at every position. The values of this functions is displayed as a grid of vectors. By default the color of each vector is determined by it’s magnitude. Other color schemes can be used however.

Parameters:

• func (Callable[[np.ndarray], np.ndarray]) – The function defining the rate of change at every position of the vector field.

• color (ParsableManimColor | None) – The color of the vector field. If set, position-specific coloring is disabled.

• color_scheme (Callable[[np.ndarray], float] | None) – A function mapping a vector to a single value. This value gives the position in the color gradient defined using min_color_scheme_value, max_color_scheme_value and colors.

• min_color_scheme_value (float) – The value of the color_scheme function to be mapped to the first color in colors. Lower values also result in the first color of the gradient.

• max_color_scheme_value (float) – The value of the color_scheme function to be mapped to the last color in colors. Higher values also result in the last color of the gradient.

• colors (Sequence[ParsableManimColor]) – The colors defining the color gradient of the vector field.

• x_range (Sequence[float]) – A sequence of x_min, x_max, delta_x

• y_range (Sequence[float]) – A sequence of y_min, y_max, delta_y

• z_range (Sequence[float]) – A sequence of z_min, z_max, delta_z

• three_dimensions (bool) – Enables three_dimensions. Default set to False, automatically turns True if z_range is not None.

• length_func (Callable[[float], float]) – The function determining the displayed size of the vectors. The actual size of the vector is passed, the returned value will be used as display size for the vector. By default this is used to cap the displayed size of vectors to reduce the clutter.

• opacity (float) – The opacity of the arrows.

• vector_config (dict | None) – Additional arguments to be passed to the Vector constructor

• kwargs – Additional arguments to be passed to the VGroup constructor

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