On this page

Scene

from noon import Scene

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 authoring facade; semantic operations require the shared Rust host.

Scene.init

Scene.__init__(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

Scene.setup

Scene.setup(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

Scene.construct

Scene.construct(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

Scene.tear_down

Scene.tear_down(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

Scene.mobjects

Scene.mobjects(self) -> list[object]

Decorators: property

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

Return annotation: list[object]

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

Source declaration

Scene.foreground_mobjects

Scene.foreground_mobjects(self) -> list[object]

Decorators: property

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

Return annotation: list[object]

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

Source declaration

Scene.add

Scene.add(self, *mobjects: object, key: str | None=None) -> Mobject | Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobjects`	*args	`object`	`No default`
`key`	keyword-only	`str \| None`	`None`

Return annotation: Mobject | Scene

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

Source declaration

Scene.add_foreground_mobjects

Scene.add_foreground_mobjects(self, *mobjects: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.add_foreground_mobject

Scene.add_foreground_mobject(self, mobject: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.remove_foreground_mobjects

Scene.remove_foreground_mobjects(self, *mobjects: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.remove_foreground_mobject

Scene.remove_foreground_mobject(self, mobject: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.bring_to_front

Scene.bring_to_front(self, *mobjects: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.bring_to_back

Scene.bring_to_back(self, *mobjects: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.remove

Scene.remove(self, *mobjects: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.clear

Scene.clear(self) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.replace

Scene.replace(self, old_mobject: object, new_mobject: object) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.play

Scene.play(self, *args, **kwargs) -> Any

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

Return annotation: Any

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

Source declaration

Scene.wait

Scene.wait(self, duration: float=1.0) -> Any

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

Return annotation: Any

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

Source declaration

Scene.declare_wait

Scene.declare_wait(self, duration: float=1.0) -> Scene

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

Return annotation: Scene

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

Source declaration

Scene.declare_value

Scene.declare_value(self, tracker: object, target: float, *, run_time: float=1.0, rate_func: object='smooth') -> Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`tracker`	positional or keyword	`object`	`No default`
`target`	positional or keyword	`float`	`No default`
`run_time`	keyword-only	`float`	`1.0`
`rate_func`	keyword-only	`object`	`'smooth'`

Return annotation: Scene

Predeclare a scalar interval on the shared Rust authoring cursor.

Use with Scene.value_tracker/bind_position before playback. This is an
explicit finite declaration, not a Scene.play continuation barrier.

Source declaration

Scene.audio

Scene.audio(self, source: object, *, start_time: float=0.0, source_start_frame: int=0, source_end_frame: int | None=None, duration: float | None=None, loop: bool=False, gain: float=1.0, fade_in: float=0.0, fade_out: float=0.0) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`source`	positional or keyword	`object`	`No default`
`start_time`	keyword-only	`float`	`0.0`
`source_start_frame`	keyword-only	`int`	`0`
`source_end_frame`	keyword-only	`int \| None`	`None`
`duration`	keyword-only	`float \| None`	`None`
`loop`	keyword-only	`bool`	`False`
`gain`	keyword-only	`float`	`1.0`
`fade_in`	keyword-only	`float`	`0.0`
`fade_out`	keyword-only	`float`	`0.0`

Return annotation: Any

Declare a finite PCM clip before execution without advancing time.

Times are authored seconds; start_time is absolute and defaults to zero.
Source trims are half-open PCM frame indices. A loop requires duration;
fades apply once across the clip, including repeated source regions.

Source declaration

Scene.on_click_playback

Scene.on_click_playback(self, target: Mobject, action: object) -> Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`target`	positional or keyword	`Mobject`	`No default`
`action`	positional or keyword	`object`	`No default`

Return annotation: Scene

Declare a finite viewer control through the normal shared Rust picker.

Source declaration

Scene.time

Scene.time(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

Scene.next_section

Scene.next_section(self, name: str='', type: SectionType=SectionType.NORMAL) -> Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`name`	positional or keyword	`str`	`''`
`type`	positional or keyword	`SectionType`	`SectionType.NORMAL`

Return annotation: Scene

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

Source declaration

Scene.sections

Scene.sections(self) -> list[dict[str, object]]

Decorators: property

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

Return annotation: list[dict[str, object]]

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

Source declaration

Scene.value_tracker

Scene.value_tracker(self, value: float=0.0) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_position

Scene.bind_position(self, mobject: object, tracker: object, direction: object=None, offset: object=None) -> Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`mobject`	positional or keyword	`object`	`No default`
`tracker`	positional or keyword	`object`	`No default`
`direction`	positional or keyword	`object`	`None`
`offset`	positional or keyword	`object`	`None`

Return annotation: Scene

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

Source declaration

Scene.on_click

Scene.on_click(self, target: Mobject, animation: object) -> Scene

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`target`	positional or keyword	`Mobject`	`No default`
`animation`	positional or keyword	`object`	`No default`

Return annotation: Scene

Bind Indicate(target), GlowPulse(target), or None to a primary click.

Filled circles and rectangles use the shared Rust input path. None clears
the action; registration does not start it. Clicks during that target's
effect are ignored. Completion restores its owned channels while script
time stays unchanged. No Python callback or captured attachment is kept.

Source declaration

Scene.set_drag_targets

Scene.set_drag_targets(self, *mobjects: Mobject) -> Scene

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

Return annotation: Scene

Allow primary native translation dragging for these bound Mobjects.

Rust owns picking, capture, effective writes, authored reconciliation,
and cancellation. This declaration only selects semantic handles.

Source declaration

Scene.pointer_position_signal

Scene.pointer_position_signal(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

Scene.pointer_button_signal

Scene.pointer_button_signal(self, button: int=0, initial: bool=False) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`button`	positional or keyword	`int`	`0`
`initial`	positional or keyword	`bool`	`False`

Return annotation: Any

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

Source declaration

Scene.key_state_signal

Scene.key_state_signal(self, code: str, initial: bool=False) -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`code`	positional or keyword	`str`	`No default`
`initial`	positional or keyword	`bool`	`False`

Return annotation: Any

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

Source declaration

Scene.viewport_size_signal

Scene.viewport_size_signal(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

Scene.wheel_delta_signal

Scene.wheel_delta_signal(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

Scene.gesture_delta_signal

Scene.gesture_delta_signal(self, name: str) -> Any

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

Return annotation: Any

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

Source declaration

Scene.control_signal

Scene.control_signal(self, name: str, value: float=0.0) -> Any

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

Return annotation: Any

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

Source declaration

Scene.pointer_down_events

Scene.pointer_down_events(self, button: int=0) -> Any

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

Return annotation: Any

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

Source declaration

Scene.pointer_up_events

Scene.pointer_up_events(self, button: int=0) -> Any

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

Return annotation: Any

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

Source declaration

Scene.key_press_events

Scene.key_press_events(self, code: str) -> Any

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

Return annotation: Any

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

Source declaration

Scene.key_release_events

Scene.key_release_events(self, code: str) -> Any

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

Return annotation: Any

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

Source declaration

Scene.wheel_events

Scene.wheel_events(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

Scene.gesture_events

Scene.gesture_events(self, name: str) -> Any

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

Return annotation: Any

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

Source declaration

Scene.control_commit_events

Scene.control_commit_events(self, name: str) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_rotation

Scene.bind_rotation(self, mobject: object, tracker: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_opacity

Scene.bind_opacity(self, mobject: object, tracker: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_presence

Scene.bind_presence(self, mobject: object, signal: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_appearance

Scene.bind_appearance(self, mobject: object, tracker: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_reveal

Scene.bind_reveal(self, mobject: object, tracker: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.bind_morph

Scene.bind_morph(self, mobject: object, tracker: object) -> Any

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

Return annotation: Any

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

Source declaration

Scene.live_execution

Scene.live_execution(self, duration: float | None=None) -> Any

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

Return annotation: Any

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

Source declaration

Scene.declare_live_transform_to

Scene.declare_live_transform_to(self, source: Mobject, target: Mobject, *, run_time: float=1.0, rate_func: object='smooth') -> Any

Parameter	Kind	Annotation	Default
`self`	positional or keyword	`Not annotated`	`No default`
`source`	positional or keyword	`Mobject`	`No default`
`target`	positional or keyword	`Mobject`	`No default`
`run_time`	keyword-only	`float`	`1.0`
`rate_func`	keyword-only	`object`	`'smooth'`

Return annotation: Any

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

Source declaration

Built from c38234c88a34 · View source · Back to top