pynaviz.controller

The controller class.

Classes

CustomController([camera, enabled, damping, ...])
GetController([camera, enabled, ...])	The class for grabbing a single time point
SpanController([camera, enabled, damping, ...])	The class for horizontal time-panning
SpanYLockController(*args, **kwargs)

class pynaviz.controller.CustomController(camera: Camera | None = None, *, enabled=True, damping: int = 0, auto_update: bool = True, renderer: Viewport | Renderer | None = None, controller_id: int | None = None, dict_sync_funcs: dict[Callable] | None = None)

Bases: ABC, PanZoomController

property controller_id

get_xlim()

Return the current x boundaries

set_view(xmin: float, xmax: float, ymin: float, ymax: float)

Set the visible X and Y ranges for an OrthographicCamera.

set_xlim(xmin: float, xmax: float)

Set the visible X range for an OrthographicCamera. #TODO THIS SHOULD DEPEND ON THE CURRENT SYNC STATUS

set_ylim(ymin: float, ymax: float)

Set the visible Y range for an OrthographicCamera.

abstractmethod sync(event)

class pynaviz.controller.GetController(camera: Camera | None = None, *, enabled=True, auto_update: bool = True, renderer: Viewport | Renderer | None = None, controller_id: int | None = None, data: Any | None = None, buffer: Buffer = None, callback: Callable | None = None)

Bases: CustomController

The class for grabbing a single time point

property frame_index

set_frame(target_time: float)

Set the frame to target time.

Parameters:

target_time – A time point.

sync(event)

Get a new data point and update the texture

class pynaviz.controller.SpanController(camera: Camera | None = None, *, enabled: object = True, damping: int = 0, auto_update: bool = True, renderer: Viewport | Renderer | None = None, controller_id: int | None = None, dict_sync_funcs: dict[Callable] | None = None, plot_callbacks: dict[Callable] | None = None)

Bases: CustomController

The class for horizontal time-panning

sync(event)

Set a new camera state using the sync rule provided.

class pynaviz.controller.SpanYLockController(*args, **kwargs)

Bases: SpanController