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

InputGroup Class Reference

#include <input.h>

Inheritance diagram for InputGroup:

Inheritance graph
[legend]
Collaboration diagram for InputGroup:

Collaboration graph
[legend]
List of all members.

Detailed Description

Group of input objects for easy management.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Member Functions

 InputGroup (InputManager *pkManager=0)
virtual ~InputGroup ()
void AttachEntity (InputEntity *pkObject)
void DetachEntity (InputEntity *pkObject)
void Distribute (const std::vector< InputEvent * > &rvpkEvents)
virtual void Distribute (const InputEvent *pkEvent)
InputManagerGetManager ()
bool IsActive () const
virtual void Activate ()
virtual void Deactivate ()
bool Toggle ()

Protected Attributes

std::vector< InputEntity * > m_vpkInputObjects
InputManagerm_pkManager
bool m_bActive


Constructor & Destructor Documentation

InputGroup InputManager pkManager = 0  ) 
 

Attach to manager

Parameters:
pkManager Input manager. If this argument is null (default), the core input manager will be used

virtual ~InputGroup  )  [virtual]
 

Detach from manager


Member Function Documentation

void AttachEntity InputEntity pkObject  ) 
 

Attach input entity

Parameters:
pkObject Input entity to attach

void DetachEntity InputEntity pkObject  ) 
 

Detach input entity

Parameters:
pkObject Input entity to detach

void Distribute const std::vector< InputEvent * > &  rvpkEvents  ) 
 

Distribute events to active nodes. Do not overload this method, as it is a wrapper to the single-event distribute method.

Parameters:
rvpkEvents vector of events

virtual void Distribute const InputEvent pkEvent  )  [virtual]
 

Distribute events to active nodes

Parameters:
pkEvent Event object

InputManager* GetManager  )  [inline]
 

Returns:
Manager object

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

std::vector< InputEntity* > m_vpkInputObjects [protected]
 

Input objects attached to this group

InputManager* m_pkManager [protected]
 

Manager

bool m_bActive [protected, inherited]
 

Active flag


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:11 2004 for NeoEngine by doxygen 1.3.5