PGE Engine
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Controller Class Reference

The Controller class provides proxy interface between controllable objects array and physical controller (keyboard/joystick) or vitual controller (for example cut-scene actor controller at lua-side) More...

#include <controller.h>

Inheritance diagram for Controller:
JoystickController KeyboardController

Public Types

enum  commands {
  key_start =0, key_left, key_right, key_up,
  key_down, key_run, key_jump, key_altrun,
  key_altjump, key_drop
}
 Control key command codes.
 

Public Member Functions

 Controller ()
 Constructor.
 
virtual ~Controller ()
 Desctructor.
 
virtual void setKeyMap (KeyMap map)
 Accepts control keys map which will associates physical keys of control device and command code. More...
 
void resetControls ()
 Sends "unpressed" control key states map to every registered controllable object.
 
void sendControls ()
 Sends current control key states map to every registered controllable object.
 
virtual void update ()
 Updates controllable object: read key states from controllable device and apply gotten key states to every registered controllable object.
 
void registerInControl (ControllableObject *obj)
 Register controllable object to this controller. More...
 
void removeFromControl (ControllableObject *obj)
 Remove controllable object from this controller. More...
 

Static Public Member Functions

static controller_keys noKeys ()
 Initializes a control key states map with unpressed key states. More...
 

Public Attributes

controller_keys keys
 Current state of control keys.
 

Protected Attributes

KeyMap kmap
 Current control keys map.
 

Detailed Description

The Controller class provides proxy interface between controllable objects array and physical controller (keyboard/joystick) or vitual controller (for example cut-scene actor controller at lua-side)

Member Function Documentation

controller_keys Controller::noKeys ( )
static

Initializes a control key states map with unpressed key states.

Returns
the initialized control key map structure with unpressed key states
void Controller::registerInControl ( ControllableObject obj)

Register controllable object to this controller.

Parameters
objPointer to controllable object
void Controller::removeFromControl ( ControllableObject obj)

Remove controllable object from this controller.

Parameters
objPointer to controllable object which must be removed from this controller
void Controller::setKeyMap ( KeyMap  map)
virtual

Accepts control keys map which will associates physical keys of control device and command code.

Parameters
Controlkeys map

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