Gazebo Rendering

API Reference

9.5.0
OrthoViewController Class Reference

Orthographic view controller. More...

#include <OrthoViewController.hh>

Public Member Functions

 OrthoViewController ()
 Constructor.
 
 OrthoViewController (const CameraPtr &_camera)
 Constructor.
 
 ~OrthoViewController () override
 Destructor.
 
virtual CameraPtr Camera () const
 Get the camera that is controlled by this view controller.
 
void Orbit (const math::Vector2d &_value) override
 Set camera orbit (rotational movement) around target point.
 
void Pan (const math::Vector2d &_value) override
 Set camera pan (translational movement) around target point.
 
void SetCamera (const CameraPtr &_camera) override
 Set the camera that will be controlled by this view controller.
 
void SetTarget (const math::Vector3d &_target) override
 Set target point for pan, zoom, oribit.
 
virtual const math::Vector3dTarget () const
 Get target point for pan, zoom, oribit.
 
void Zoom (const double _value) override
 Set zoom amount.
 
- Public Member Functions inherited from ViewController
virtual ~ViewController ()
 Destructor.
 

Public Attributes

std::unique_ptr< OrthoViewControllerPrivate > dataPtr
 Private data pointer.
 

Detailed Description

Orthographic view controller.

Constructor & Destructor Documentation

◆ OrthoViewController() [1/2]

Constructor.

◆ OrthoViewController() [2/2]

OrthoViewController ( const CameraPtr _camera)
explicit

Constructor.

Parameters
[in]_cameraPointer to the camera to control.

◆ ~OrthoViewController()

~OrthoViewController ( )
override

Destructor.

Member Function Documentation

◆ Camera()

virtual CameraPtr Camera ( ) const
virtual

Get the camera that is controlled by this view controller.

Returns
Camera being controlled

◆ Orbit()

void Orbit ( const math::Vector2d _value)
overridevirtual

Set camera orbit (rotational movement) around target point.

Parameters
[in]_valueorbit amount in image plane, e.g. mouse drag delta

Implements ViewController.

◆ Pan()

void Pan ( const math::Vector2d _value)
overridevirtual

Set camera pan (translational movement) around target point.

Parameters
[in]_valuePan amount in image plane, e.g. mouse drag delta.

Implements ViewController.

◆ SetCamera()

void SetCamera ( const CameraPtr _camera)
overridevirtual

Set the camera that will be controlled by this view controller.

Parameters
[in]_cameraCamera to control

Implements ViewController.

◆ SetTarget()

void SetTarget ( const math::Vector3d _target)
overridevirtual

Set target point for pan, zoom, oribit.

Parameters
[in]_targetTarget point in world coordinates

Implements ViewController.

◆ Target()

virtual const math::Vector3d & Target ( ) const
virtual

Get target point for pan, zoom, oribit.

Returns
target point in world coordinates

◆ Zoom()

void Zoom ( const double  _value)
overridevirtual

Set zoom amount.

Parameters
[in]_valueCamera zoom value, e.g. mouse scroll delta

Implements ViewController.

Member Data Documentation

◆ dataPtr

std::unique_ptr<OrthoViewControllerPrivate> dataPtr

Private data pointer.


The documentation for this class was generated from the following file: