All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
gazebo::rendering::OrbitViewController Class Reference

Orbit view controller. More...

#include <OrbitViewController.hh>

Inheritance diagram for gazebo::rendering::OrbitViewController:
Inheritance graph
[legend]

Public Member Functions

 OrbitViewController (UserCameraPtr _camera)
 Constructor.
 
virtual ~OrbitViewController ()
 Destructor.
 
math::Vector3 GetFocalPoint () const
 Get the focal point.
 
virtual void HandleKeyPressEvent (const std::string &_key)
 Handle a key press event.
 
void HandleKeyReleaseEvent (const std::string &_key)
 Handle a key release event.
 
virtual void HandleMouseEvent (const common::MouseEvent &_event)
 Handle a mouse event.
 
virtual void Init ()
 Initialize the controller.
 
virtual void Init (const math::Vector3 &_focalPoint)
 Initialze the controller with a focal point.
 
void SetDistance (float _d)
 Set the distance to the focal point.
 
void SetDistanceRange (double _minDist, double _maxDist)
 Set the min and max distance from the focal point.
 
void SetFocalPoint (const math::Vector3 &_fp)
 Set the focal point.
 
void SetPitch (double _pitch)
 Set the pitch angle of the camera.
 
void SetYaw (double _yaw)
 Set the yaw angle of the camera.
 
virtual void Update ()
 Update.
 
- Public Member Functions inherited from gazebo::rendering::ViewController
 ViewController (UserCameraPtr _camera)
 Constructor.
 
virtual ~ViewController ()
 Destructor.
 
std::string GetTypeString () const
 Get the type of view controller.
 
void SetEnabled (bool _value)
 Set whether the controller is enabled.
 

Static Public Member Functions

static std::string GetTypeString ()
 Get the type name of this view controller.
 

Additional Inherited Members

- Protected Attributes inherited from gazebo::rendering::ViewController
UserCameraPtr camera
 Pointer to the camera to control.
 
bool enabled
 True if enabled.
 
std::string typeString
 Type of view controller.
 

Detailed Description

Orbit view controller.

Constructor & Destructor Documentation

gazebo::rendering::OrbitViewController::OrbitViewController ( UserCameraPtr  _camera)

Constructor.

Parameters
[in]_cameraPointer to the camera to control.
virtual gazebo::rendering::OrbitViewController::~OrbitViewController ( )
virtual

Destructor.

Member Function Documentation

math::Vector3 gazebo::rendering::OrbitViewController::GetFocalPoint ( ) const

Get the focal point.

Returns
The focal point
static std::string gazebo::rendering::OrbitViewController::GetTypeString ( )
static

Get the type name of this view controller.

Returns
The view controller name: "orbit".
virtual void gazebo::rendering::OrbitViewController::HandleKeyPressEvent ( const std::string &  _key)
virtual

Handle a key press event.

Parameters
[in]_keyThe key that was pressed.

Implements gazebo::rendering::ViewController.

void gazebo::rendering::OrbitViewController::HandleKeyReleaseEvent ( const std::string &  _key)
virtual

Handle a key release event.

Parameters
[in]_keyThe key that was released.

Implements gazebo::rendering::ViewController.

virtual void gazebo::rendering::OrbitViewController::HandleMouseEvent ( const common::MouseEvent _event)
virtual

Handle a mouse event.

Parameters
[in]_eventThe mouse event.

Implements gazebo::rendering::ViewController.

virtual void gazebo::rendering::OrbitViewController::Init ( )
virtual

Initialize the controller.

Implements gazebo::rendering::ViewController.

virtual void gazebo::rendering::OrbitViewController::Init ( const math::Vector3 _focalPoint)
virtual

Initialze the controller with a focal point.

Parameters
[in]_focalPointPoint to look at.

Reimplemented from gazebo::rendering::ViewController.

void gazebo::rendering::OrbitViewController::SetDistance ( float  _d)

Set the distance to the focal point.

Parameters
[in]_dThe distance from the focal point.
void gazebo::rendering::OrbitViewController::SetDistanceRange ( double  _minDist,
double  _maxDist 
)

Set the min and max distance from the focal point.

Parameters
[in]_minDistMin distance to the focal point.
[in]_maxDistMax distance from the focal point.
void gazebo::rendering::OrbitViewController::SetFocalPoint ( const math::Vector3 _fp)

Set the focal point.

Parameters
[in]_fpThe focal point
void gazebo::rendering::OrbitViewController::SetPitch ( double  _pitch)

Set the pitch angle of the camera.

Parameters
[in]Pitchangle in radians.
void gazebo::rendering::OrbitViewController::SetYaw ( double  _yaw)

Set the yaw angle of the camera.

Parameters
[in]Yawangle in radians
virtual void gazebo::rendering::OrbitViewController::Update ( )
virtual

Update.

Implements gazebo::rendering::ViewController.


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