Base class for view controllers.
More...
#include <rendering/rendering.hh>
Inherited by FPSViewController, and OrbitViewController.
|
| ViewController (UserCameraPtr _camera) |
| Constructor.
|
|
virtual | ~ViewController () |
| Destructor.
|
|
std::string | GetTypeString () const |
| Get the type of view controller.
|
|
virtual void | HandleKeyPressEvent (const std::string &_key)=0 |
| Handle a key press event.
|
|
virtual void | HandleKeyReleaseEvent (const std::string &_key)=0 |
| Handle a key release event.
|
|
virtual void | HandleMouseEvent (const common::MouseEvent &_event)=0 |
| Handle a mouse event.
|
|
virtual void | Init ()=0 |
| Initialize the view controller.
|
|
virtual void | Init (const ignition::math::Vector3d &_focalPoint, const double _yaw=0, const double _pitch=0) |
| Initialize with a focus point.
|
|
virtual void | Resize (const unsigned int _width, const unsigned int _height) |
| Called by the UserCamera when a resize event occurs.
|
|
void | SetEnabled (bool _value) |
| Set whether the controller is enabled.
|
|
virtual void | Update ()=0 |
| Update the controller, which should update the position of the Camera.
|
|
Base class for view controllers.
◆ ViewController()
Constructor.
- Parameters
-
[in] | _camera | The user camera to controll. |
◆ ~ViewController()
◆ GetTypeString()
std::string GetTypeString |
( |
| ) |
const |
Get the type of view controller.
- Returns
- The view controller type string.
◆ HandleKeyPressEvent()
virtual void HandleKeyPressEvent |
( |
const std::string & | _key | ) |
|
|
pure virtual |
◆ HandleKeyReleaseEvent()
virtual void HandleKeyReleaseEvent |
( |
const std::string & | _key | ) |
|
|
pure virtual |
◆ HandleMouseEvent()
◆ Init() [1/2]
◆ Init() [2/2]
virtual void Init |
( |
const ignition::math::Vector3d & | _focalPoint, |
|
|
const double | _yaw = 0, |
|
|
const double | _pitch = 0 ) |
|
virtual |
◆ Resize()
virtual void Resize |
( |
const unsigned int | _width, |
|
|
const unsigned int | _height ) |
|
virtual |
◆ SetEnabled()
void SetEnabled |
( |
bool | _value | ) |
|
Set whether the controller is enabled.
- Parameters
-
[in] | _value | True if the controller is enabled. |
◆ Update()
◆ camera
Pointer to the camera to control.
◆ enabled
◆ typeString
The documentation for this class was generated from the following file: