Changeset 7401 for code/trunk/src/libraries/core/input

Timestamp:

Sep 11, 2010, 12:34:00 AM (14 years ago)

Author:

landauf

Message:

merged doc branch back to trunk

Location:

code/trunk

Files:

• . (modified) (1 prop)
• src/libraries/core/input/Button.cc (modified) (1 diff)
• src/libraries/core/input/InputCommands.cc (modified) (1 diff)
• src/libraries/core/input/InputManager.cc (modified) (1 diff)
• src/libraries/core/input/InputManager.h (modified) (1 diff)
• src/libraries/core/input/InputState.h (modified) (1 diff)
• src/libraries/core/input/KeyBinder.cc (modified) (2 diffs)

code/trunk/src/libraries/core/input/Button.cc

@@ -176 +176 @@
                 // evaluate the command
                 CommandEvaluation eval = CommandExecutor::evaluate(commandStr);
-                if (!eval.isValid() || eval.evaluateParams(true))
+                if (!eval.isValid() || eval.evaluateArguments(true))
                 {
                     parseError("Command evaluation of \"" + commandStr + "\"failed.", true);

code/trunk/src/libraries/core/input/InputCommands.cc

@@ -53 +53 @@
         if (this->abs_ != 0.0f || this->rel_ != 0.0f)
         {
-            evaluation_.setEvaluatedParameter(paramIndex_, Vector2(abs_, rel_));
+            evaluation_.setEvaluatedArgument(paramIndex_, Vector2(abs_, rel_));
             // reset
             rel_ = 0.0;

code/trunk/src/libraries/core/input/InputManager.cc

@@ -140 +140 @@
         Creates the OIS::InputMananger, the keyboard, the mouse and
         the joys ticks. If either of the first two fail, this method throws an exception.
-    @param windowWidth
-        The width of the render window
-    @param windowHeight
-        The height of the render window
     */
     void InputManager::loadDevices()

code/trunk/src/libraries/core/input/InputManager.h

@@ -122 +122 @@
         @param name
             Unique name of the InputState when referenced as string
+        @param bAlwaysGetsInput
+            InputState always gets the input when activated
+        @param bTransparent
+            InputState will not prevent underlaying state from receiving input
         @param priority
             Priority matters when multiple states are active. You can specify any

code/trunk/src/libraries/core/input/InputState.h

@@ -128 +128 @@
         void resetExpiration() { bExpired_ = false; }
 
-        //! Updates one specific device handler with #device#Updated
+        //! Updates one specific device handler with deviceUpdated
         void update(float dt, unsigned int device);
         //! Updates all handlers with allDevicesUpdated

code/trunk/src/libraries/core/input/KeyBinder.cc

@@ -495 +495 @@
     @brief
         Event handler for the mouseMoved Event.
-    @param e
-        Mouse state information
+    @param abs_
+        The absolute position of the mouse
+    @param rel_
+        The relative movement of the mouse
+    @param clippingSize
+        Mouse screen area in pixels (usually 1024x1024)
     */
     void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
@@ -551 +555 @@
     /**
     @brief Event handler for the mouseScrolled Event.
-    @param e Mouse state information
+    @param abs The absolute position of the scroll wheel
+    @param rel The relative movement of the scroll wheel
     */
     void KeyBinder::mouseScrolled(int abs, int rel)