InputDevice Class Reference

#include <input.h>

Inheritance diagram for InputDevice:

[legend]Collaboration diagram for InputDevice:

[legend]List of all members.

---

Detailed Description

Input event generator.

Author:

Mattias Jansson (mattias@realityrift.com)

Public Types
enum	INPUTEVENTGROUP { SYSTEMINPUT = 0x00000001, KEYBOARDINPUT = 0x00000002, MOUSEINPUT = 0x00000004, JOYSTICKINPUT = 0x00000008 }
	Inputgroup identifiers. More...
Public Member Functions
virtual bool	Collect (InputEvent *pkEvent)=0
virtual void	AddInputEventGroup (unsigned int uiInputEventGroup)
virtual void	DeleteInputEventGroup (unsigned int uiInputEventGroup)
virtual bool	HasInputEventGroup (unsigned int uiInputEventGroup)
bool	IsActive () const
virtual void	Activate ()
virtual void	Deactivate ()
bool	Toggle ()
Public Attributes
ModulePtr	m_pkModule
Protected Member Functions
	InputDevice (InputManager *pkManager)
virtual	~InputDevice ()
Protected Attributes
InputManager *	m_pkManager
unsigned int	m_eInputEventGroups
bool	m_bActive

---

Member Enumeration Documentation

enum INPUTEVENTGROUP

Inputgroup identifiers. Enumeration values: SYSTEMINPUT  System input (e.g. kill, window resize) KEYBOARDINPUT  Keyboard input (e.g. key presses) MOUSEINPUT  Mouse input (e.g. mouse move) JOYSTICKINPUT  Joystick input

---

Constructor & Destructor Documentation

InputDevice (  InputManager *  pkManager  )  [protected]

Attach to manager Parameters: pkManager  Input manager

virtual ~InputDevice (   )  [protected, virtual]

Detach from manager

---

Member Function Documentation

virtual bool Collect (  InputEvent *  pkEvent  )  [pure virtual]

Collect input events Parameters: pkEvent  Event object to fill with data Returns: true if events was collected, false if not

virtual void AddInputEventGroup (  unsigned int  uiInputEventGroup  )  [inline, virtual]

Enable input handling for the given group(s) Parameters: uiInputEventGroup  InputGroup(s) to enable; See INPUTGROUP (e.g. SYSTEMINPUT, KEYBOARDINPUT)

virtual void DeleteInputEventGroup (  unsigned int  uiInputEventGroup  )  [inline, virtual]

Disable input handling for the given group(s) Parameters: uiInputEventGroup  InputGroup(s) to disable; See INPUTGROUP (e.g. SYSTEMINPUT, KEYBOARDINPUT)

virtual bool HasInputEventGroup (  unsigned int  uiInputEventGroup  )  [inline, virtual]

Check if input handling is enabled of the given group(s) Parameters: uiInputEventGroup  InputGroup(s) to check; See INPUTGROUP (e.g. SYSTEMINPUT, KEYBOARDINPUT) Returns: True if input group is enabled, false otherwise

bool IsActive (   )  const [inline, inherited]

Query state of object Returns: true if active, false if not

void Activate (   )  [inline, virtual, inherited]

Activate object

void Deactivate (   )  [inline, virtual, inherited]

Deactivate object

bool Toggle (   )  [inline, inherited]

Toggle active state. This method does not need to be overloaded, it is only a wrapper to Activate and Deactivate Returns: true if activated, false if deactivated

---

Member Data Documentation

InputManager* m_pkManager [protected]

Manager

unsigned int m_eInputEventGroups [protected]

Managed input event groups

ModulePtr m_pkModule

Module device was loaded from Reimplemented in RenderDevice.

bool m_bActive [protected, inherited]

Active flag

---

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

• input.h

---