Nebula
Loading...
Searching...
No Matches
Dynui::ImguiInputHandler Class Reference

#include <imguiinputhandler.h>

Detailed Description

This input handler passes input events to Imgui.

Inherits Input::InputHandler.

Public Member Functions

 ImguiInputHandler ()
 constructor
 
virtual ~ImguiInputHandler ()
 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::StringGetClassName () 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 (ImguiInputHandler)
 

Private Attributes

Util::Array< Input::InputEventinputEvents
 

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

◆ ImguiInputHandler()

Dynui::ImguiInputHandler::ImguiInputHandler ( )

constructor

◆ ~ImguiInputHandler()

Dynui::ImguiInputHandler::~ImguiInputHandler ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

Dynui::ImguiInputHandler::__DeclareClass ( ImguiInputHandler )
private

◆ BeginCapture()

void Dynui::ImguiInputHandler::BeginCapture ( )
virtual

capture input to this event handler

Reimplemented from Input::InputHandler.

◆ EndCapture()

void Dynui::ImguiInputHandler::EndCapture ( )
virtual

end input capturing to this event handler

Reimplemented from Input::InputHandler.

◆ OnBeginFrame()

void Dynui::ImguiInputHandler::OnBeginFrame ( )
overridevirtual

reset key inputs

Reimplemented from Input::InputHandler.

◆ OnEvent()

bool Dynui::ImguiInputHandler::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> Dynui::ImguiInputHandler::inputEvents
private

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