Object
from noon import Object
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.
Object.__init__
Object.__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.
Object.submobjects
Object.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.
Object.submobjects
Object.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.
Object.add
Object.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.
Object.add_to_back
Object.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.
Object.insert
Object.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.
Object.remove
Object.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.
Object.get_group_class
Object.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.
Object.set
Object.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.
Object.interpolate_color
Object.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.
Object.interpolate
Object.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.
Object.point_from_proportion
Object.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.
Object.proportion_from_point
Object.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.
Object.get_point_mobject
Object.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.
Object.repeat_submobject
Object.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``.
Object.align_points
Object.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.
Object.align_submobjects
Object.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.
Object.null_point_align
Object.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.
Object.push_self_into_submobjects
Object.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.
Object.align_data
Object.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.
Object.align_points_with_larger
Object.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.
Object.get_mobject_type_class
Object.get_mobject_type_class()Decorators: staticmethod
| Parameter | Kind | Annotation | Default |
|---|
Return annotation: Not annotated
No docstring declared here. Consult the source and host reference.
Object.animation_override_for
Object.animation_override_for(cls, animation_class: type[Any]) -> Callable[..., Any] | NoneDecorators: 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.
Object.add_animation_override
Object.add_animation_override(cls, animation_class: type[Any], override_func: Callable[..., Any]) -> NoneDecorators: 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.
Object.set_default
Object.set_default(cls, **kwargs: Any) -> NoneDecorators: 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.
Object.geometry
Object.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.
Object.transform
Object.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.
Object.style
Object.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.
Object.id
Object.id(self) -> intDecorators: 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.
Object.to_ir
Object.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.
Object.copy
Object.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.
Object.get_edge_center
Object.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.
Object.get_corner
Object.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.
Object.get_left
Object.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.
Object.get_right
Object.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.
Object.get_top
Object.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.
Object.get_bottom
Object.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.
Object.get_zenith
Object.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.
Object.get_nadir
Object.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.
Object.get_coord
Object.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.
Object.get_x
Object.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.
Object.get_y
Object.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.
Object.get_z
Object.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.
Object.scale_to_fit_width
Object.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.
Object.scale_to_fit_height
Object.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.
Object.scale_to_fit_depth
Object.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.
Object.stretch
Object.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.
Object.stretch_about_point
Object.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.
Object.stretch_to_fit_width
Object.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.
Object.stretch_to_fit_height
Object.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.
Object.stretch_to_fit_depth
Object.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.
Object.match_width
Object.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.
Object.match_height
Object.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.
Object.match_depth
Object.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.
Object.rescale_to_fit
Object.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.
Object.match_dim_size
Object.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.
Object.generate_target
Object.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.
Object.save_state
Object.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.
Object.restore
Object.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.
Object.get_color
Object.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.
Object.get_family
Object.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.
Object.get_family_updaters
Object.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.
Object.split
Object.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.
Object.family_members_with_points
Object.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.
Object.reverse_points
Object.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.
Object.repeat
Object.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.
Object.space_out_submobjects
Object.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.
Object.apply_to_family
Object.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.
Object.match_color
Object.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.
Object.to_original_color
Object.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.
Object.set_color_by_gradient
Object.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.
Object.set_submobject_colors_by_gradient
Object.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.
Object.set_colors_by_radial_gradient
Object.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.
Object.set_submobject_colors_by_radial_gradient
Object.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.
Object.match_points
Object.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.
Object.get_center
Object.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.
Object.get_z_index_reference_point
Object.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.
Object.get_start
Object.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.
Object.get_end
Object.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.
Object.get_start_and_end
Object.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.
Object.get_num_points
Object.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.
Object.invert
Object.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.
Object.sort
Object.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.
Object.sort_submobjects
Object.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.
Object.shuffle
Object.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.
Object.shuffle_submobjects
Object.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.
Object.arrange
Object.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.
Object.arrange_submobjects
Object.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.
Object.has_points
Object.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.
Object.has_no_points
Object.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.
Object.reset_points
Object.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.
Object.init_colors
Object.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.
Object.generate_points
Object.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.
Object.throw_error_if_no_points
Object.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.
Object.nonempty_submobjects
Object.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.
Object.get_all_points
Object.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.
Object.get_pieces
Object.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.
Object.set_points
Object.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.
Object.get_array_attrs
Object.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.
Object.apply_over_attr_arrays
Object.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.
Object.apply_points_function_about_point
Object.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.
Object.apply_function
Object.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.
Object.apply_complex_function
Object.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.
Object.apply_matrix
Object.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.
Object.get_merged_array
Object.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.
Object.get_points_defining_boundary
Object.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.
Object.width
Object.width(self) -> floatDecorators: 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.
Object.width
Object.width(self, value: float) -> NoneDecorators: 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.
Object.height
Object.height(self) -> floatDecorators: 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.
Object.height
Object.height(self, value: float) -> NoneDecorators: 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.
Object.depth
Object.depth(self) -> floatDecorators: 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.
Object.depth
Object.depth(self, value: float) -> NoneDecorators: 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.
Object.shift
Object.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.
Object.move_to
Object.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.
Object.put_start_and_end_on
Object.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.
Object.center
Object.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.
Object.align_on_border
Object.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.
Object.apply_function_to_position
Object.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.
Object.apply_function_to_submobject_positions
Object.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.
Object.set_x
Object.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.
Object.set_y
Object.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.
Object.set_z
Object.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.
Object.set_coord
Object.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.
Object.match_coord
Object.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.
Object.match_x
Object.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.
Object.match_y
Object.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.
Object.match_z
Object.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.
Object.z_index
Object.z_index(self) -> floatDecorators: 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.
Object.z_index
Object.z_index(self, value: float) -> NoneDecorators: 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.
Object.set_z_index
Object.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.
Object.set_z_index_by_z_Point3D
Object.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.
Object.flip
Object.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.
Object.rotate_about_origin
Object.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.
Object.scale
Object.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.
Object.rotate
Object.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.
Object.set_color
Object.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.
Object.set_glow
Object.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.
Object.add_effect
Object.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.
Object.get_effect
Object.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.
Object.set_effect
Object.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.
Object.remove_effect
Object.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.
Object.remove_glow
Object.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.
Object.set_fill_image_mapping
Object.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.
Object.set_fill
Object.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.
Object.set_stroke
Object.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.
Object.set_opacity
Object.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.
Object.fade
Object.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.
Object.fade_to
Object.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``.
Object.set_emission
Object.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.
Object.set_object_opacity
Object.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.
Object.next_to
Object.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.
Object.align_to
Object.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.
Object.shift_onto_screen
Object.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.
Object.is_off_screen
Object.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.
Object.to_edge
Object.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.
Object.to_corner
Object.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.
Object.animate
Object.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.
Object.always
Object.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.
Object.add_updater
Object.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.
Object.set_effective_circle
Object.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.
Object.set_effective_path
Object.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.
Object.set_effective_text
Object.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.
Object.remove_updater
Object.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.
Object.clear_updaters
Object.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.
Object.get_updaters
Object.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.
Object.get_time_based_updaters
Object.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.
Object.has_time_based_updater
Object.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.
Object.match_updaters
Object.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.
Object.updating_suspended
Object.updating_suspended(self) -> boolDecorators: 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.
Object.updating_suspended
Object.updating_suspended(self, value: object) -> NoneDecorators: 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.
Object.suspend_updating
Object.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.
Object.resume_updating
Object.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.
Object.update
Object.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.
Object.has_updaters
Object.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.
Object.get_critical_point
Object.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.
Object.get_extremum_along_dim
Object.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.
Object.reduce_across_dimension
Object.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.
Object.get_center_of_mass
Object.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.
Object.length_over_dim
Object.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.
Object.get_boundary_point
Object.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.
Object.get_midpoint
Object.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.
Object.become
Object.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.
Object.replace
Object.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.
Object.surround
Object.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.
Object.add_background_rectangle
Object.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.