Changeset 3274 for code/branches/core4/src/core/input/JoyStick.cc

Timestamp:

Jul 12, 2009, 4:12:04 PM (16 years ago)

Author:

rgrieder

Message:

Added a few more generic parts to the input library:

• Created Mouse and Keyboard to join JoyStick and provided them with a templated base class (InputDeviceTemplated) that does most of the work (reduces quite some redundancy)
• Created InputPrereqs.h from InputInterfaces.h and destroyed the latter
• Exported InputHandler to its own file and replaced KeyHandler, MouseHandler and JoyStickHandler with the single InputHandler.
• Deleted the SimpleInputState: There is only one class now which fulfills all our needs.

In general there is now less code and the code itself has more 'pluses'. However I haven't really thrown away any feature at all.

File:

• code/branches/core4/src/core/input/JoyStick.cc (modified) (14 diffs)

code/branches/core4/src/core/input/JoyStick.cc

@@ -26 +26 @@
  *
  */
-
-/**
-@file
-@brief
-    Implementation of the JoyStick wrapper class.
-*/
 
 #include "JoyStick.h"
@@ -54 +48 @@
     void loadCalibration(std::vector<int>& list, const std::string& sectionName, const std::string& valueName, size_t size, int defaultValue);
 
-    JoyStick::JoyStick(const std::vector<InputState*>& states, unsigned int id)
-        : id_(id)
-        , bCalibrating_(false)
-        , inputStates_(states)
+    JoyStick::JoyStick(unsigned int id)
+        : super(id)
     {
         RegisterRootObject(JoyStick);
         this->setConfigValues();
-
-        OIS::InputManager* system = InputManager::getInstance().getInputSystem();
-        oisJoyStick_ = static_cast<OIS::JoyStick*>(system->createInputObject(OIS::OISJoyStick, true));
-        oisJoyStick_->setEventCallback(this);
+        // Initialise POV and Slider states
+        this->clearBuffersImpl();
 
         idString_ = "JoyStick_";
-        std::string name = oisJoyStick_->vendor();
+        std::string name = oisDevice_->vendor();
         replaceCharacters(name, ' ', '_');
         idString_ += name + "_";
-        idString_ += multi_cast<std::string>(oisJoyStick_->getNumberOfComponents(OIS::OIS_Button))  + "_";
-        idString_ += multi_cast<std::string>(oisJoyStick_->getNumberOfComponents(OIS::OIS_Axis))    + "_";
-        idString_ += multi_cast<std::string>(oisJoyStick_->getNumberOfComponents(OIS::OIS_Slider))  + "_";
-        idString_ += multi_cast<std::string>(oisJoyStick_->getNumberOfComponents(OIS::OIS_POV));
-        //idString_ += multi_cast<std::string>(oisJoyStick_->getNumberOfComponents(OIS::OIS_Vector3));
+        idString_ += multi_cast<std::string>(oisDevice_->getNumberOfComponents(OIS::OIS_Button))  + "_";
+        idString_ += multi_cast<std::string>(oisDevice_->getNumberOfComponents(OIS::OIS_Axis))    + "_";
+        idString_ += multi_cast<std::string>(oisDevice_->getNumberOfComponents(OIS::OIS_Slider))  + "_";
+        idString_ += multi_cast<std::string>(oisDevice_->getNumberOfComponents(OIS::OIS_POV));
+        //idString_ += multi_cast<std::string>(oisDevice_->getNumberOfComponents(OIS::OIS_Vector3));
 
         if (InputManager::getInstance().checkJoyStickID(idString_) == false)
         {
             // Make the ID unique for this execution time.
-            idString_ += "_" + multi_cast<std::string>(id_);
+            idString_ += "_" + multi_cast<std::string>(this->getDeviceID());
         }
 
@@ -85 +75 @@
 
         // Load calibration
-        size_t axes = sliderAxes_s + static_cast<size_t>(oisJoyStick_->getNumberOfComponents(OIS::OIS_Axis));
+        size_t axes = sliderAxes_s + static_cast<size_t>(oisDevice_->getNumberOfComponents(OIS::OIS_Axis));
         loadCalibration(configMinValues_,  idString_, "MinValue",  axes,  -32768);
         loadCalibration(configMaxValues_,  idString_, "MaxValue",  axes,   32768);
@@ -92 +82 @@
     }
 
-    JoyStick::~JoyStick()
-    {
-        try
-        {
-            OIS::InputManager* system = InputManager::getInstance().getInputSystem();
-            system->destroyInputObject(oisJoyStick_);
-        }
-        catch (...)
-        {
-            COUT(1) << "Joy stick destruction failed! Potential resource leak!" << std::endl;
-        }
-    }
-
-    /**
-    @brief
-        Callback for the joy stick calibration config file. @see setConfigValues.
-    */
+    //!< Callback for the joy stick calibration config file.
     void JoyStick::calibrationFileCallback()
     {
@@ -114 +88 @@
     }
 
-    /**
-    @brief
-        Sets the configurable values.
-    */
     void JoyStick::setConfigValues()
     {
@@ -140 +110 @@
         // fill the rest with default values
         for (unsigned int i = configValueVectorSize; i < size; ++i)
-        {
             list[i] = defaultValue;
-        }
-    }
-
-    void JoyStick::startCalibration()
-    {
-        bCalibrating_ = true;
-
+    }
+
+    //! Called by InputDevice when calibration mode has started
+    void JoyStick::calibrationStarted()
+    {
         // Set initial values
         BOOST_FOREACH(int& minVal, configMinValues_)
@@ -158 +125 @@
     }
 
-    void JoyStick::stopCalibration()
+    //! Called by InputDevice when calibration mode has stopped
+    void JoyStick::calibrationStopped()
     {
         // Get the middle positions now
@@ -164 +132 @@
         for (unsigned int i = 0; i < sliderAxes_s/2; ++i)
         {
-            configZeroValues_[iAxis++] = oisJoyStick_->getJoyStickState().mSliders[i].abX;
-            configZeroValues_[iAxis++] = oisJoyStick_->getJoyStickState().mSliders[i].abY;
-        }
-        // Note: joyStickMiddleValues_[iJoyStick] was already correctly resised in loadCalibration()
-        assert(oisJoyStick_->getJoyStickState().mAxes.size() == configZeroValues_.size() - sliderAxes_s);
+            configZeroValues_[iAxis++] = oisDevice_->getJoyStickState().mSliders[i].abX;
+            configZeroValues_[iAxis++] = oisDevice_->getJoyStickState().mSliders[i].abY;
+        }
+        // Note: joyStickZeroValues_[iJoyStick] was already correctly resised in loadCalibration()
+        assert(oisDevice_->getJoyStickState().mAxes.size() == configZeroValues_.size() - sliderAxes_s);
         for (unsigned int i = 0; i < configZeroValues_.size() - sliderAxes_s; ++i)
-            configZeroValues_[iAxis++] = oisJoyStick_->getJoyStickState().mAxes[i].abs;
+            configZeroValues_[iAxis++] = oisDevice_->getJoyStickState().mAxes[i].abs;
 
         for (unsigned int i = 0; i < configMinValues_.size(); ++i)
@@ -192 +160 @@
 
         this->evaluateCalibration();
-
-        bCalibrating_ = false;
-    }
-
+    }
+
+    //! Evaluates the accumulated values during calibration
     void JoyStick::evaluateCalibration()
     {
@@ -206 +173 @@
     }
 
-    void JoyStick::clearBuffer()
-    {
-        pressedButtons_.clear();
+    // TODO: What do we really need to reset here?
+    void JoyStick::clearBuffersImpl()
+    {
         for (int j = 0; j < 4; ++j)
         {
@@ -217 +184 @@
     }
 
-
-    // ###### Events ######
-
-    void JoyStick::capture()
-    {
-        oisJoyStick_->capture();
-
-        // call all the handlers for the held joy stick button events
-        for (unsigned int iButton = 0; iButton < pressedButtons_.size(); iButton++)
-        {
-            BOOST_FOREACH(InputState* state, inputStates_)
-                state->joyStickButtonHeld(id_, pressedButtons_[iButton]);
-        }
-    }
-
-    bool JoyStick::buttonPressed(const OIS::JoyStickEvent &arg, int button)
-    {
-        // check whether the button already is in the list (can happen when focus was lost)
-        unsigned int iButton = 0;
-        while (iButton < pressedButtons_.size() && pressedButtons_[iButton] != button)
-            iButton++;
-        if (iButton == pressedButtons_.size())
-            pressedButtons_.push_back(static_cast<JoyStickButtonCode::ByEnum>(button));
-
-        BOOST_FOREACH(InputState* state, inputStates_)
-            state->joyStickButtonPressed(id_, static_cast<JoyStickButtonCode::ByEnum>(button));
-
-        return true;
-    }
-
-    bool JoyStick::buttonReleased(const OIS::JoyStickEvent &arg, int button)
-    {
-        // remove the button from the pressedButtons_ list
-        for (unsigned int iButton = 0; iButton < pressedButtons_.size(); iButton++)
-        {
-            if (static_cast<int>(pressedButtons_[iButton]) == button)
-            {
-                pressedButtons_.erase(pressedButtons_.begin() + iButton);
-                break;
-            }
-        }
-
-        BOOST_FOREACH(InputState* state, inputStates_)
-            state->joyStickButtonPressed(id_, static_cast<JoyStickButtonCode::ByEnum>(button));
-
-        return true;
-    }
-
-    /**
-    @brief
-        Calls the states for a particular axis with our enumeration.
-        Used by OIS sliders and OIS axes.
-    */
+    //! Generic method to forward axis events
     void JoyStick::fireAxis(int axis, int value)
     {
-        if (bCalibrating_)
+        if (this->isCalibrating())
         {
             if (value < configMinValues_[axis])
@@ -288 +203 @@
 
             BOOST_FOREACH(InputState* state, inputStates_)
-                state->joyStickAxisMoved(id_, axis, fValue);
-        }
-    }
-
+                state->joyStickAxisMoved(this->getDeviceID(), axis, fValue);
+        }
+    }
+
+    //! OIS joy stick axis event handler
     bool JoyStick::axisMoved(const OIS::JoyStickEvent &arg, int axis)
     {
@@ -300 +216 @@
     }
 
+    //! A Slider always has an X and an Y direction!
     bool JoyStick::sliderMoved(const OIS::JoyStickEvent &arg, int id)
     {
@@ -310 +227 @@
     }
 
+    //! A POV is the big button that can point in all directions (but only in one at once)
     bool JoyStick::povMoved(const OIS::JoyStickEvent &arg, int id)
     {