Emergency 2017 Dokumentation  v3.0.1
qsf::GameShotCameraInputHandler Class Reference

Game-like camera input handler class. More...

#include <GameShotCameraInputHandler.h>

Public Member Functions

 GameShotCameraInputHandler (uint32 id)
 Constructor. More...
 
virtual ~GameShotCameraInputHandler ()
 Destructor. More...
 
virtual void updateInputHandler (const Time &timePassed) override
 Update the input handler. More...
 
virtual void eventReceived (const InputEvent &inputEvent, Response &response) override
 React to input events. More...
 
- Public Member Functions inherited from qsf::OrbitingCameraInputHandler
 OrbitingCameraInputHandler (uint32 id)
 Constructor. More...
 
virtual ~OrbitingCameraInputHandler ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::FreeMoveInputHandler
 FreeMoveInputHandler (uint32 id)
 Constructor. More...
 
virtual ~FreeMoveInputHandler ()
 Destructor. More...
 
float getMoveSpeed () const
 Return the move speed. More...
 
void setMoveSpeed (float moveSpeed)
 Set the move speed. More...
 
float getWheelMoveSpeed () const
 Return the wheel move speed. More...
 
void setWheelMoveSpeed (float moveSpeed)
 Set the wheel move speed. More...
 
float getRotateSpeed () const
 Return the rotate speed. More...
 
void setRotateSpeed (float rotateSpeed)
 Set the rotate speed. More...
 
float getDefaultMoveSpeed () const
 
void setNullSpeedWithAltKeyEnabled (bool enable)
 
const FreeMoveInputDevicegetFreeMoveInputDevice ()
 
virtual void initialize () override
 Gets called after the input handler was created -> This is needed to support special initialization in derived classes. More...
 
- Public Member Functions inherited from qsf::EntityInputHandler
 EntityInputHandler (uint32 id)
 Constructor. More...
 
virtual ~EntityInputHandler ()
 Destructor. More...
 
void setEntityById (uint64 entityId)
 Set target entity that will be directly controlled by this input handler. More...
 
- Public Member Functions inherited from qsf::InputHandler
 InputHandler (uint32 id)
 Constructor. More...
 
virtual ~InputHandler ()
 Destructor. More...
 
uint32 getId ()
 Return the handler's ID. More...
 
- Public Member Functions inherited from qsf::InputListener
 InputListener ()
 Default constructor. More...
 
virtual ~InputListener ()
 Destructor. More...
 
WindowgetFocusWindow () const
 Return the focus window. More...
 
void setFocusWindow (Window *focusWindow)
 Set focus window. More...
 

Additional Inherited Members

- Public Attributes inherited from qsf::FreeMoveInputHandler
boost::signals2::signal< void(const glm::vec3 &, const glm::vec3 &)> PositionChanged
 This Boost signal is emitted after the entity position has been changed; parameter: previous and new position. More...
 
boost::signals2::signal< void(const glm::quat &, const glm::quat &)> RotationChanged
 This Boost signal is emitted after the entity rotation has been changed; parameter: previous and new rotation. More...
 
- Protected Member Functions inherited from qsf::OrbitingCameraInputHandler
virtual void startupForEntity (Entity &entity) override
 
void dropTargetPointToGround (glm::vec3 &point, float offsetAboveGround, bool terrainOnly=true) const
 
void dropTargetPointToGround (glm::vec3 &point, float offsetAboveGround, uint32 groundMapId) const
 
- Protected Member Functions inherited from qsf::FreeMoveInputHandler
virtual void setupInputFeeder ()
 Gets called to setup the input feeder. More...
 
CameraControlComponentgetCameraControlComponent () const
 
float getSpeedModifier () const
 
glm::vec3 getMovementDelta () const
 
glm::quat getNewRotation (float *outYaw=nullptr, float *outPitch=nullptr) const
 
float getMouseWheelDelta () const
 
void backupPositionRotation ()
 
void setNewPosition (const glm::vec3 &newPosition)
 
void setNewRotation (const glm::quat &newRotation)
 
- Protected Member Functions inherited from qsf::EntityInputHandler
virtual void shutdownForEntity (Entity &entity)
 
EntitygetEntity () const
 Return target entity, or a null pointer. More...
 
TransformComponentgetTransformComponent () const
 Return target entity's transform component; can be a null pointer if the entity does not exist or has no transform component. More...
 
- Protected Attributes inherited from qsf::FreeMoveInputHandler
float mMoveSpeed
 Move speed in world units per second. More...
 
float mWheelMoveSpeed
 Move speed for mouse wheel in world units per wheel step. More...
 
float mRotateSpeed
 Rotate speed in degrees per screen pixel. More...
 
FreeMoveInputDevicemInputDevice
 Input device holding the key bindings; always valid, do not destroy. More...
 
glm::vec3 mLastPosition
 
glm::quat mLastRotation
 
bool mNullSpeedWithAltKeyEnabled
 

Detailed Description

Game-like camera input handler class.

Note
  • This is basically a copy of the "em5::IngameCameraInputHandler", with minor changes
Todo:
  • TODO(fw): The class name should be changed

Definition at line 36 of file GameShotCameraInputHandler.h.

Constructor & Destructor Documentation

qsf::GameShotCameraInputHandler::GameShotCameraInputHandler ( uint32  id)
explicit

Constructor.

virtual qsf::GameShotCameraInputHandler::~GameShotCameraInputHandler ( )
virtual

Destructor.

Member Function Documentation

virtual void qsf::GameShotCameraInputHandler::eventReceived ( const InputEvent inputEvent,
Response response 
)
overridevirtual

React to input events.

Reimplemented from qsf::OrbitingCameraInputHandler.

virtual void qsf::GameShotCameraInputHandler::updateInputHandler ( const Time timePassed)
overridevirtual

Update the input handler.

Reimplemented from qsf::OrbitingCameraInputHandler.


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