_viewer

Module Contents

Classes

Viewer

An abstract viewer class, enabling the rendering of simulations.

class Viewer

Bases: abc.ABC

An abstract viewer class, enabling the rendering of simulations.

abstract property view_port: Any

Get the viewport.

Returns:

The viewport object.

abstract property context: Any

Return the viewer context.

Returns:

The context object.

abstract property can_record: bool

Check if this viewer can record.

Returns:

The truth.

abstract close_viewer() → None

Close the viewer.

abstract render() → Any | None

Render the scene on the viewer.

Returns:

Nothing or feedback.

abstract current_viewport_size() → tuple[int, int]

Get the current viewport size.

Returns:

The size as a tuple.