Public Member Functions | Static Public Member Functions | List of all members
gazebo::rendering::OrthoViewController Class Reference

Orthographic view controller. More...

#include <OrthoViewController.hh>

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

Public Member Functions

 OrthoViewController (UserCameraPtr _camera)
 Constructor. More...
 
virtual ~OrthoViewController ()
 Destructor. More...
 
virtual void HandleMouseEvent (const common::MouseEvent &_event)
 Handle a mouse event. More...
 
virtual void Init ()
 Initialize the controller. More...
 
virtual void Init (const math::Vector3 &_focalPoint, const double _yaw=0, const double _pitch=0)
 Initialize with a focus point. More...
 
virtual void Resize (const unsigned int _width, const unsigned int _height)
 Called by the UserCamera when a resize event occurs. More...
 
- Public Member Functions inherited from gazebo::rendering::OrbitViewController
 OrbitViewController (UserCameraPtr _camera, const std::string &_name="OrbitViewController")
 Constructor. More...
 
virtual ~OrbitViewController ()
 Destructor. More...
 
math::Vector3 GetFocalPoint () const
 Get the focal point. More...
 
virtual void HandleKeyPressEvent (const std::string &_key)
 Handle a key press event. More...
 
void HandleKeyReleaseEvent (const std::string &_key)
 Handle a key release event. More...
 
double Pitch () const
 
void SetDistance (float _d)
 Set the distance to the focal point. More...
 
void SetFocalPoint (const math::Vector3 &_fp)
 Set the focal point. More...
 
virtual void Update ()
 Update. More...
 
double Yaw () const
 
- Public Member Functions inherited from gazebo::rendering::ViewController
 ViewController (UserCameraPtr _camera)
 Constructor. More...
 
virtual ~ViewController ()
 Destructor. More...
 
std::string GetTypeString () const
 Get the type of view controller. More...
 
void SetEnabled (bool _value)
 Set whether the controller is enabled. More...
 

Static Public Member Functions

static std::string GetTypeString ()
 Get the type name of this view controller. More...
 
- Static Public Member Functions inherited from gazebo::rendering::OrbitViewController
static std::string GetTypeString ()
 Get the type name of this view controller. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gazebo::rendering::OrbitViewController
double NormalizePitch (double _v)
 Normalize pitch value. More...
 
double NormalizeYaw (double _v)
 Normalize yaw value. More...
 
void Orbit (double _dy, double _dp)
 Update the camera's pose based on a rotation update. More...
 
void TranslateGlobal (const math::Vector3 &_vec)
 Translate the focal point in the global coordinate frame. More...
 
void TranslateLocal (const math::Vector3 &_vec)
 Translate the focal point in the local coordinate frame. More...
 
void UpdateRefVisual ()
 Update the reference visual. More...
 
void Zoom (float _amount)
 Zoom the camera. More...
 
- Protected Attributes inherited from gazebo::rendering::OrbitViewController
float distance
 Distance to the focal point. More...
 
ignition::math::Vector3d focalPoint
 The focal point. More...
 
bool init
 A flag used to inidicate that the view controller has just been initialized. More...
 
std::string key
 Key that is currently pressed. More...
 
float pitch
 Pitch value. More...
 
VisualPtr refVisual
 A reference visual. More...
 
float yaw
 Yaw value. More...
 
- Protected Attributes inherited from gazebo::rendering::ViewController
UserCameraPtr camera
 Pointer to the camera to control. More...
 
bool enabled
 True if enabled. More...
 
std::string typeString
 Type of view controller. More...
 

Detailed Description

Orthographic view controller.

Constructor & Destructor Documentation

gazebo::rendering::OrthoViewController::OrthoViewController ( UserCameraPtr  _camera)

Constructor.

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

Destructor.

Member Function Documentation

static std::string gazebo::rendering::OrthoViewController::GetTypeString ( )
static

Get the type name of this view controller.

Returns
The view controller name: "ortho".
virtual void gazebo::rendering::OrthoViewController::HandleMouseEvent ( const common::MouseEvent _event)
virtual

Handle a mouse event.

Parameters
[in]_eventThe mouse event.

Reimplemented from gazebo::rendering::OrbitViewController.

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

Initialize the controller.

Reimplemented from gazebo::rendering::OrbitViewController.

virtual void gazebo::rendering::OrthoViewController::Init ( const math::Vector3 _focalPoint,
const double  _yaw = 0,
const double  _pitch = 0 
)
virtual

Initialize with a focus point.

Parameters
[in]_focalPointThe point to look at.
[in]_yawInitial yaw angle.
[in]_pitchInitial pitch angle.

Reimplemented from gazebo::rendering::OrbitViewController.

virtual void gazebo::rendering::OrthoViewController::Resize ( const unsigned int  _width,
const unsigned int  _height 
)
virtual

Called by the UserCamera when a resize event occurs.

Parameters
[in]_widthNew width
[in]_heightNew height

Reimplemented from gazebo::rendering::ViewController.


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