Changeset 4452 in orxonox.OLD for orxonox/trunk/src/util/event/key_mapper.cc

Timestamp:

Jun 1, 2005, 11:18:44 PM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: key_mapper.* commented and reviewed

File:

• orxonox/trunk/src/util/event/key_mapper.cc (modified) (6 diffs)

orxonox/trunk/src/util/event/key_mapper.cc

@@ -27 +27 @@
 
 
-
-int KeyMapper::PEV_UP = -1;
-int KeyMapper::PEV_DOWN = -1;
-int KeyMapper::PEV_LEFT = -1;
-int KeyMapper::PEV_RIGHT = -1;
-int KeyMapper::PEV_STRAFE_LEFT = -1;
-int KeyMapper::PEV_STRAFE_RIGHT = -1;
-
-int KeyMapper::PEV_FIRE1 = -1;
-int KeyMapper::PEV_FIRE2 = -1;
-int KeyMapper::PEV_PREVIOUS_WEAPON = -1;
-int KeyMapper::PEV_NEXT_WEAPON = -1;
-
-int KeyMapper::PEV_VIEW0 = -1;
-int KeyMapper::PEV_VIEW1 = -1;
-int KeyMapper::PEV_VIEW2 = -1;
-int KeyMapper::PEV_VIEW3 = -1;
-int KeyMapper::PEV_VIEW4 = -1;
-int KeyMapper::PEV_VIEW5 = -1; 
-
-int KeyMapper::PEV_NEXT_WORLD = -1;
-int KeyMapper::PEV_PREVIOUS_WORLD = -1;
-
-int KeyMapper::PEV_PAUSE = -1;
-int KeyMapper::PEV_QUIT = -1;
-
-
-
-
+/* initialize all variables to a reasonable value*/
+int KeyMapper::PEV_UP                = EV_UNKNOWN;
+int KeyMapper::PEV_DOWN              = EV_UNKNOWN;
+int KeyMapper::PEV_LEFT              = EV_UNKNOWN;
+int KeyMapper::PEV_RIGHT             = EV_UNKNOWN;
+int KeyMapper::PEV_STRAFE_LEFT       = EV_UNKNOWN;
+int KeyMapper::PEV_STRAFE_RIGHT      = EV_UNKNOWN;
+
+int KeyMapper::PEV_FIRE1             = EV_UNKNOWN;
+int KeyMapper::PEV_FIRE2             = EV_UNKNOWN;
+int KeyMapper::PEV_PREVIOUS_WEAPON   = EV_UNKNOWN;
+int KeyMapper::PEV_NEXT_WEAPON       = EV_UNKNOWN;
+
+int KeyMapper::PEV_VIEW0             = EV_UNKNOWN;
+int KeyMapper::PEV_VIEW1             = EV_UNKNOWN;
+int KeyMapper::PEV_VIEW2             = EV_UNKNOWN;
+int KeyMapper::PEV_VIEW3             = EV_UNKNOWN;
+int KeyMapper::PEV_VIEW4             = EV_UNKNOWN;
+int KeyMapper::PEV_VIEW5             = EV_UNKNOWN; 
+
+int KeyMapper::PEV_NEXT_WORLD        = EV_UNKNOWN;
+int KeyMapper::PEV_PREVIOUS_WORLD    = EV_UNKNOWN;
+
+int KeyMapper::PEV_PAUSE             = EV_UNKNOWN;
+int KeyMapper::PEV_QUIT              = EV_UNKNOWN;
+
+
+
+//! this is the mapping array from names to ids: enter all orxonox.conf keys here
 orxKeyMapping map[] = { {&KeyMapper::PEV_UP, "Up"},
                         {&KeyMapper::PEV_DOWN, "Down"},
@@ -85 +85 @@
 
 
+
 /**
    \brief standard constructor
-   \todo this constructor is not jet implemented - do it
 */
 KeyMapper::KeyMapper () 
@@ -97 +97 @@
 /**
    \brief standard deconstructor
-
 */
 KeyMapper::~KeyMapper () 
 {
-  // delete what has to be deleted here
-}
-
-\
+}
+
+
+
 /**
    \brief loads new key bindings from a file
@@ -185 +184 @@
 
 
-
+/**
+   \brief this function looks up name to key index
+   \param the name of the button
+*/
 int* KeyMapper::nameToIndex (char* name)
 {
@@ -205 +207 @@
 
 
-
+/**
+   \brief the function maps name to key ids
+   \param name of the key
+   \param id of the key
+*/
 void KeyMapper::mapKeys(char* name, int keyID)
 {
@@ -216 +222 @@
 
 
+/**
+   \brief this function gives some debug information about the key mapper class
+*/
 void KeyMapper::debug()
 {
-  //PRINT(0)("\n==========================| KeyMapper::debug() |===\n");  
-
+  PRINT(0)("\n==========================| KeyMapper::debug() |===\n");  
   for(int i = 0; map[i].pValue != NULL; ++i)
     {
       PRINT(0)("%s = %i\n",map[i].pName, *map[i].pValue);
     }
-
-  //PRINT(0)("=======================================================\n");        
-}
+  PRINT(0)("=======================================================\n");        
+}