om::engine::base::InputSystem Class Reference

A class that manages and dispatches input events for an entity component engine. More...

#include <omEngineInputSystem.h>

Inheritance diagram for om::engine::base::InputSystem:

Public Member Functions
	InputSystem ()
	Create a new input system. More...
virtual void	update (EngineContext &engine, const Time &dt)
	Update the state of the entities in the specified engine context for the given timestep. More...
virtual Bool	textEvent (const TextEvent &event)
	Process the specified text event in this input system. More...
virtual Bool	keyEvent (const KeyEvent &event)
	Process the specified keyboard event in this input system. More...
virtual Bool	mouseButtonEvent (const MouseButtonEvent &event)
	Process the specified mouse button event in this input system. More...
virtual Bool	mouseWheelEvent (const MouseWheelEvent &event)
	Process the specified mouse wheel event in this input system. More...
virtual Bool	mouseMotionEvent (const MouseMotionEvent &event)
	Process the specified mouse motion event in this input system. More...
Public Member Functions inherited from om::engine::base::EngineSystem
virtual	~EngineSystem ()
	Destroy a system and release all internal resources. More...
virtual void	addComponent (const ResourceType &type, void *component, EngineContext &engine)
	Update the internal state of the system for a component that was added to the engine. More...
virtual void	removeComponent (const ResourceType &type, void *component, EngineContext &engine)
	Update the internal state of the system for a component that was removed from the engine. More...
const SystemType &	getType () const
	Return an enum value indicating the semantic type of this engine system. More...

Static Public Attributes
static const EventType	TEXT_EVENT
	A static event type object that represents a text event type with value of type UTF8String. More...
static const EventType	KEY_EVENT
	A static event type object that represents a key event type with value of type gui::input::KeyEvent. More...
static const EventType	MOUSE_BUTTON_EVENT
	A static event type object that represents a mouse button event type with value of type gui::input::MouseButtonEvent. More...
static const EventType	MOUSE_WHEEL_EVENT
	A static event type object that represents a mouse wheel event type with value of type gui::input::MouseWheelEvent. More...
static const EventType	MOUSE_MOTION_EVENT
	A static event type object that represents a mouse motion event type with value of type gui::input::MouseMotionEvent. More...

Additional Inherited Members
Protected Member Functions inherited from om::engine::base::EngineSystem
	EngineSystem ()
	Create a new engine system with the UNDEFINED system type. More...
	EngineSystem (const SystemType &newSystemType)
	Create a new engine system with the specified system type. More...

Detailed Description

A class that manages and dispatches input events for an entity component engine.

Constructor & Destructor Documentation

om::engine::base::InputSystem::InputSystem

(

)

Create a new input system.

Member Function Documentation

virtual void om::engine::base::InputSystem::update ( EngineContext &  engine, const Time &  dt  )

virtual

Update the state of the entities in the specified engine context for the given timestep.

Reimplemented from om::engine::base::EngineSystem.

virtual Bool om::engine::base::InputSystem::textEvent ( const TextEvent &  event )

virtual

Process the specified text event in this input system.

virtual Bool om::engine::base::InputSystem::keyEvent ( const KeyEvent &  event )

virtual

Process the specified keyboard event in this input system.

virtual Bool om::engine::base::InputSystem::mouseButtonEvent ( const MouseButtonEvent &  event )

virtual

Process the specified mouse button event in this input system.

virtual Bool om::engine::base::InputSystem::mouseWheelEvent ( const MouseWheelEvent &  event )

virtual

Process the specified mouse wheel event in this input system.

virtual Bool om::engine::base::InputSystem::mouseMotionEvent ( const MouseMotionEvent &  event )

virtual

Process the specified mouse motion event in this input system.

Member Data Documentation

const EventType om::engine::base::InputSystem::TEXT_EVENT

static

A static event type object that represents a text event type with value of type UTF8String.

const EventType om::engine::base::InputSystem::KEY_EVENT

static

A static event type object that represents a key event type with value of type gui::input::KeyEvent.

const EventType om::engine::base::InputSystem::MOUSE_BUTTON_EVENT

static

A static event type object that represents a mouse button event type with value of type gui::input::MouseButtonEvent.

const EventType om::engine::base::InputSystem::MOUSE_WHEEL_EVENT

static

A static event type object that represents a mouse wheel event type with value of type gui::input::MouseWheelEvent.

const EventType om::engine::base::InputSystem::MOUSE_MOTION_EVENT

static

A static event type object that represents a mouse motion event type with value of type gui::input::MouseMotionEvent.

---

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

• omEngineInputSystem.h