MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Mezzanine::Internal::EventManagerInternalData Struct Reference

Used to increase encapsulation, just a bit. More...

+ Collaboration diagram for Mezzanine::Internal::EventManagerInternalData:

Public Types

typedef std::map
< Input::InputCode,
PollingType >::iterator 
ManualCheckIterator
 an Iterator suitable for use with internal structures that correlate polling type and metacodes More...
 
enum  PollingType { Polling =1, Keypress =2, PollingKeyPress = Polling|Keypress }
 The kinds of data that can be stored in Manual Check. More...
 

Public Member Functions

 EventManagerInternalData ()
 Constructor, it only inits pointers to 0. More...
 
void AddInputCodesToManualCheck (int OneCode, int _PollingCheck)
 Adds one type of polling check where the data is only available as Ints. More...
 
void AddInputCodeToManualCheck (Input::InputCode OneCode, PollingType _PollingCheck)
 Adds one type of polling check. More...
 
void AddMetaCodesToManualCheck (const Input::MetaCode &OneCode, PollingType _PollingCheck)
 Adds one type of polling check where the data is only available as Ints. More...
 
void AddMetaCodesToManualCheck (std::vector< Input::MetaCode > Transport, PollingType _PollingCheck)
 Used to insert Codes into the list of items to be manually checked. More...
 
void DropAllKeyPresses ()
 Drops all keypresses from the list of items to be perpetuated each frame. More...
 
void RemoveInputCodeToManualCheck (const Input::InputCode &OneCode, PollingType _PollingCheck)
 Removes one type of polling check. More...
 
void RemoveMetaCodesToManualCheck (const Input::MetaCode &OneCode, PollingType _PollingCheck)
 Removes one type of polling check. More...
 
void RemoveMetaCodesToManualCheck (std::vector< Input::MetaCode > Transport, PollingType _PollingCheck)
 Remove Items form the internal manual check list. More...
 
void RemovePollingCheck (ManualCheckIterator Reduce, PollingType _PollingCheck)
 Remove a kind polling check from an item or remove item if that is the last check. More...
 

Public Attributes

EventPumpWorkUnitEventPumpWork
 This is the workunit that does the work each frame. More...
 
std::list< EventBase * > EventQ
 The Queue that all the events get stored in. More...
 
std::map< Input::InputCode,
PollingType
ManualCheck
 A unified polling and event repeater the Inputcode is the kind of event to check for each frame. The PollingType is used to control what can turn on and off the pollingcheck check. More...
 

Detailed Description

Used to increase encapsulation, just a bit.

Definition at line 132 of file eventmanager.cpp.

Member Typedef Documentation

an Iterator suitable for use with internal structures that correlate polling type and metacodes

Definition at line 154 of file eventmanager.cpp.

Member Enumeration Documentation

The kinds of data that can be stored in Manual Check.

Definition at line 140 of file eventmanager.cpp.

Constructor & Destructor Documentation

Mezzanine::Internal::EventManagerInternalData::EventManagerInternalData ( )
inline

Constructor, it only inits pointers to 0.

Definition at line 259 of file eventmanager.cpp.

Member Function Documentation

void Mezzanine::Internal::EventManagerInternalData::AddInputCodesToManualCheck ( int  OneCode,
int  _PollingCheck 
)
inline

Adds one type of polling check where the data is only available as Ints.

Parameters
OneCodeThe code that will be check for each frame, under the new condition
_PollingCheckThis is inserted into a new polling check or it is bitwise or'ed into an existing one, and this will trigger other parts of the code to insert event later on

Definition at line 179 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::AddInputCodeToManualCheck ( Input::InputCode  OneCode,
PollingType  _PollingCheck 
)
inline

Adds one type of polling check.

Parameters
OneCodeThe code that will be check for each frame, under the new condition
_PollingCheckThis is inserted into a new polling check or it is bitwise or'ed into an existing one, and this will trigger other parts of the code to insert event later on

Definition at line 164 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::AddMetaCodesToManualCheck ( const Input::MetaCode OneCode,
PollingType  _PollingCheck 
)
inline

Adds one type of polling check where the data is only available as Ints.

Parameters
OneCodeThe metacode that contains the input that will be checked for each frame
_PollingCheckThis is inserted into a new polling check or it is bitwise or'ed into an existing one, and this will trigger other parts of the code to insert event later on

Definition at line 191 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::AddMetaCodesToManualCheck ( std::vector< Input::MetaCode Transport,
PollingType  _PollingCheck 
)
inline

Used to insert Codes into the list of items to be manually checked.

Parameters
TransportA vector of every Meta that may need to be added to the list
_PollingCheckThis is inserted into a new polling check or it is bitwise or'ed into an existing one, and this will trigger other parts of the code to insert event later on

Definition at line 198 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::DropAllKeyPresses ( )
inline

Drops all keypresses from the list of items to be perpetuated each frame.

Definition at line 251 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::RemoveInputCodeToManualCheck ( const Input::InputCode OneCode,
PollingType  _PollingCheck 
)
inline

Removes one type of polling check.

Parameters
OneCodeThe code that will no longer be checked each frame, under the given condition
_PollingCheckIf this matches via bitwise or with the kind of polling check check stored for the existing InputCode then the it will be removed.

Definition at line 226 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::RemoveMetaCodesToManualCheck ( const Input::MetaCode OneCode,
PollingType  _PollingCheck 
)
inline

Removes one type of polling check.

Parameters
OneCodeA metacode that contains the the inputcode to remove
_PollingCheckIf this matches via bitwise or with the kind of polling check check stored for the existing InputCode then the it will be removed.

Definition at line 236 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::RemoveMetaCodesToManualCheck ( std::vector< Input::MetaCode Transport,
PollingType  _PollingCheck 
)
inline

Remove Items form the internal manual check list.

Parameters
TransportA vector of every MetaCode that may need to be removed to the list
_PollingCheckIf this matches via bitwise or with the kind of polling check check stored for the existing InputCode then the it will be removed.

Definition at line 243 of file eventmanager.cpp.

void Mezzanine::Internal::EventManagerInternalData::RemovePollingCheck ( ManualCheckIterator  Reduce,
PollingType  _PollingCheck 
)
inline

Remove a kind polling check from an item or remove item if that is the last check.

Parameters
ReduceAn Iterator Referencing an item in manual check
_PollingCheckWhat kind of Polling Type to Remove.

Definition at line 211 of file eventmanager.cpp.

Member Data Documentation

EventPumpWorkUnit* Mezzanine::Internal::EventManagerInternalData::EventPumpWork

This is the workunit that does the work each frame.

Definition at line 158 of file eventmanager.cpp.

std::list<EventBase*> Mezzanine::Internal::EventManagerInternalData::EventQ

The Queue that all the events get stored in.

Definition at line 136 of file eventmanager.cpp.

std::map<Input::InputCode, PollingType> Mezzanine::Internal::EventManagerInternalData::ManualCheck

A unified polling and event repeater the Inputcode is the kind of event to check for each frame. The PollingType is used to control what can turn on and off the pollingcheck check.

Definition at line 150 of file eventmanager.cpp.


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