joystickConfigurations.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/



#pragma once

#include <joystickCore/joystickCore.h>
#include <joystickCore/joystickConfigurationSettings.h>

#include <boost/function.hpp>
#include <boost/unordered_map.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/archive/xml_iarchive.hpp>

#include <set>

namespace makVrv
{   
   class DtUnicode;

   class DT_DLL_JOYSTICKCORE DtFunctionGroupInformation
   {
   public:
      DtFunctionGroupInformation();
      DtFunctionGroupInformation(const DtFunctionGroupInformation&);

      virtual ~DtFunctionGroupInformation();

      DtFunctionGroupInformation& operator=(const DtFunctionGroupInformation&);

      bool operator==(const DtFunctionGroupInformation&) const;
      bool operator!=(const DtFunctionGroupInformation& rhs) { return !(*this == rhs); };

      void setNeedsTransition(bool);
      bool needsTransition() const;

      void setCycle(bool);
      bool cycle() const;

      void setMinimumValue(double);
      double minimumValue() const;

      void setMaximumValue(double);
      double maximumValue() const;

      void setDescription(const std::string&);
      const std::string& description() const;

      bool isSimilarTo(const DtFunctionGroupInformation&) const;

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myNeedsTransition);
         ar & BOOST_SERIALIZATION_NVP(myCycle);
         ar & BOOST_SERIALIZATION_NVP(myMinimumValue);
         ar & BOOST_SERIALIZATION_NVP(myMaximumValue);
         ar & BOOST_SERIALIZATION_NVP(myDescription);
      }

   protected:
      bool myNeedsTransition;
      bool myCycle;
      double myMinimumValue;
      double myMaximumValue;
      std::string myDescription;
   };

   class DT_DLL_JOYSTICKCORE DtJoystickConfigurationSettings
   {
   public:
      typedef std::map<std::string, DtJoystickConfigurationSetting> SettingsByFunctionCode;
      typedef std::map<std::string, SettingsByFunctionCode> JoystickConfigurationSettings;

      struct GameControl
      {
         std::string functionGroup;
         std::string function;
         DtGameControlInformation controlInformation;
      };

      typedef std::vector<GameControl> GameControlInformation;

      DtJoystickConfigurationSettings();
      DtJoystickConfigurationSettings(const DtJoystickConfigurationSettings&);

      ~DtJoystickConfigurationSettings();

      DtUnicode gameControllerName(const std::string& functionGroup,
         const std::string& function) const;

      DtUnicode gameControllerFunction(const std::string& functionGroup,
         const std::string& function) const;

      const JoystickConfigurationSettings& joystickConfigurationSettings() const { return myJoystickConfigurationSettings; };

      GameControlInformation gameControlInformation(const std::string& fg) const;

      bool addSwitchGroup(const std::string&);

      bool addOrUpdateJoystickControl(const std::string& functionGroup, const std::string& function);

      DtGameControlInformation gameControlInformationFor(
         const std::string& functionGroup, const std::string& function) const;

      bool removeGameControlInformationFor(const std::string& functionGroup, const std::string& function);

      DtJoystickConfigurationSetting addGameControlInformationFor(const std::string& functionGroup, const std::string& function,
         const DtGameControlInformation&);

      bool functionGroupSpecified(const std::string& functionGroup,
         bool all = false) const;

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myJoystickConfigurationSettings);
      }

   protected:
      JoystickConfigurationSettings myJoystickConfigurationSettings;
   };

   class DT_DLL_JOYSTICKCORE DtGameControllerFunctionGroups
   {
   public:
      typedef std::map<std::string, DtFunctionGroupInformation> FunctionCodeMap;
      typedef std::map<std::string, FunctionCodeMap> FunctionGroups;

      DtGameControllerFunctionGroups();
      DtGameControllerFunctionGroups(const DtGameControllerFunctionGroups&);

      virtual ~DtGameControllerFunctionGroups();

      DtGameControllerFunctionGroups& operator=(const DtGameControllerFunctionGroups&);

      std::string descriptionFor(const std::string& functionGroup, const std::string& function) const;

      std::set<std::string> functionGroupsSimilarTo(const std::string& functionGroup) const;

      bool needsTransition(const std::string& functionalGroup, const std::string& function) const;

      bool cycle(const std::string& functionalGroup, const std::string& function) const;

      bool toggle(const std::string& functionalGroup, const std::string& function) const;

      void getFunctionMinMaxValues(const std::string& functionalGroup, const std::string& function,
         double& min, double& max) const;

      bool addOrUpdateFunctionGroupInformation(const std::string& functionGroup, const std::string& function,
         const DtFunctionGroupInformation&);

      DtJoystickConfigurationSettings createNewSettings() const;

      std::vector<std::string> functionsForFunctionGroup(const std::string&) const;

      const FunctionGroups& functionGroups() const { return myFunctionGroups; };

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myFunctionGroups);
      }

   protected:
      FunctionGroups myFunctionGroups;
   };

   class DT_DLL_JOYSTICKCORE DtJoystickConfigurations
   {
   public:
      typedef std::map<std::string, DtJoystickConfigurationSettings> JoystickConfigurations;

      DtJoystickConfigurations();
      DtJoystickConfigurations(const DtJoystickConfigurations&);

      ~DtJoystickConfigurations();

      DtUnicode gameControllerName(const std::string& controller, const std::string& functionGroup,
         const std::string& function) const;

      DtUnicode gameControllerFunction(const std::string& configuration, const std::string& functionGroup,
         const std::string& function) const;

      void setJoystickSettingsForConfiguration(const std::string& s, const DtJoystickConfigurationSettings& c);

      bool joystickSettingsForConfiguration(const std::string& s, DtJoystickConfigurationSettings& c);

      std::vector<std::string> configurations() const;

      virtual std::string descriptionFor(const std::string& functionGroup, const std::string& function) const;

      DtGameControlInformation gameControlInformationFor(const std::string& configuration,
         const std::string& functionGroup, const std::string& function) const;

      DtJoystickConfigurationSetting addGameControlInformationFor(
         const std::string& configuration, const std::string& functionGroup, const std::string& function,
         const DtGameControlInformation&);

      bool removeGameControlInformationFor(const std::string& configuration,
         const std::string& functionGroup, const std::string& function);

      const JoystickConfigurations& joystickConfiguration() const { return myJoystickConfigurations; };
      const DtGameControllerFunctionGroups& gameControllerFunctionGroups() const { return myGameControllerFunctionGroups; };

      DtJoystickConfigurationSettings::GameControlInformation gameControlInformation(
         const std::string& configuration, const std::string& fg) const;

      DtJoystickConfigurationSettings::GameControlInformation gameControlInformation(
         const std::string& configuration, const std::set<std::string>& fg) const;

      bool needsTransition(const std::string& functionalGroup, const std::string& function) const;

      bool cycle(const std::string& functionalGroup, const std::string& function) const;

      bool toggle(const std::string& functionalGroup, const std::string& function) const;

      void getFunctionMinMaxValues(const std::string& functionalGroup, const std::string& function,
         double& min, double& max) const;

      bool addOrUpdateJoystickControl(const std::string& functionGroup, const std::string& function,
         const DtFunctionGroupInformation&);

      std::set<std::string> availableFunctionGroups() const;

      std::vector<std::string> functionsForFunctionGroup(const std::string&) const;

      std::set<std::string> functionGroupsSimilarTo(const std::string& functionGroup) const;

      bool renameConfiguration(const std::string& old, const std::string& renamed);

      bool switchControlActive(const std::string& configuration, const std::string& switchGroup) const;

      bool functionGroupSpecified(const std::string& configuration, const std::string& functionGroup,
         bool all = false) const;

      bool hasAnyFunctionGroupAvailable(const std::string& configuration, bool all = false) const;

      bool hasConfigurationName(const std::string&) const;

      void addConfiguration(const std::string&);

      bool removeConfiguration(const std::string&);

      void setFavorite(const std::string&);
      const std::string& favorite() const;

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myFavorite);
         ar & BOOST_SERIALIZATION_NVP(myGameControllerFunctionGroups);
         ar & BOOST_SERIALIZATION_NVP(myJoystickConfigurations);
      }

   protected:
      DtGameControllerFunctionGroups myGameControllerFunctionGroups;
      JoystickConfigurations myJoystickConfigurations;
      std::string myFavorite;
   };
}