castor3d::KeyboardEvent Class Reference

#include <KeyboardEvent.hpp>

Inheritance diagram for castor3d::KeyboardEvent:

Collaboration diagram for castor3d::KeyboardEvent:

Public Member Functions
	KeyboardEvent (KeyboardEventType type, KeyboardKey key, bool ctrl, bool alt, bool shift)
	KeyboardEvent (KeyboardEventType type, KeyboardKey key, castor::String const &c, bool ctrl, bool alt, bool shift)
KeyboardEventType	getKeyboardEventType () const
KeyboardKey	getKey () const
castor::String const &	getChar () const
bool	isCtrlDown () const
bool	isAltDown () const
bool	isShiftDown () const
Public Member Functions inherited from castor3d::UserInputEvent
	UserInputEvent (UserInputEventType type)
virtual	~UserInputEvent ()=default
UserInputEventType	getEventType () const

Constructor & Destructor Documentation

KeyboardEvent() [1/2]

castor3d::KeyboardEvent::KeyboardEvent ( KeyboardEventType  type, KeyboardKey  key, bool  ctrl, bool  alt, bool  shift  )

inline

References castor3d::eKeyboard.

KeyboardEvent() [2/2]

castor3d::KeyboardEvent::KeyboardEvent ( KeyboardEventType  type, KeyboardKey  key, castor::String const &  c, bool  ctrl, bool  alt, bool  shift  )

inline

References castor3d::eKeyboard.

Member Function Documentation

getChar()

castor::String const & castor3d::KeyboardEvent::getChar ( ) const

inline

Returns

The character corresponding to the key code.

getKey()

KeyboardKey castor3d::KeyboardEvent::getKey ( ) const

inline

Returns

The key code.

getKeyboardEventType()

KeyboardEventType castor3d::KeyboardEvent::getKeyboardEventType ( ) const

inline

Returns

The keyboard event type.

isAltDown()

bool castor3d::KeyboardEvent::isAltDown ( ) const

inline

Returns

The Alt key down status.

isCtrlDown()

bool castor3d::KeyboardEvent::isCtrlDown ( ) const

inline

Returns

The Ctrl key down status.

isShiftDown()

bool castor3d::KeyboardEvent::isShiftDown ( ) const

inline

Returns

The Shift key down status.

---

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

• Event/UserInput/KeyboardEvent.hpp