VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Public Member Functions | List of all members
KeyScheme Class Reference

Represents a scheme mapping keyboard input to output actions. More...

Inheritance diagram for KeyScheme:
InputScheme< KeyCode >

Public Member Functions

 KeyScheme ()
 Constructs an empty KeyScheme. More...
 
 KeyScheme (const typename InputScheme< KeyCode >::Map &scheme)
 Constructs a KeyScheme from the specified scheme. More...
 
virtual bool handlesControllerEvent (const ControllerEvent *event) const override
 Returns whether or not this KeyScheme would handle event. More...
 
- Public Member Functions inherited from InputScheme< KeyCode >
 InputScheme ()
 Constructs an empty input scheme. More...
 
 InputScheme (const Map &scheme)
 Constructs an InputScheme from the specified input to action map. More...
 
bool empty () const
 Returns whether or not the InputScheme contains any mappings. More...
 
Map::const_iterator begin () const
 Returns a const iterator positioned at the beginning of the InputScheme. More...
 
Map::const_iterator end () const
 Returns a const iterator positioned at the end of the InputScheme. More...
 
bool hasActionFor (const KeyCode &input) const
 Returns whether or not this input scheme has an action associated with the specified input. More...
 
bool intersects (const InputScheme< KeyCode > &inputScheme) const
 Returns whether or not inputScheme intersects with this InputScheme. More...
 

Additional Inherited Members

- Public Types inherited from InputScheme< KeyCode >
typedef int Action
 Output type. More...
 
typedef std::map< KeyCode, ActionMap
 Input "event" to Action output map. More...
 

Detailed Description

Represents a scheme mapping keyboard input to output actions.

Constructor & Destructor Documentation

KeyScheme::KeyScheme ( )
inline

Constructs an empty KeyScheme.

KeyScheme::KeyScheme ( const typename InputScheme< KeyCode >::Map scheme)
inlineexplicit

Constructs a KeyScheme from the specified scheme.

Parameters
schemeInputScheme mapping KeyCodes to actions

Member Function Documentation

virtual bool KeyScheme::handlesControllerEvent ( const ControllerEvent event) const
inlineoverridevirtual

Returns whether or not this KeyScheme would handle event.

Parameters
eventControllerEvent to check against the KeyScheme inputs

Implements InputScheme< KeyCode >.