On this page

Mobject

from noon import Mobject

Source-derived class. Host availability is not inferred from this listing. See reference scope.

Bases: object. Declared members follow; inherited and dynamically attached members are not expanded.

Python identity wrapper; shared Rust handles own all semantic state.

Mobject.init

Mobject.__init__(self, color: Color=WHITE, name: str | None=None, dim: int=3, target: Mobject | None=None, z_index: float=0) -> None

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`Color`	`WHITE`
`name`	positional or keyword	`str \| None`	`None`
`dim`	positional or keyword	`int`	`3`
`target`	positional or keyword	`Mobject \| None`	`None`
`z_index`	positional or keyword	`float`	`0`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.submobjects

Mobject.submobjects(self)

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

Read direct children from Rust; use membership methods to edit them.

Source declaration

Mobject.submobjects

Mobject.submobjects(self, members)

Decorators: submobjects.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`members`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.add

Mobject.add(self, *mobjects)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobjects`	*args	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.add_to_back

Mobject.add_to_back(self, *mobjects)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobjects`	*args	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.insert

Mobject.insert(self, index, mobject)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`index`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.remove

Mobject.remove(self, *mobjects)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobjects`	*args	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_group_class

Mobject.get_group_class(self)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set

Mobject.set(self, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.interpolate_color

Mobject.interpolate_color(self, mobject1: Mobject, mobject2: Mobject, alpha: float) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject1`	positional or keyword	`Mobject`	`No default`
`mobject2`	positional or keyword	`Mobject`	`No default`
`alpha`	positional or keyword	`float`	`No default`

Return annotation: Mobject

Raise the pinned base-class override error for unsupported objects.

Source declaration

Mobject.interpolate

Mobject.interpolate(self, mobject1: Mobject, mobject2: Mobject, alpha: float, path_func: Callable[..., Any]=_default_mobject_path_func()) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject1`	positional or keyword	`Mobject`	`No default`
`mobject2`	positional or keyword	`Mobject`	`No default`
`alpha`	positional or keyword	`float`	`No default`
`path_func`	positional or keyword	`Callable[..., Any]`	`_default_mobject_path_func()`

Return annotation: Self

Interpolate supported VMobject geometry and style through shared Rust.

Source declaration

Mobject.point_from_proportion

Mobject.point_from_proportion(self, alpha: float) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`alpha`	positional or keyword	`float`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.proportion_from_point

Mobject.proportion_from_point(self, point: object) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`point`	positional or keyword	`object`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_point_mobject

Mobject.get_point_mobject(self, center: object | None=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`center`	positional or keyword	`object \| None`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.repeat_submobject

Mobject.repeat_submobject(self, submob: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`submob`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

Return an independent shared-semantic copy of ``submob``.

Source declaration

Mobject.align_points

Mobject.align_points(self, mobject: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.align_submobjects

Mobject.align_submobjects(self, mobject: Mobject) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.null_point_align

Mobject.null_point_align(self, mobject: Mobject) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.push_self_into_submobjects

Mobject.push_self_into_submobjects(self) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Self

Move own points to an appended child through shared Rust semantics.

Source declaration

Mobject.align_data

Mobject.align_data(self, mobject: Mobject, skip_point_alignment: bool=False) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`skip_point_alignment`	positional or keyword	`bool`	`False`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.align_points_with_larger

Mobject.align_points_with_larger(self, larger_mobject: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`larger_mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_mobject_type_class

Mobject.get_mobject_type_class()

Decorators: staticmethod

Parameter	Kind	Annotation	Default

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.animation_override_for

Mobject.animation_override_for(cls, animation_class: type[Any]) -> Callable[..., Any] | None

Decorators: classmethod

Parameter	Kind	Annotation	Default
`cls`	positional or keyword	`Not annotated`	`No default`
`animation_class`	positional or keyword	`type[Any]`	`No default`

Return annotation: Callable[..., Any] | None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.add_animation_override

Mobject.add_animation_override(cls, animation_class: type[Any], override_func: Callable[..., Any]) -> None

Decorators: classmethod

Parameter	Kind	Annotation	Default
`cls`	positional or keyword	`Not annotated`	`No default`
`animation_class`	positional or keyword	`type[Any]`	`No default`
`override_func`	positional or keyword	`Callable[..., Any]`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_default

Mobject.set_default(cls, **kwargs: Any) -> None

Decorators: classmethod

Parameter	Kind	Annotation	Default
`cls`	positional or keyword	`Not annotated`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: None

Change future Python constructor defaults, or restore this class's original constructor.

Source declaration

Mobject.geometry

Mobject.geometry(self) -> dict[str, Any]

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: dict[str, Any]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.transform

Mobject.transform(self) -> dict[str, Any]

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: dict[str, Any]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.style

Mobject.style(self) -> dict[str, Any]

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: dict[str, Any]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.id

Mobject.id(self) -> int

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: int

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.to_ir

Mobject.to_ir(self) -> dict[str, Any]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: dict[str, Any]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.copy

Mobject.copy(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_edge_center

Mobject.get_edge_center(self: Mobject, direction: object) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_corner

Mobject.get_corner(self: Mobject, direction: object) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_left

Mobject.get_left(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_right

Mobject.get_right(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_top

Mobject.get_top(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_bottom

Mobject.get_bottom(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_zenith

Mobject.get_zenith(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_nadir

Mobject.get_nadir(self: Mobject) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_coord

Mobject.get_coord(self: Mobject, dim: int, direction: object=ORIGIN) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`dim`	positional or keyword	`int`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_x

Mobject.get_x(self: Mobject, direction: object=ORIGIN) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_y

Mobject.get_y(self: Mobject, direction: object=ORIGIN) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_z

Mobject.get_z(self: Mobject, direction: object=ORIGIN) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.scale_to_fit_width

Mobject.scale_to_fit_width(self: Mobject, width: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`width`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.scale_to_fit_height

Mobject.scale_to_fit_height(self: Mobject, height: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`height`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.scale_to_fit_depth

Mobject.scale_to_fit_depth(self: Mobject, depth: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`depth`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.stretch

Mobject.stretch(self, factor: float, dim: int, *, about_point=None, about_edge=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`factor`	positional or keyword	`float`	`No default`
`dim`	positional or keyword	`int`	`No default`
`about_point`	keyword-only	`Not annotated`	`None`
`about_edge`	keyword-only	`Not annotated`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.stretch_about_point

Mobject.stretch_about_point(self, factor: float, dim: int, point: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`factor`	positional or keyword	`float`	`No default`
`dim`	positional or keyword	`int`	`No default`
`point`	positional or keyword	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.stretch_to_fit_width

Mobject.stretch_to_fit_width(self: Mobject, width: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`width`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.stretch_to_fit_height

Mobject.stretch_to_fit_height(self: Mobject, height: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`height`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.stretch_to_fit_depth

Mobject.stretch_to_fit_depth(self: Mobject, depth: float, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`depth`	positional or keyword	`float`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_width

Mobject.match_width(self: Mobject, mobject: Mobject, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_height

Mobject.match_height(self: Mobject, mobject: Mobject, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_depth

Mobject.match_depth(self: Mobject, mobject: Mobject, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Mobject`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.rescale_to_fit

Mobject.rescale_to_fit(self, length: float, dim: int, stretch: bool=False, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`length`	positional or keyword	`float`	`No default`
`dim`	positional or keyword	`int`	`No default`
`stretch`	positional or keyword	`bool`	`False`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_dim_size

Mobject.match_dim_size(self, mobject: Mobject, dim: int, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`dim`	positional or keyword	`int`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.generate_target

Mobject.generate_target(self, use_deepcopy: bool=False) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`use_deepcopy`	positional or keyword	`bool`	`False`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.save_state

Mobject.save_state(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.restore

Mobject.restore(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_color

Mobject.get_color(self) -> Color

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Color

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_family

Mobject.get_family(self, recurse: bool=True) -> list[Mobject]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recurse`	positional or keyword	`bool`	`True`

Return annotation: list[Mobject]

Return existing wrappers in shared family order, including this root.

Source declaration

Mobject.get_family_updaters

Mobject.get_family_updaters(self) -> list[Callable[..., Any]]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Callable[..., Any]]

Return each member's updaters in shared family order.

Source declaration

Mobject.split

Mobject.split(self) -> list[Mobject]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Mobject]

Return this point-owning object, if any, followed by direct children.

Source declaration

Mobject.family_members_with_points

Mobject.family_members_with_points(self) -> list[Mobject]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Mobject]

Return point-owning family members in the shared family order.

Source declaration

Mobject.reverse_points

Mobject.reverse_points(self) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Self

Reverse point order through the shared path and family operations.

Source declaration

Mobject.repeat

Mobject.repeat(self, count: int) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`count`	positional or keyword	`int`	`No default`

Return annotation: Self

Repeat supported point arrays through the shared path/family operation.

Source declaration

Mobject.space_out_submobjects

Mobject.space_out_submobjects(self, factor: float=1.5, **kwargs: Any) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`factor`	positional or keyword	`float`	`1.5`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Self

Expand the family, then shrink direct children through shared transforms.

Source declaration

Mobject.apply_to_family

Mobject.apply_to_family(self, func: Callable[[Mobject], None]) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`func`	positional or keyword	`Callable[[Mobject], None]`	`No default`

Return annotation: Mobject

Apply ``func`` to every point-owning member in shared family order.

Source declaration

Mobject.match_color

Mobject.match_color(self, mobject: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

Match the donor's observed color through the existing shared setter.

Source declaration

Mobject.to_original_color

Mobject.to_original_color(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

Apply this object's current color to its shared family.

Source declaration

Mobject.set_color_by_gradient

Mobject.set_color_by_gradient(self, *colors: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`colors`	*args	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_submobject_colors_by_gradient

Mobject.set_submobject_colors_by_gradient(self, *colors: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`colors`	*args	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_colors_by_radial_gradient

Mobject.set_colors_by_radial_gradient(self, center: object | None=None, radius: float=1, inner_color: object=WHITE, outer_color: object=BLACK) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`center`	positional or keyword	`object \| None`	`None`
`radius`	positional or keyword	`float`	`1`
`inner_color`	positional or keyword	`object`	`WHITE`
`outer_color`	positional or keyword	`object`	`BLACK`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_submobject_colors_by_radial_gradient

Mobject.set_submobject_colors_by_radial_gradient(self, center: object | None=None, radius: float=1, inner_color: object=WHITE, outer_color: object=BLACK) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`center`	positional or keyword	`object \| None`	`None`
`radius`	positional or keyword	`float`	`1`
`inner_color`	positional or keyword	`object`	`WHITE`
`outer_color`	positional or keyword	`object`	`BLACK`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_points

Mobject.match_points(self, mobject: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_center

Mobject.get_center(self) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_z_index_reference_point

Mobject.get_z_index_reference_point(self) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Any

Return the center of this object's z-index grouping target.

Source declaration

Mobject.get_start

Mobject.get_start(self) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Any

Return the first point of this object's path.

Source declaration

Mobject.get_end

Mobject.get_end(self) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Any

Return the last point of this object's path.

Source declaration

Mobject.get_start_and_end

Mobject.get_start_and_end(self) -> tuple[Any, Any]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: tuple[Any, Any]

Return the starting and ending point of this object's path.

Source declaration

Mobject.get_num_points

Mobject.get_num_points(self) -> int

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: int

Return the number of points in this object's path.

Source declaration

Mobject.invert

Mobject.invert(self, recursive: bool=False) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recursive`	positional or keyword	`bool`	`False`

Return annotation: Self

Reverse child order when this object has a family-aware wrapper.

Source declaration

Mobject.sort

Mobject.sort(self, point_to_num_func: Callable[[Point3DLike], float]=lambda point: point[0], submob_func: Callable[[Mobject], Any] | None=None) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`point_to_num_func`	positional or keyword	`Callable[[Point3DLike], float]`	`lambda point: point[0]`
`submob_func`	positional or keyword	`Callable[[Mobject], Any] \| None`	`None`

Return annotation: Self

Sort family-aware children; a bare point object has no children.

Source declaration

Mobject.sort_submobjects

Mobject.sort_submobjects(self, *args: Any, **kwargs: Any) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`args`	*args	`Any`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.shuffle

Mobject.shuffle(self, recursive: bool=False) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recursive`	positional or keyword	`bool`	`False`

Return annotation: Self

Shuffle children when this object has a family-aware wrapper.

Source declaration

Mobject.shuffle_submobjects

Mobject.shuffle_submobjects(self, *args: Any, **kwargs: Any) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`args`	*args	`Any`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.arrange

Mobject.arrange(self, direction: object=RIGHT, buff: float=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, center: bool=True, **kwargs: Any) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`direction`	positional or keyword	`object`	`RIGHT`
`buff`	positional or keyword	`float`	`DEFAULT_MOBJECT_TO_MOBJECT_BUFFER`
`center`	positional or keyword	`bool`	`True`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Self

Apply Manim's leaf-object arrangement behavior.

Family wrappers override this with shared Rust layout. A point-owning
leaf has no direct children, so its only arrangement effect is the
optional shared move to the origin.

Source declaration

Mobject.arrange_submobjects

Mobject.arrange_submobjects(self, *args: Any, **kwargs: Any) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`args`	*args	`Any`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.has_points

Mobject.has_points(self) -> bool

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.has_no_points

Mobject.has_no_points(self) -> bool

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.reset_points

Mobject.reset_points(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

Clear this object's authored points through the shared path editor.

Source declaration

Mobject.init_colors

Mobject.init_colors(self, propagate_colors: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`propagate_colors`	positional or keyword	`bool`	`True`

Return annotation: Mobject

Base color hook for concrete compatibility classes to override.

Source declaration

Mobject.generate_points

Mobject.generate_points(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

Base point hook for concrete compatibility classes to override.

Source declaration

Mobject.throw_error_if_no_points

Mobject.throw_error_if_no_points(self) -> None

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.nonempty_submobjects

Mobject.nonempty_submobjects(self) -> list[Mobject]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Mobject]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_all_points

Mobject.get_all_points(self)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

Return this object's and its family's authored point arrays.

Source declaration

Mobject.get_pieces

Mobject.get_pieces(self, n_pieces: float)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`n_pieces`	positional or keyword	`float`	`No default`

Return annotation: Not annotated

Split a vector leaf into equal curve-parameter pieces.

Path subdivision is delegated to shared VMobject operations and the
result uses Manim's base Group constructor.
Shared family roots are not supported by this path-only profile.

Source declaration

Mobject.set_points

Mobject.set_points(self, points)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`points`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

Assign this root's canonical point data through the shared Rust edit.

Source declaration

Mobject.get_array_attrs

Mobject.get_array_attrs(self) -> list[str]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[str]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.apply_over_attr_arrays

Mobject.apply_over_attr_arrays(self, func: Callable[[Any], Any]) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`func`	positional or keyword	`Callable[[Any], Any]`	`No default`

Return annotation: Self

Map this object's supported point array and publish it through Rust.

Source declaration

Mobject.apply_points_function_about_point

Mobject.apply_points_function_about_point(self, func: Callable[[Any], Any], about_point: object | None=None, about_edge: object | None=None) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`func`	positional or keyword	`Callable[[Any], Any]`	`No default`
`about_point`	positional or keyword	`object \| None`	`None`
`about_edge`	positional or keyword	`object \| None`	`None`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.apply_function

Mobject.apply_function(self, function: Callable[[Any], Any], *, about_point: object | None=None, about_edge: object | None=None) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`function`	positional or keyword	`Callable[[Any], Any]`	`No default`
`about_point`	keyword-only	`object \| None`	`None`
`about_edge`	keyword-only	`object \| None`	`None`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.apply_complex_function

Mobject.apply_complex_function(self, function: Callable[[complex], complex], *, about_point: object | None=None, about_edge: object | None=None) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`function`	positional or keyword	`Callable[[complex], complex]`	`No default`
`about_point`	keyword-only	`object \| None`	`None`
`about_edge`	keyword-only	`object \| None`	`None`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.apply_matrix

Mobject.apply_matrix(self, matrix: object, *, about_point: object | None=None, about_edge: object | None=None) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`matrix`	positional or keyword	`object`	`No default`
`about_point`	keyword-only	`object \| None`	`None`
`about_edge`	keyword-only	`object \| None`	`None`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_merged_array

Mobject.get_merged_array(self, array_attr: str)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`array_attr`	positional or keyword	`str`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_points_defining_boundary

Mobject.get_points_defining_boundary(self)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.width

Mobject.width(self) -> float

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.width

Mobject.width(self, value: float) -> None

Decorators: width.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`float`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.height

Mobject.height(self) -> float

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.height

Mobject.height(self, value: float) -> None

Decorators: height.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`float`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.depth

Mobject.depth(self) -> float

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.depth

Mobject.depth(self, value: float) -> None

Decorators: depth.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`float`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.shift

Mobject.shift(self, direction: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`direction`	positional or keyword	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.move_to

Mobject.move_to(self, point_or_mobject: object, *args: object, **kwargs: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`point_or_mobject`	positional or keyword	`object`	`No default`
`args`	*args	`object`	`No default`
`kwargs`	**kwargs	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.put_start_and_end_on

Mobject.put_start_and_end_on(self, start: object, end: object) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`start`	positional or keyword	`object`	`No default`
`end`	positional or keyword	`object`	`No default`

Return annotation: Self

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.center

Mobject.center(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.align_on_border

Mobject.align_on_border(self, direction: object, buff: float=DEFAULT_MOBJECT_TO_EDGE_BUFFER) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`direction`	positional or keyword	`object`	`No default`
`buff`	positional or keyword	`float`	`DEFAULT_MOBJECT_TO_EDGE_BUFFER`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.apply_function_to_position

Mobject.apply_function_to_position(self, function: Callable[[Any], Any]) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`function`	positional or keyword	`Callable[[Any], Any]`	`No default`

Return annotation: Self

Map the Rust-backed center and move this object to the result.

Source declaration

Mobject.apply_function_to_submobject_positions

Mobject.apply_function_to_submobject_positions(self, function: Callable[[Any], Any]) -> Self

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`function`	positional or keyword	`Callable[[Any], Any]`	`No default`

Return annotation: Self

Map each direct child's center using its Rust-backed placement.

Source declaration

Mobject.set_x

Mobject.set_x(self, x: float, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`x`	positional or keyword	`float`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_y

Mobject.set_y(self, y: float, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`y`	positional or keyword	`float`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_z

Mobject.set_z(self, z: float, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`z`	positional or keyword	`float`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

Keep planar objects on z=0; spatial z placement is unsupported.

Source declaration

Mobject.set_coord

Mobject.set_coord(self, value: float, dim: int, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`float`	`No default`
`dim`	positional or keyword	`int`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_coord

Mobject.match_coord(self, mobject: Mobject, dim: int, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`dim`	positional or keyword	`int`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_x

Mobject.match_x(self, mobject: Mobject, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_y

Mobject.match_y(self, mobject: Mobject, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_z

Mobject.match_z(self, mobject: Mobject, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.z_index

Mobject.z_index(self) -> float

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.z_index

Mobject.z_index(self, value: float) -> None

Decorators: z_index.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`float`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_z_index

Mobject.set_z_index(self, z_index_value: float, family: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`z_index_value`	positional or keyword	`float`	`No default`
`family`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_z_index_by_z_Point3D

Mobject.set_z_index_by_z_Point3D(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.flip

Mobject.flip(self, axis=UP, *, about_point=None, about_edge=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`axis`	positional or keyword	`Not annotated`	`UP`
`about_point`	keyword-only	`Not annotated`	`None`
`about_edge`	keyword-only	`Not annotated`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.rotate_about_origin

Mobject.rotate_about_origin(self, angle: float, axis: object=(0.0, 0.0, 1.0), **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`angle`	positional or keyword	`float`	`No default`
`axis`	positional or keyword	`object`	`(0.0, 0.0, 1.0)`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.scale

Mobject.scale(self, *args: object, **kwargs: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`args`	*args	`object`	`No default`
`kwargs`	**kwargs	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.rotate

Mobject.rotate(self, *args: object, **kwargs: object) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`args`	*args	`object`	`No default`
`kwargs`	**kwargs	`object`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_color

Mobject.set_color(self, color: object=Color(1.0, 1.0, 0.0), alpha: Any=None, family: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`object`	`Color(1.0, 1.0, 0.0)`
`alpha`	positional or keyword	`Any`	`None`
`family`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_glow

Mobject.set_glow(self, *, color=None, radius=None, intensity=None, source=None, scope=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	keyword-only	`Not annotated`	`None`
`radius`	keyword-only	`Not annotated`	`None`
`intensity`	keyword-only	`Not annotated`	`None`
`source`	keyword-only	`Not annotated`	`None`
`scope`	keyword-only	`Not annotated`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.add_effect

Mobject.add_effect(self, definition, *, name, scope=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`definition`	positional or keyword	`Not annotated`	`No default`
`name`	keyword-only	`Not annotated`	`No default`
`scope`	keyword-only	`Not annotated`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_effect

Mobject.get_effect(self, name)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`name`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_effect

Mobject.set_effect(self, selector, *, color=None, radius=None, intensity=None, source=None, offset=None, progress=None, softness=None, seed=None, size=None, parameters=None, threshold=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`selector`	positional or keyword	`Not annotated`	`No default`
`color`	keyword-only	`Not annotated`	`None`
`radius`	keyword-only	`Not annotated`	`None`
`intensity`	keyword-only	`Not annotated`	`None`
`source`	keyword-only	`Not annotated`	`None`
`offset`	keyword-only	`Not annotated`	`None`
`progress`	keyword-only	`Not annotated`	`None`
`softness`	keyword-only	`Not annotated`	`None`
`seed`	keyword-only	`Not annotated`	`None`
`size`	keyword-only	`Not annotated`	`None`
`parameters`	keyword-only	`Not annotated`	`None`
`threshold`	keyword-only	`Not annotated`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.remove_effect

Mobject.remove_effect(self, selector) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`selector`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.remove_glow

Mobject.remove_glow(self) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_fill_image_mapping

Mobject.set_fill_image_mapping(self, mapping, opacity=None)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mapping`	positional or keyword	`Not annotated`	`No default`
`opacity`	positional or keyword	`Not annotated`	`None`

Return annotation: Not annotated

Edit local image UVs through shared Rust publication without reading pixels.

Source declaration

Mobject.set_fill

Mobject.set_fill(self, color: Color | None=None, opacity: float | None=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`Color \| None`	`None`
`opacity`	positional or keyword	`float \| None`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_stroke

Mobject.set_stroke(self, color: Color | None=None, width: float | None=None) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`Color \| None`	`None`
`width`	positional or keyword	`float \| None`	`None`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_opacity

Mobject.set_opacity(self, opacity: float) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`opacity`	positional or keyword	`float`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.fade

Mobject.fade(self, darkness: float=0.5, family: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`darkness`	positional or keyword	`float`	`0.5`
`family`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.fade_to

Mobject.fade_to(self, color: Color, alpha: float, family: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`Color`	`No default`
`alpha`	positional or keyword	`float`	`No default`
`family`	positional or keyword	`bool`	`True`

Return annotation: Mobject

Interpolate this object's color toward ``color`` by ``alpha``.

Source declaration

Mobject.set_emission

Mobject.set_emission(self, strength: float) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`strength`	positional or keyword	`float`	`No default`

Return annotation: Mobject

Set checked linear-HDR material strength (0–63), independently of alpha.

Source declaration

Mobject.set_object_opacity

Mobject.set_object_opacity(self, opacity: float) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`opacity`	positional or keyword	`float`	`No default`

Return annotation: Mobject

Set whole-object opacity independently of fill/stroke paint alpha.

Source declaration

Mobject.next_to

Mobject.next_to(self, mobject_or_point: object, direction: object=RIGHT, buff: float=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, aligned_edge: object=ORIGIN, submobject_to_align: object | None=None, index_of_submobject_to_align: int | None=None, coor_mask: object=(1.0, 1.0, 1.0)) -> Mobject | Group

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject_or_point`	positional or keyword	`object`	`No default`
`direction`	positional or keyword	`object`	`RIGHT`
`buff`	positional or keyword	`float`	`DEFAULT_MOBJECT_TO_MOBJECT_BUFFER`
`aligned_edge`	positional or keyword	`object`	`ORIGIN`
`submobject_to_align`	positional or keyword	`object \| None`	`None`
`index_of_submobject_to_align`	positional or keyword	`int \| None`	`None`
`coor_mask`	positional or keyword	`object`	`(1.0, 1.0, 1.0)`

Return annotation: Mobject | Group

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.align_to

Mobject.align_to(self, mobject_or_point: object, direction: object=ORIGIN) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject_or_point`	positional or keyword	`object`	`No default`
`direction`	positional or keyword	`object`	`ORIGIN`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.shift_onto_screen

Mobject.shift_onto_screen(self, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.is_off_screen

Mobject.is_off_screen(self) -> bool

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.to_edge

Mobject.to_edge(self, edge: Vec2 | tuple[float, float]=LEFT, buff: float=DEFAULT_MOBJECT_TO_EDGE_BUFFER) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`edge`	positional or keyword	`Vec2 \| tuple[float, float]`	`LEFT`
`buff`	positional or keyword	`float`	`DEFAULT_MOBJECT_TO_EDGE_BUFFER`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.to_corner

Mobject.to_corner(self, corner: Vec2 | tuple[float, float]=DL, buff: float=DEFAULT_MOBJECT_TO_EDGE_BUFFER) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`corner`	positional or keyword	`Vec2 \| tuple[float, float]`	`DL`
`buff`	positional or keyword	`float`	`DEFAULT_MOBJECT_TO_EDGE_BUFFER`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.animate

Mobject.animate(self)

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.always

Mobject.always(self)

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Not annotated

Build immediate, repeatedly invoked updater calls like ManimCE.

Source declaration

Mobject.add_updater

Mobject.add_updater(self, update_function: Callable[..., Any], index: int | None=None, call_updater: bool=False) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`update_function`	positional or keyword	`Callable[..., Any]`	`No default`
`index`	positional or keyword	`int \| None`	`None`
`call_updater`	positional or keyword	`bool`	`False`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.set_effective_circle

Mobject.set_effective_circle(self, radius: float) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`radius`	positional or keyword	`float`	`No default`

Return annotation: Mobject

Replace this callback target's effective circle without editing authored content.

This first producer is supported only by the last updater in an ordered
callback phase. A later region cannot yet read the new geometry.

Source declaration

Mobject.set_effective_path

Mobject.set_effective_path(self, points: list[tuple[float, float]], closed: bool=False) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`points`	positional or keyword	`list[tuple[float, float]]`	`No default`
`closed`	positional or keyword	`bool`	`False`

Return annotation: Mobject

Replace this callback target's effective content with a polygonal path.

Path output is limited to a finite list of at least two points and must
be produced by the final updater in its callback phase.

Source declaration

Mobject.set_effective_text

Mobject.set_effective_text(self, source: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`source`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

Replace callback-effective content with a prebuilt Text resource.

Source declaration

Mobject.remove_updater

Mobject.remove_updater(self, update_function: Callable[..., Any]) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`update_function`	positional or keyword	`Callable[..., Any]`	`No default`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.clear_updaters

Mobject.clear_updaters(self, recursive: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recursive`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_updaters

Mobject.get_updaters(self) -> list[Callable[..., Any]]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Callable[..., Any]]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_time_based_updaters

Mobject.get_time_based_updaters(self) -> list[Callable[..., Any]]

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: list[Callable[..., Any]]

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.has_time_based_updater

Mobject.has_time_based_updater(self) -> bool

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.match_updaters

Mobject.match_updaters(self, mobject: Mobject) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`

Return annotation: Mobject

Clear this family, then copy only the donor root's callbacks.

Source declaration

Mobject.updating_suspended

Mobject.updating_suspended(self) -> bool

Decorators: property

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.updating_suspended

Mobject.updating_suspended(self, value: object) -> None

Decorators: updating_suspended.setter

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`value`	positional or keyword	`object`	`No default`

Return annotation: None

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.suspend_updating

Mobject.suspend_updating(self, recursive: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recursive`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.resume_updating

Mobject.resume_updating(self, recursive: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`recursive`	positional or keyword	`bool`	`True`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.update

Mobject.update(self, dt: float=0, recursive: bool=True) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`dt`	positional or keyword	`float`	`0`
`recursive`	positional or keyword	`bool`	`True`

Return annotation: Mobject

Invoke detached-object updaters; live updates belong to Rust phases.

Source declaration

Mobject.has_updaters

Mobject.has_updaters(self) -> bool

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: bool

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_critical_point

Mobject.get_critical_point(self, direction: object) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`direction`	positional or keyword	`object`	`No default`

Return annotation: Any

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_extremum_along_dim

Mobject.get_extremum_along_dim(self, points=None, dim: int=0, key: int=0)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`points`	positional or keyword	`Not annotated`	`None`
`dim`	positional or keyword	`int`	`0`
`key`	positional or keyword	`int`	`0`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.reduce_across_dimension

Mobject.reduce_across_dimension(self, reduce_func: Callable[[Any], Any], dim: int)

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`reduce_func`	positional or keyword	`Callable[[Any], Any]`	`No default`
`dim`	positional or keyword	`int`	`No default`

Return annotation: Not annotated

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_center_of_mass

Mobject.get_center_of_mass(self) -> Vec2

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Vec2

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.length_over_dim

Mobject.length_over_dim(self, dim: int) -> float

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`dim`	positional or keyword	`int`	`No default`

Return annotation: float

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_boundary_point

Mobject.get_boundary_point(self, direction: object) -> Vec2

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`direction`	positional or keyword	`object`	`No default`

Return annotation: Vec2

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.get_midpoint

Mobject.get_midpoint(self) -> Vec2

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`

Return annotation: Vec2

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.become

Mobject.become(self, mobject: Mobject, match_height: bool=False, match_width: bool=False, match_depth: bool=False, match_center: bool=False, stretch: bool=False) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`match_height`	positional or keyword	`bool`	`False`
`match_width`	positional or keyword	`bool`	`False`
`match_depth`	positional or keyword	`bool`	`False`
`match_center`	positional or keyword	`bool`	`False`
`stretch`	positional or keyword	`bool`	`False`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.replace

Mobject.replace(self, mobject: Mobject, dim_to_match: int=0, stretch: bool=False) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`dim_to_match`	positional or keyword	`int`	`0`
`stretch`	positional or keyword	`bool`	`False`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.surround

Mobject.surround(self, mobject: Mobject, dim_to_match: int=0, stretch: bool=False, buff: float=MED_SMALL_BUFF) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`Mobject`	`No default`
`dim_to_match`	positional or keyword	`int`	`0`
`stretch`	positional or keyword	`bool`	`False`
`buff`	positional or keyword	`float`	`MED_SMALL_BUFF`

Return annotation: Mobject

No docstring declared here. Consult the source and host reference.

Source declaration

Mobject.add_background_rectangle

Mobject.add_background_rectangle(self, color: object | None=None, opacity: float=0.75, **kwargs: Any) -> Mobject

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`color`	positional or keyword	`object \| None`	`None`
`opacity`	positional or keyword	`float`	`0.75`
`kwargs`	**kwargs	`Any`	`No default`

Return annotation: Mobject

Prepend a shared BackgroundRectangle to a family-backed object.

The public base API assumes every Mobject owns a mutable submobject
list. Noon currently represents that capability with shared Group and
VGroup family handles, so bare geometry objects are rejected before
constructing or publishing a rectangle.

Source declaration

Built from c38234c88a34 · View source · Back to top