Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::PCKeyboard Class Reference

#include <PCKeyboard.h>

Inheritance diagram for OSCAR::PCKeyboard:

Inheritance graph
[legend]
List of all members.

Public Methods

 PCKeyboard ()
 ~PCKeyboard ()
bool GetKeyState (int _key)
int UpdateVector (Vector &_input, const Vector &_deltas, int _quitKey=VK_ESCAPE)
int UpdateVector (Vector &_input, int _quitKey=VK_ESCAPE)

Constructor & Destructor Documentation

OSCAR::PCKeyboard::PCKeyboard  
 

OSCAR::PCKeyboard::~PCKeyboard  
 


Member Function Documentation

bool OSCAR::PCKeyboard::GetKeyState int    _key
 

int OSCAR::PCKeyboard::UpdateVector Vector   _input,
int    _quitKey = VK_ESCAPE
 

int OSCAR::PCKeyboard::UpdateVector Vector   _input,
const Vector   _deltas,
int    _quitKey = VK_ESCAPE
 

This function is used to update the _input vector by an amount specified in the _deltas vector.

Both the _input and the _deltas vector should be of the same size. The keys 1 thru = and keys a thru ; are used for positive increments and the keys q thru ] and keys z thru / are used for negative increments. The number of keys used depends on the size of the _input vector. If _input is changed, the return value is equal to the number of the element of _input that was changed. A -1 is returned if _input was not changed. The maximum size of _input vector can be 23 and if the size of _input is > 23 a -3 is returned. If the size of _input and _deltas is not the same a -2 is returned. If the _quitkey is pressed this method returns a -4


The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations