Python API display

A small reference specimen showing Python types, aliases, and callable APIs.

Generated by Python Autodoc. Types link to local definitions; signatures retain annotations and defaults without importing this module.

`Vector3`

named tuplereference_demo.Vector3Source ↗

Vector3(x: float, y: float, z: float = 0.0)

Bases: NamedTuple

A position in three-dimensional space.

Parameters

Attributes

Name	Type / value	Description
`x`	`float`	Horizontal coordinate, in meters.
`y`	`float`	Vertical coordinate, in meters.
`z`	`float = 0.0`	Depth coordinate, in meters.

classreference_demo.SceneSource ↗

Scene(name: str, *, origin: Vector3 | None = None)

A named scene with typed spatial coordinates.

Parameters

Parameter	Type / default	Description
`name`	`str` required	Display name for the scene.
`origin`	`Vector3 \| None` = None	Initial position, or None for the default origin.

Attributes

Name	Type / value	Description
`visible`	`bool = True`	Whether the scene is visible.

methodreference_demo.Scene.__init__Source ↗

Scene.__init__(name: str, *, origin: Vector3 | None = None)

Parameters

Parameter	Type / default	Description
`name`	`str` required	—
`origin`	`Vector3 \| None` = None	Keyword-only parameter.

propertyreference_demo.Scene.originSource ↗

Scene.origin: Vector3

The current position of the scene.

Type

methodreference_demo.Scene.moveSource ↗

Scene.move(position: Vector3, /, *, relative: bool = False) → Vector3

Move the scene and return its new origin.

Parameters

Parameter	Type / default	Description
`position`	`Vector3` positional-only	Target position in meters.
`relative`	`bool` = False	Interpret the position relative to the current origin.

Returns

Vector3 — The resulting scene origin.

async methodreference_demo.Scene.subscribeSource ↗

async Scene.subscribe(handler: EventHandler, *, timeout: float = 30.0) → None

Receive position updates asynchronously.

Parameters

Parameter	Type / default	Description
`handler`	`EventHandler` required	Callback invoked for each update.
`timeout`	`float` = 30.0	Maximum wait in seconds.

Returns

None

Raises

type aliasreference_demo.EventHandlerSource ↗

EventHandler = Callable[[Vector3], None]

A callback receiving a position update.