ouster.sdk.viz.widgets module¶

class Toggle(viz, item, initially_visible=False)[source]¶

Bases: object

Parameters:

viz (PointViz)
item (Any)
initially_visible (bool)

hide()[source]¶

show()[source]¶

toggle()[source]¶

property visible: bool¶

class ToggleImage(viz, initially_visible=False)[source]¶

Bases: Toggle

This class encapsulates properties of an image, such as whether it is visible in the supplied PointViz instance. This makes up for a deficiency in PointViz which requires that API users remember whether a widget has been added or not.

Parameters:

viz (PointViz)
initially_visible (bool)

set_image(image)[source]¶

Parameters:: image (ndarray)

property hshift¶

property position¶

class ToggleLabel(viz, initial_text, initial_position, initially_visible=False, align_right=False, align_top=False)[source]¶

Bases: Toggle

This class encapsulates properties of a label, such as whether it is visible in the supplied PointViz instance. This makes up for a deficiency in PointViz which requires that API users remember whether a widget has been added or not.

Parameters:

viz (PointViz)
initial_text (str)
initial_position (Tuple[float, float] | Tuple[float, float, float])
initially_visible (bool)
align_right (bool)
align_top (bool)

property text¶

property scale¶

property position¶

property text_height¶

property rgba¶

class ToggleMesh(viz, mesh, initially_visible=False)[source]¶

Bases: Toggle

Parameters:

viz (PointViz)
mesh (Mesh)
initially_visible (bool)

class ToggleCloud(viz, cloud, initially_visible=False)[source]¶

Bases: Toggle

Parameters:

viz (PointViz)
cloud (Cloud)
initially_visible (bool)