TBUI::TBUIInputHandler Class Reference

#include <tbuiinputhandler.h>

Detailed Description

This input handler passes input events to Turbobadger.

Copyright

(C) 2012-2024 Individual contributors, see AUTHORS file

Inherits Input::InputHandler.

Public Member Functions
	TBUIInputHandler ()
	constructor
virtual	~TBUIInputHandler ()
	destructor
virtual void	BeginCapture ()
	capture input to this event handler
virtual void	EndCapture ()
	end input capturing to this event handler
void	OnBeginFrame () override
	reset key inputs
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 bool	OnEvent (const Input::InputEvent &inputEvent)
	called when an input event should be processed
Protected Member Functions inherited from Input::InputHandler
virtual void	OnAttach ()
	called when the handler is attached to the input server
virtual void	OnRemove ()
	called when the handler is removed from the input server
virtual void	OnEndFrame ()
	called on InputServer::EndFrame();
virtual void	OnObtainCapture ()
	called when input handler obtains capture
virtual void	OnReleaseCapture ()
	called when input handler looses capture
virtual void	OnReset ()
	called when the handler should reset itself
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Private Member Functions
	__DeclareClass (TBUIInputHandler)

Private Attributes
Util::Array< Input::InputEvent >	inputEvents

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

TBUIInputHandler()

TBUI::TBUIInputHandler::TBUIInputHandler

(

)

constructor

~TBUIInputHandler()

TBUI::TBUIInputHandler::~TBUIInputHandler ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

TBUI::TBUIInputHandler::__DeclareClass ( TBUIInputHandler )

private

BeginCapture()

void TBUI::TBUIInputHandler::BeginCapture ( )

virtual

capture input to this event handler

Reimplemented from Input::InputHandler.

EndCapture()

void TBUI::TBUIInputHandler::EndCapture ( )

virtual

end input capturing to this event handler

Reimplemented from Input::InputHandler.

OnBeginFrame()

void TBUI::TBUIInputHandler::OnBeginFrame ( )

overridevirtual

reset key inputs

Reimplemented from Input::InputHandler.

OnEvent()

bool TBUI::TBUIInputHandler::OnEvent ( const Input::InputEvent & inputEvent )

protectedvirtual

called when an input event should be processed

Reimplemented from Input::InputHandler.

Member Data Documentation

inputEvents

Util::Array<Input::InputEvent> TBUI::TBUIInputHandler::inputEvents

private

---

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

• /github/workspace/code/addons/tbui/tbuiinputhandler.h
• /github/workspace/code/addons/tbui/tbuiinputhandler.cc