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

First Person Shooter style view controller. More...

#include <rendering/rendering.hh>

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

Public Member Functions

 FPSViewController (UserCameraPtr _camera)
 Constructor. More...
 
virtual ~FPSViewController ()
 Destructor. More...
 
void HandleKeyPressEvent (const std::string &_key)
 Handle a key press event. More...
 
void HandleKeyReleaseEvent (const std::string &_key)
 Handle a key release event. More...
 
virtual void HandleMouseEvent (const common::MouseEvent &_event)
 Handle a mouse event. More...
 
virtual void Init ()
 Initialize the controller. More...
 
virtual void Update ()
 Update the camera position. More...
 
- 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...
 
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...
 
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...
 

Additional Inherited Members

- 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

First Person Shooter style view controller.

Constructor & Destructor Documentation

gazebo::rendering::FPSViewController::FPSViewController ( UserCameraPtr  _camera)

Constructor.

Parameters
[in]Camerato controll
virtual gazebo::rendering::FPSViewController::~FPSViewController ( )
virtual

Destructor.

Member Function Documentation

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

Get the type name of this view controller.

Returns
The name of the controller type: "fps"
void gazebo::rendering::FPSViewController::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::FPSViewController::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::FPSViewController::HandleMouseEvent ( const common::MouseEvent _event)
virtual

Handle a mouse event.

Parameters
[in]_eventThe mouse position.

Implements gazebo::rendering::ViewController.

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

Initialize the controller.

Implements gazebo::rendering::ViewController.

virtual void gazebo::rendering::FPSViewController::Update ( )
virtual

Update the camera position.

Implements gazebo::rendering::ViewController.


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