Nebula
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Base::KeyboardBase Class Reference

#include <keyboardbase.h>

Detailed Description

An input handler which represents a keyboard for polling.

Copyright
(C) 2007 Radon Labs GmbH
(C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Input::InputHandler.

Classes

class  KeyState
 

Public Member Functions

 KeyboardBase ()
 constructor
 
virtual ~KeyboardBase ()
 destructor
 
virtual void BeginCapture ()
 capture input to this event handler
 
virtual void EndCapture ()
 end input capturing to this event handler
 
void SetKeyDown (Input::Key::Code keyCode)
 sets a key to be down
 
void SetKeyUp (Input::Key::Code keyCode)
 sets a key to be up
 
bool KeyPressed (Input::Key::Code keyCode) const
 return true if a key is currently pressed
 
bool KeyDown (Input::Key::Code keyCode) const
 return true if key was pushed down at least once in current frame
 
bool KeyUp (Input::Key::Code keyCode) const
 return true if key was released at least once in current frame
 
const Util::String & GetCharInput () const
 get character input in current frame
 
- Public Member Functions inherited from Input::InputHandler
 InputHandler ()
 constructor
 
virtual ~InputHandler ()
 destructor
 
bool IsAttached () const
 return true if the input handler is currently attached
 
bool IsCapturing () const
 return true if this input handler captures input
 
- Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
 
int GetRefCount () const
 get the current refcount
 
void AddRef ()
 increment refcount by one
 
void Release ()
 decrement refcount and destroy object if refcount is zero
 
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
 
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
 
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
 
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
 
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
 
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
 
const Util::String & GetClassName () const
 get the class name
 
Util::FourCC GetClassFourCC () const
 get the class FourCC code
 

Protected Member Functions

virtual void OnAttach ()
 called when the handler is attached to the input server
 
virtual void OnBeginFrame ()
 called on InputServer::BeginFrame()
 
virtual bool OnEvent (const Input::InputEvent &inputEvent)
 called when an input event should be processed
 
virtual void OnObtainCapture ()
 called when input handler obtains capture
 
virtual void OnReleaseCapture ()
 called when input handler looses capture
 
virtual void OnReset ()
 reset the input handler
 
- Protected Member Functions inherited from Input::InputHandler
virtual void OnRemove ()
 called when the handler is removed from the input server
 
virtual void OnEndFrame ()
 called on InputServer::EndFrame();
 
- Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)
 

Private Member Functions

 __DeclareClass (KeyboardBase)
 

Private Attributes

Util::FixedArray< KeyState > keyStates
 
Util::FixedArray< KeyState > nextKeyStates
 
Util::String charInput
 

Additional Inherited Members

- Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
 
- Protected Attributes inherited from Input::InputHandler
bool isAttached
 
bool isCapturing
 

Constructor & Destructor Documentation

◆ KeyboardBase()

Base::KeyboardBase::KeyboardBase ( )

constructor

◆ ~KeyboardBase()

Base::KeyboardBase::~KeyboardBase ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

Base::KeyboardBase::__DeclareClass ( KeyboardBase )
private

◆ BeginCapture()

void Base::KeyboardBase::BeginCapture ( )
virtual

capture input to this event handler

Reimplemented from Input::InputHandler.

◆ EndCapture()

void Base::KeyboardBase::EndCapture ( )
virtual

end input capturing to this event handler

Reimplemented from Input::InputHandler.

◆ GetCharInput()

const Util::String & Base::KeyboardBase::GetCharInput ( ) const
inline

get character input in current frame

◆ KeyDown()

bool Base::KeyboardBase::KeyDown ( Input::Key::Code keyCode) const
inline

return true if key was pushed down at least once in current frame

◆ KeyPressed()

bool Base::KeyboardBase::KeyPressed ( Input::Key::Code keyCode) const
inline

return true if a key is currently pressed

◆ KeyUp()

bool Base::KeyboardBase::KeyUp ( Input::Key::Code keyCode) const
inline

return true if key was released at least once in current frame

◆ OnAttach()

void Base::KeyboardBase::OnAttach ( )
protectedvirtual

called when the handler is attached to the input server

Reimplemented from Input::InputHandler.

◆ OnBeginFrame()

void Base::KeyboardBase::OnBeginFrame ( )
protectedvirtual

called on InputServer::BeginFrame()

Reimplemented from Input::InputHandler.

◆ OnEvent()

bool Base::KeyboardBase::OnEvent ( const Input::InputEvent & inputEvent)
protectedvirtual

called when an input event should be processed

Reimplemented from Input::InputHandler.

◆ OnObtainCapture()

void Base::KeyboardBase::OnObtainCapture ( )
protectedvirtual

called when input handler obtains capture

Reimplemented from Input::InputHandler.

◆ OnReleaseCapture()

void Base::KeyboardBase::OnReleaseCapture ( )
protectedvirtual

called when input handler looses capture

Reimplemented from Input::InputHandler.

◆ OnReset()

void Base::KeyboardBase::OnReset ( )
protectedvirtual

reset the input handler

Reimplemented from Input::InputHandler.

◆ SetKeyDown()

void Base::KeyboardBase::SetKeyDown ( Input::Key::Code keyCode)
inline

sets a key to be down

◆ SetKeyUp()

void Base::KeyboardBase::SetKeyUp ( Input::Key::Code keyCode)
inline

sets a key to be up

Member Data Documentation

◆ charInput

Util::String Base::KeyboardBase::charInput
private

◆ keyStates

Util::FixedArray<KeyState> Base::KeyboardBase::keyStates
private

◆ nextKeyStates

Util::FixedArray<KeyState> Base::KeyboardBase::nextKeyStates
private
The documentation for this class was generated from the following files: