cloudViewer.visualization.ViewControl#

class cloudViewer.visualization.ViewControl#

View controller for visualizer.

__init__(self: cloudViewer.visualization.ViewControl) → None#

Default constructor

camera_local_rotate(self: cloudViewer.visualization.ViewControl, x: SupportsFloat, y: SupportsFloat, xo: SupportsFloat = 0.0, yo: SupportsFloat = 0.0) → None#

Function to process rotation of camera in a localcoordinate frame

camera_local_translate(self: cloudViewer.visualization.ViewControl, forward: SupportsFloat, right: SupportsFloat, up: SupportsFloat) → None#

Function to process translation of camera

change_field_of_view(self, step=0.45)#

Function to change field of view

Parameters:

step (SupportsFloat, optional, default=0.45) – The step to change field of view.

Returns:

None

convert_from_pinhole_camera_parameters(self, parameter, allow_arbitrary=False)#
Parameters:
Returns:

bool

convert_to_pinhole_camera_parameters(self)#

Function to convert ViewControl to camera::PinholeCameraParameters

Returns:

cloudViewer.camera.PinholeCameraParameters

get_field_of_view(self)#

Function to get field of view

Returns:

float

reset_camera_local_rotate(self: cloudViewer.visualization.ViewControl) → None#

Resets the coordinate frame for local camera rotations

rotate(self, x, y, xo=0.0, yo=0.0)#

Function to process rotation

Parameters:

  • x (SupportsFloat) – Distance the mouse cursor has moved in x-axis.

  • y (SupportsFloat) – Distance the mouse cursor has moved in y-axis.

  • xo (SupportsFloat, optional, default=0.0) – Original point coordinate of the mouse in x-axis.

  • yo (SupportsFloat, optional, default=0.0) – Original point coordinate of the mouse in y-axis.

Returns:

None

scale(self, scale)#

Function to process scaling

Parameters:

scale (SupportsFloat) – Scale ratio.

Returns:

None

set_constant_z_far(self, z_far)#

Function to change the far z-plane of the visualizer to a constant value, i.e., independent of zoom and bounding box size.

Parameters:

z_far (SupportsFloat) – The depth of the far z-plane of the visualizer.

Returns:

None

set_constant_z_near(self, z_near)#

Function to change the near z-plane of the visualizer to a constant value, i.e., independent of zoom and bounding box size.

Parameters:

z_near (SupportsFloat) – The depth of the near z-plane of the visualizer.

Returns:

None

set_front(self: cloudViewer.visualization.ViewControl, front: Annotated[numpy.typing.ArrayLike, numpy.float64, '[3, 1]']) → None#

Set the front vector of the visualizer

set_lookat(self: cloudViewer.visualization.ViewControl, lookat: Annotated[numpy.typing.ArrayLike, numpy.float64, '[3, 1]']) → None#

Set the lookat vector of the visualizer

set_up(self: cloudViewer.visualization.ViewControl, up: Annotated[numpy.typing.ArrayLike, numpy.float64, '[3, 1]']) → None#

Set the up vector of the visualizer

set_zoom(self: cloudViewer.visualization.ViewControl, zoom: SupportsFloat) → None#

Set the zoom of the visualizer

translate(self, x, y, xo=0.0, yo=0.0)#

Function to process translation

Parameters:

  • x (SupportsFloat) – Distance the mouse cursor has moved in x-axis.

  • y (SupportsFloat) – Distance the mouse cursor has moved in y-axis.

  • xo (SupportsFloat, optional, default=0.0) – Original point coordinate of the mouse in x-axis.

  • yo (SupportsFloat, optional, default=0.0) – Original point coordinate of the mouse in y-axis.

Returns:

None

unset_constant_z_far(self)#

Function to remove a previously set constant z far value, i.e., far z-plane of the visualizer is dynamically set dependent on zoom and bounding box size.

Returns:

None

unset_constant_z_near(self)#

Function to remove a previously set constant z near value, i.e., near z-plane of the visualizer is dynamically set dependent on zoom and bounding box size.

Returns:

None