VMobject

Qualified name: manim.mobject.types.vectorized\_mobject.VMobject

class VMobject(fill_color=None, fill_opacity=0.0, stroke_color=None, stroke_opacity=1.0, stroke_width=4, background_stroke_color=ManimColor('#000000'), background_stroke_opacity=1.0, background_stroke_width=0, sheen_factor=0.0, joint_type=None, sheen_direction=array([- 1., 1., 0.]), close_new_points=False, pre_function_handle_to_anchor_scale_factor=0.01, make_smooth_after_applying_functions=False, background_image=None, shade_in_3d=False, tolerance_for_point_equality=1e-06, n_points_per_cubic_curve=4, **kwargs)

Bases: Mobject

A vectorized mobject.

Parameters:

• background_stroke_color (ParsableManimColor | None) – The purpose of background stroke is to have something that won’t overlap fill, e.g. For text against some textured background.

• sheen_factor (float) – When a color c is set, there will be a second color computed based on interpolating c to WHITE by with sheen_factor, and the display will gradient to this secondary color in the direction of sheen_direction.

• close_new_points (bool) – Indicates that it will not be displayed, but that it should count in parent mobject’s path

• tolerance_for_point_equality (float) – This is within a pixel

• joint_type (LineJointType | None) – The line joint type used to connect the curve segments of this vectorized mobject. See LineJointType for options.

• fill_color (ParsableManimColor | None) –

• fill_opacity (float) –

• stroke_color (ParsableManimColor | None) –

• stroke_opacity (float) –

• stroke_width (float) –

• background_stroke_opacity (float) –

• background_stroke_width (float) –

• sheen_direction (Vector3) –

• pre_function_handle_to_anchor_scale_factor (float) –

• make_smooth_after_applying_functions (bool) –

• background_image (Image | str | None) –

• shade_in_3d (bool) –

• n_points_per_cubic_curve (int) –

Methods

add_cubic_bezier_curve
add_cubic_bezier_curve_to	Add cubic bezier curve to the path.
add_cubic_bezier_curves
add_line_to	Add a straight line from the last point of VMobject to the given point.
add_points_as_corners
add_quadratic_bezier_curve_to	Add Quadratic bezier curve to the path.
add_smooth_curve_to	Creates a smooth curve from given points and add it to the VMobject.
add_subpath
align_points	Adds points to self and vmobject so that they both have the same number of subpaths, with corresponding subpaths each containing the same number of points.
align_rgbas
append_points
append_vectorized_mobject
apply_function
change_anchor_mode	Changes the anchor mode of the bezier curves.
clear_points
close_path
color_using_background_image
consider_points_equals
consider_points_equals_2d	Determine if two points are close enough to be considered equal.
fade
force_direction	Makes sure that points are either directed clockwise or counterclockwise.
gen_cubic_bezier_tuples_from_points	Returns the bezier tuples from an array of points.
gen_subpaths_from_points_2d
generate_rgbas_array	First arg can be either a color, or a tuple/list of colors.
get_anchors	Returns the anchors of the curves forming the VMobject.
get_anchors_and_handles	Returns anchors1, handles1, handles2, anchors2, where (anchors1[i], handles1[i], handles2[i], anchors2[i]) will be four points defining a cubic bezier curve for any i in range(0, len(anchors1))
get_arc_length	Return the approximated length of the whole curve.
get_background_image
get_color	Returns the color of the Mobject
get_cubic_bezier_tuples
get_cubic_bezier_tuples_from_points
get_curve_functions	Gets the functions for the curves of the mobject.
get_curve_functions_with_lengths	Gets the functions and lengths of the curves for the mobject.
get_direction	Uses shoelace_direction() to calculate the direction.
get_end_anchors	Return the end anchors of the bezier curves.
get_fill_color	If there are multiple colors (for gradient) this returns the first one
get_fill_colors
get_fill_opacities
get_fill_opacity	If there are multiple opacities, this returns the first
get_fill_rgbas
get_gradient_start_and_end_points
get_group_class
get_last_point
get_mobject_type_class	Return the base class of this mobject type.
get_nth_curve_function	Returns the expression of the nth curve.
get_nth_curve_function_with_length	Returns the expression of the nth curve along with its (approximate) length.
get_nth_curve_length	Returns the (approximate) length of the nth curve.
get_nth_curve_length_pieces	Returns the array of short line lengths used for length approximation.
get_nth_curve_points	Returns the points defining the nth curve of the vmobject.
get_num_curves	Returns the number of curves of the vmobject.
get_point_mobject	The simplest Mobject to be transformed to or from self.
get_points_defining_boundary
get_sheen_direction
get_sheen_factor
get_start_anchors	Returns the start anchors of the bezier curves.
get_stroke_color
get_stroke_colors
get_stroke_opacities
get_stroke_opacity
get_stroke_rgbas
get_stroke_width
get_style
get_subcurve	Returns the subcurve of the VMobject between the interval [a, b].
get_subpaths	Returns subpaths formed by the curves of the VMobject.
get_subpaths_from_points
has_new_path_started
init_colors	Initializes the colors.
insert_n_curves	Inserts n curves to the bezier curves of the vmobject.
insert_n_curves_to_point_list	Given an array of k points defining a bezier curves (anchors and handles), returns points defining exactly k + n bezier curves.
interpolate_color
is_closed
make_jagged
make_smooth
match_background_image
match_style
point_from_proportion	Gets the point at a proportion along the path of the VMobject.
pointwise_become_partial	Given two bounds a and b, transforms the points of the self vmobject into the points of the vmobject passed as parameter with respect to the bounds.
proportion_from_point	Returns the proportion along the path of the VMobject a particular given point is at.
resize_points	Resize the array of anchor points and handles to have the specified size.
reverse_direction	Reverts the point direction by inverting the point order.
rotate	Rotates the Mobject about a certain point.
rotate_sheen_direction	Rotates the direction of the applied sheen.
scale_handle_to_anchor_distances	If the distance between a given handle point H and its associated anchor point A is d, then it changes H to be a distances factor*d away from A, but so that the line from A to H doesn't change.
set_anchors_and_handles	Given two sets of anchors and handles, process them to set them as anchors and handles of the VMobject.
set_background_stroke
set_color	Condition is function which takes in one arguments, (x, y, z).
set_fill	Set the fill color and fill opacity of a VMobject.
set_opacity
set_points
set_points_as_corners	Given an array of points, set them as corner of the vmobject.
set_points_smoothly
set_shade_in_3d
set_sheen	Applies a color gradient from a direction.
set_sheen_direction	Sets the direction of the applied sheen.
set_stroke
set_style
start_new_path
update_rgbas_array

Attributes

animate	Used to animate the application of any method of self.
animation_overrides
color
depth	The depth of the mobject.
fill_color	If there are multiple colors (for gradient) this returns the first one
height	The height of the mobject.
n_points_per_curve
sheen_factor
stroke_color
width	The width of the mobject.

_gen_subpaths_from_points(points, filter_func)

Given an array of points defining the bezier curves of the vmobject, return subpaths formed by these points. Here, Two bezier curves form a path if at least two of their anchors are evaluated True by the relation defined by filter_func.

The algorithm every bezier tuple (anchors and handles) in self.points (by regrouping each n elements, where n is the number of points per cubic curve)), and evaluate the relation between two anchors with filter_func. NOTE : The filter_func takes an int n as parameter, and will evaluate the relation between points[n] and points[n - 1]. This should probably be changed so the function takes two points as parameters.

Parameters:

• points (Point3D_Array) – points defining the bezier curve.

• filter_func (Callable[[int], bool]) – Filter-func defining the relation.

Returns:

subpaths formed by the points.

Return type:

Generator[Point3D_Array]

_original__init__(fill_color=None, fill_opacity=0.0, stroke_color=None, stroke_opacity=1.0, stroke_width=4, background_stroke_color=ManimColor('#000000'), background_stroke_opacity=1.0, background_stroke_width=0, sheen_factor=0.0, joint_type=None, sheen_direction=array([- 1., 1., 0.]), close_new_points=False, pre_function_handle_to_anchor_scale_factor=0.01, make_smooth_after_applying_functions=False, background_image=None, shade_in_3d=False, tolerance_for_point_equality=1e-06, n_points_per_cubic_curve=4, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Parameters:

• fill_color (ParsableManimColor | None) –

• fill_opacity (float) –

• stroke_color (ParsableManimColor | None) –

• stroke_opacity (float) –

• stroke_width (float) –

• background_stroke_color (ParsableManimColor | None) –

• background_stroke_opacity (float) –

• background_stroke_width (float) –

• sheen_factor (float) –

• joint_type (LineJointType | None) –

• sheen_direction (Vector3) –

• close_new_points (bool) –

• pre_function_handle_to_anchor_scale_factor (float) –

• make_smooth_after_applying_functions (bool) –

• background_image (Image | str | None) –

• shade_in_3d (bool) –

• tolerance_for_point_equality (float) –

• n_points_per_cubic_curve (int) –

add_cubic_bezier_curve_to(handle1, handle2, anchor)

Add cubic bezier curve to the path.

NOTE : the first anchor is not a parameter as by default the end of the last sub-path!

Parameters:

• handle1 (CubicBezierPoints) – first handle

• handle2 (CubicBezierPoints) – second handle

• anchor (CubicBezierPoints) – anchor

Returns:

self

Return type:

VMobject

add_line_to(point)

Add a straight line from the last point of VMobject to the given point.

Parameters:

point (Point3D) – end of the straight line.

Returns:

self

Return type:

VMobject

add_quadratic_bezier_curve_to(handle, anchor)

Add Quadratic bezier curve to the path.

Returns:

self

Return type:

VMobject

Parameters:

• handle (QuadraticBezierPoints) –

• anchor (QuadraticBezierPoints) –

add_smooth_curve_to(*points)

Creates a smooth curve from given points and add it to the VMobject. If two points are passed in, the first is interpreted as a handle, the second as an anchor.

Parameters:

points (Point3D) – Points (anchor and handle, or just anchor) to add a smooth curve from

Returns:

self

Return type:

VMobject

Raises:

ValueError – If 0 or more than 2 points are given.

align_points(vmobject)

Adds points to self and vmobject so that they both have the same number of subpaths, with corresponding subpaths each containing the same number of points.

Points are added either by subdividing curves evenly along the subpath, or by creating new subpaths consisting of a single point repeated.

Parameters:

vmobject (VMobject) – The object to align points with.

Returns:

self

Return type:

VMobject

change_anchor_mode(mode)

Changes the anchor mode of the bezier curves. This will modify the handles.

There can be only two modes, “jagged”, and “smooth”.

Returns:

self

Return type:

VMobject

Parameters:

mode (Literal['jagged', 'smooth']) –

consider_points_equals_2d(p0, p1)

Determine if two points are close enough to be considered equal.

This uses the algorithm from np.isclose(), but expanded here for the 2D point case. NumPy is overkill for such a small question. :param p0: first point :param p1: second point

Returns:

whether two points considered close.

Return type:

bool

Parameters:

• p0 (Point2D) –

• p1 (Point2D) –

property fill_color: ManimColor

If there are multiple colors (for gradient) this returns the first one

force_direction(target_direction)

Makes sure that points are either directed clockwise or counterclockwise.

Parameters:

target_direction (Literal['CW', 'CCW']) – Either "CW" or "CCW".

Return type:

Self

gen_cubic_bezier_tuples_from_points(points)

Returns the bezier tuples from an array of points.

self.points is a list of the anchors and handles of the bezier curves of the mobject (ie [anchor1, handle1, handle2, anchor2, anchor3 ..]) This algorithm basically retrieve them by taking an element every n, where n is the number of control points of the bezier curve.

Parameters:

points (Point3D_Array) – Points from which control points will be extracted.

Returns:

Bezier control points.

Return type:

tuple

generate_rgbas_array(color, opacity)

First arg can be either a color, or a tuple/list of colors. Likewise, opacity can either be a float, or a tuple of floats. If self.sheen_factor is not zero, and only one color was passed in, a second slightly light color will automatically be added for the gradient

Parameters:

• color (ManimColor | list[ManimColor]) –

• opacity (float | Iterable[float]) –

Return type:

RGBA_Array_Float

get_anchors()

Returns the anchors of the curves forming the VMobject.

Returns:

The anchors.

Return type:

Point3D_Array

get_anchors_and_handles()

Returns anchors1, handles1, handles2, anchors2, where (anchors1[i], handles1[i], handles2[i], anchors2[i]) will be four points defining a cubic bezier curve for any i in range(0, len(anchors1))

Returns:

Iterable of the anchors and handles.

Return type:

list[Point3D_Array]

get_arc_length(sample_points_per_curve=None)

Return the approximated length of the whole curve.

Parameters:

sample_points_per_curve (int | None) – Number of sample points per curve used to approximate the length. More points result in a better approximation.

Returns:

The length of the VMobject.

Return type:

float

get_color()

Returns the color of the Mobject

Return type:

ManimColor

get_curve_functions()

Gets the functions for the curves of the mobject.

Returns:

The functions for the curves.

Return type:

Generator[Callable[[float], Point3D]]

get_curve_functions_with_lengths(**kwargs)

Gets the functions and lengths of the curves for the mobject.

Parameters:

**kwargs – The keyword arguments passed to get_nth_curve_function_with_length()

Returns:

The functions and lengths of the curves.

Return type:

Generator[tuple[Callable[[float], Point3D], float]]

get_direction()

Uses shoelace_direction() to calculate the direction. The direction of points determines in which direction the object is drawn, clockwise or counterclockwise.

Examples

The default direction of a Circle is counterclockwise:

>>> from manim import Circle
>>> Circle().get_direction()
'CCW'

Returns:

Either "CW" or "CCW".

Return type:

str

get_end_anchors()

Return the end anchors of the bezier curves.

Returns:

Starting anchors

Return type:

Point3D_Array

get_fill_color()

If there are multiple colors (for gradient) this returns the first one

Return type:

ManimColor

get_fill_opacity()

If there are multiple opacities, this returns the first

Return type:

ManimFloat

static get_mobject_type_class()

Return the base class of this mobject type.

Return type:

type[manim.mobject.types.vectorized_mobject.VMobject]

get_nth_curve_function(n)

Returns the expression of the nth curve.

Parameters:

n (int) – index of the desired curve.

Returns:

expression of the nth bezier curve.

Return type:

Callable[float, Point3D]

get_nth_curve_function_with_length(n, sample_points=None)

Returns the expression of the nth curve along with its (approximate) length.

Parameters:

• n (int) – The index of the desired curve.

• sample_points (int | None) – The number of points to sample to find the length.

Returns:

• curve (Callable[[float], Point3D]) – The function for the nth curve.

• length (float) – The length of the nth curve.

Return type:

tuple[Callable[[float], Point3D], float]

get_nth_curve_length(n, sample_points=None)

Returns the (approximate) length of the nth curve.

Parameters:

• n (int) – The index of the desired curve.

• sample_points (int | None) – The number of points to sample to find the length.

Returns:

length – The length of the nth curve.

Return type:

float

get_nth_curve_length_pieces(n, sample_points=None)

Returns the array of short line lengths used for length approximation.

Parameters:

• n (int) – The index of the desired curve.

• sample_points (int | None) – The number of points to sample to find the length.

Return type:

The short length-pieces of the nth curve.

get_nth_curve_points(n)

Returns the points defining the nth curve of the vmobject.

Parameters:

n (int) – index of the desired bezier curve.

Returns:

points defining the nth bezier curve (anchors, handles)

Return type:

Point3D_Array

get_num_curves()

Returns the number of curves of the vmobject.

Returns:

number of curves of the vmobject.

Return type:

int

get_point_mobject(center=None)

The simplest Mobject to be transformed to or from self. Should by a point of the appropriate type

Parameters:

center (Point3D | None) –

Return type:

VectorizedPoint

get_start_anchors()

Returns the start anchors of the bezier curves.

Returns:

Starting anchors

Return type:

Point3D_Array

get_subcurve(a, b)

Returns the subcurve of the VMobject between the interval [a, b]. The curve is a VMobject itself.

Parameters:

• a (float) – The lower bound.

• b (float) – The upper bound.

Returns:

The subcurve between of [a, b]

Return type:

VMobject

get_subpaths()

Returns subpaths formed by the curves of the VMobject.

Subpaths are ranges of curves with each pair of consecutive curves having their end/start points coincident.

Returns:

subpaths.

Return type:

list[Point3D_Array]

init_colors(propagate_colors=True)

Initializes the colors.

Gets called upon creation. This is an empty method that can be implemented by subclasses.

Parameters:

propagate_colors (bool) –

Return type:

Self

insert_n_curves(n)

Inserts n curves to the bezier curves of the vmobject.

Parameters:

n (int) – Number of curves to insert.

Returns:

self

Return type:

VMobject

insert_n_curves_to_point_list(n, points)

Given an array of k points defining a bezier curves (anchors and handles), returns points defining exactly k + n bezier curves.

Parameters:

• n (int) – Number of desired curves.

• points (Point3D_Array) – Starting points.

Return type:

Points generated.

point_from_proportion(alpha)

Gets the point at a proportion along the path of the VMobject.

Parameters:

alpha (float) – The proportion along the the path of the VMobject.

Returns:

The point on the VMobject.

Return type:

numpy.ndarray

Raises:

• ValueError – If alpha is not between 0 and 1.

• Exception – If the VMobject has no points.

pointwise_become_partial(vmobject, a, b)

Given two bounds a and b, transforms the points of the self vmobject into the points of the vmobject passed as parameter with respect to the bounds. Points here stand for control points of the bezier curves (anchors and handles)

Parameters:

• vmobject (VMobject) – The vmobject that will serve as a model.

• a (float) – upper-bound.

• b (float) – lower-bound

Returns:

self

Return type:

VMobject

proportion_from_point(point)

Returns the proportion along the path of the VMobject a particular given point is at.

Parameters:

point (Iterable[float | int]) – The Cartesian coordinates of the point which may or may not lie on the VMobject

Returns:

The proportion along the path of the VMobject.

Return type:

float

Raises:

• ValueError – If point does not lie on the curve.

• Exception – If the VMobject has no points.

resize_points(new_length, resize_func=<function resize_array>)

Resize the array of anchor points and handles to have the specified size.

Parameters:

• new_length (int) – The new (total) number of points.

• resize_func (Callable[[Point3D, int], Point3D]) – A function mapping a Numpy array (the points) and an integer (the target size) to a Numpy array. The default implementation is based on Numpy’s resize function.

Return type:

Self

reverse_direction()

Reverts the point direction by inverting the point order.

Returns:

Returns self.

Return type:

VMobject

Examples

Example: ChangeOfDirection

from manim import *

class ChangeOfDirection(Scene):
    def construct(self):
        ccw = RegularPolygon(5)
        ccw.shift(LEFT)
        cw = RegularPolygon(5)
        cw.shift(RIGHT).reverse_direction()

        self.play(Create(ccw), Create(cw),
        run_time=4)

class ChangeOfDirection(Scene):
    def construct(self):
        ccw = RegularPolygon(5)
        ccw.shift(LEFT)
        cw = RegularPolygon(5)
        cw.shift(RIGHT).reverse_direction()

        self.play(Create(ccw), Create(cw),
        run_time=4)

rotate(angle, axis=array([0., 0., 1.]), about_point=None, **kwargs)

Rotates the Mobject about a certain point.

Parameters:

• angle (float) –

• axis (Vector3) –

• about_point (Point3D | None) –

Return type:

Self

rotate_sheen_direction(angle, axis=array([0., 0., 1.]), family=True)

Rotates the direction of the applied sheen.

Parameters:

• angle (float) – Angle by which the direction of sheen is rotated.

• axis (Vector3) – Axis of rotation.

• family (bool) –

Return type:

Self

Examples

Normal usage:

Circle().set_sheen_direction(UP).rotate_sheen_direction(PI)

See also

set_sheen_direction()

scale_handle_to_anchor_distances(factor)

If the distance between a given handle point H and its associated anchor point A is d, then it changes H to be a distances factor*d away from A, but so that the line from A to H doesn’t change. This is mostly useful in the context of applying a (differentiable) function, to preserve tangency properties. One would pull all the handles closer to their anchors, apply the function then push them out again.

Parameters:

factor (float) – The factor used for scaling.

Returns:

self

Return type:

VMobject

set_anchors_and_handles(anchors1, handles1, handles2, anchors2)

Given two sets of anchors and handles, process them to set them as anchors and handles of the VMobject.

anchors1[i], handles1[i], handles2[i] and anchors2[i] define the i-th bezier curve of the vmobject. There are four hardcoded parameters and this is a problem as it makes the number of points per cubic curve unchangeable from 4 (two anchors and two handles).

Returns:

self

Return type:

VMobject

Parameters:

• anchors1 (CubicBezierPoints) –

• handles1 (CubicBezierPoints) –

• handles2 (CubicBezierPoints) –

• anchors2 (CubicBezierPoints) –

set_color(color, family=True)

Condition is function which takes in one arguments, (x, y, z). Here it just recurses to submobjects, but in subclasses this should be further implemented based on the the inner workings of color

Parameters:

• color (Union[ManimColor, int, str, Tuple[int, int, int], Tuple[float, float, float], Tuple[int, int, int, int], Tuple[float, float, float, float], ndarray[Any, dtype[int64]], ndarray[Any, dtype[float64]]]) –

• family (bool) –

Return type:

Self

set_fill(color=None, opacity=None, family=True)

Set the fill color and fill opacity of a VMobject.

Parameters:

• color (Optional[Union[ManimColor, int, str, Tuple[int, int, int], Tuple[float, float, float], Tuple[int, int, int, int], Tuple[float, float, float, float], ndarray[Any, dtype[int64]], ndarray[Any, dtype[float64]]]]) – Fill color of the VMobject.

• opacity (float | None) – Fill opacity of the VMobject.

• family (bool) – If True, the fill color of all submobjects is also set.

Returns:

self

Return type:

VMobject

Examples

Example: SetFill

from manim import *

class SetFill(Scene):
    def construct(self):
        square = Square().scale(2).set_fill(WHITE,1)
        circle1 = Circle().set_fill(GREEN,0.8)
        circle2 = Circle().set_fill(YELLOW) # No fill_opacity
        circle3 = Circle().set_fill(color = '#FF2135', opacity = 0.2)
        group = Group(circle1,circle2,circle3).arrange()
        self.add(square)
        self.add(group)

class SetFill(Scene):
    def construct(self):
        square = Square().scale(2).set_fill(WHITE,1)
        circle1 = Circle().set_fill(GREEN,0.8)
        circle2 = Circle().set_fill(YELLOW) # No fill_opacity
        circle3 = Circle().set_fill(color = '#FF2135', opacity = 0.2)
        group = Group(circle1,circle2,circle3).arrange()
        self.add(square)
        self.add(group)

See also

set_style()

set_points_as_corners(points)

Given an array of points, set them as corner of the vmobject.

To achieve that, this algorithm sets handles aligned with the anchors such that the resultant bezier curve will be the segment between the two anchors.

Parameters:

points (Point3D_Array) – Array of points that will be set as corners.

Returns:

self

Return type:

VMobject

set_sheen(factor, direction=None, family=True)

Applies a color gradient from a direction.

Parameters:

• factor (float) – The extent of lustre/gradient to apply. If negative, the gradient starts from black, if positive the gradient starts from white and changes to the current color.

• direction (Vector3 | None) – Direction from where the gradient is applied.

• family (bool) –

Return type:

Self

Examples

Example: SetSheen

from manim import *

class SetSheen(Scene):
    def construct(self):
        circle = Circle(fill_opacity=1).set_sheen(-0.3, DR)
        self.add(circle)

class SetSheen(Scene):
    def construct(self):
        circle = Circle(fill_opacity=1).set_sheen(-0.3, DR)
        self.add(circle)

set_sheen_direction(direction, family=True)

Sets the direction of the applied sheen.

Parameters:

• direction (Vector3) – Direction from where the gradient is applied.

• family (bool) –

Return type:

Self

Examples

Normal usage:

Circle().set_sheen_direction(UP)

See also

set_sheen(), rotate_sheen_direction()