Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

CInputEngine Class Reference

Input Engine class. More...

#include <InputEngine.h>

Inheritance diagram for CInputEngine:

CEntity CSingleton< CInputEngine > List of all members.

Public Member Functions

CMouseGetMouse ()
CKeyboardGetKeyboard ()
int Create ()
int Poll ()
void Destroy ()
virtual bool IsOfType (eEntityType eType)

Protected Attributes

CKeyboardm_pKeyboard
CMousem_pMouse

Detailed Description

Input Engine class.

This class manages all the input from hardware-based devices (keyboard, mouse, gamepad etc) and provides easy-to-use interface to access them/their values/keys

Definition at line 15 of file InputEngine.h.


Member Function Documentation

int CInputEngine::Create  ) 
 

Method details:

Returns:
1 if engine has been created succesfully, 0 otherwise
Definition at line 20 of file InputEngine.cpp.

References CKeyboard::Create(), CMouse::Create(), m_pKeyboard, and m_pMouse.

void CInputEngine::Destroy  ) 
 

Method details: Destroys the engineDefinition at line 59 of file InputEngine.cpp.

References m_pKeyboard, and m_pMouse.

CKeyboard * CInputEngine::GetKeyboard  ) 
 

Method details:

Returns:
Pointer to keyboard device
Definition at line 54 of file InputEngine.cpp.

References m_pKeyboard.

CMouse * CInputEngine::GetMouse  ) 
 

Method details:

Returns:
Pointer to mouse device
Definition at line 49 of file InputEngine.cpp.

References m_pMouse.

Referenced by CGUIMenuEntry::Draw(), CGUIButton::GetCurrentAnimation(), CGUIElement::OnMouseMove(), CGUIMenuEntry::PointInChildRects(), CGUIScrollBar::ProcessMessage(), and CGUI::Update().

bool CInputEngine::IsOfType eEntityType  eType  )  [virtual]
 

Method details: This is an implementation of Custom RTTI

Reimplemented from CEntity.

Definition at line 75 of file InputEngine.cpp.

References CEntity::IsOfType().

int CInputEngine::Poll  ) 
 

Method details:

Returns:
1 if engine has polled something new, 0 otherwise
Definition at line 38 of file InputEngine.cpp.

References m_pKeyboard, m_pMouse, CMouse::Poll(), and CKeyboard::Poll().


Member Data Documentation

CKeyboard* CInputEngine::m_pKeyboard [protected]
 

Pointer to keyboard device class Definition at line 56 of file InputEngine.h.

Referenced by Create(), Destroy(), GetKeyboard(), and Poll().

CMouse* CInputEngine::m_pMouse [protected]
 

Pointer to mouse device class Definition at line 57 of file InputEngine.h.

Referenced by Create(), Destroy(), GetMouse(), and Poll().


The documentation for this class was generated from the following files:
Generated on Sun Jul 17 21:34:30 2005 for OpenGL GUI by doxygen 1.3.8