vrfGuiJoystickControlManager.h

Go to the documentation of this file.

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




#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <joystickCore/joystickConfigurations.h>
#include <joystickCore/gameControlInformation.h>
#include <vrfGuiCore/guiSimObject.h>
#include <joystickCore/gameControllerEvents.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtUnicode.h>
#include <vrfutil/rwJoystickControls.h>
#include <vlpi/entityType.h>

#include <string>
#include <map>


#include <boost/function.hpp>
#include <boost/unordered_set.hpp>
#include <boost/unordered_map.hpp>

namespace makVrv
{
   class DtDe;
   class DtRecordSettingsBackupInterface;
}

struct _SDL_Joystick;
union SDL_Event;

class DtUUID;
class DtSimMessage;

namespace makVrf
{
   class DtGuiThreadVrfRemoteController;
   class DtVrfGuiJoystickControlHandler;

   class DT_DLL_VRFGUICORE DtVrfGuiJoystickControlManager : public makVrv::DtVirtualBaseClass
   {
   public:

      typedef std::map<DtString, std::map<DtString, DtRwJoystickControl> > JoystickControls;
      typedef std::map<DtString, JoystickControls> JoystickControlsMap;

      DtVrfGuiJoystickControlManager(makVrv::DtDe&);

      virtual ~DtVrfGuiJoystickControlManager() override;

      static DtVrfGuiJoystickControlManager& instance(makVrv::DtDe& de);

      static void registerInstance(makVrv::DtDe& de, DtVrfGuiJoystickControlManager*);

      virtual void requestJoystickControlInformation(const DtUUID&);

      virtual JoystickControls joystickControlInformation(makVrv::DtUniqueID) const;
      virtual JoystickControls joystickControlInformation(const DtUUID&) const;
      virtual JoystickControls joystickControlInformation(const DtEntityType&) const;
      virtual bool hasJoystickControlInformation(makVrv::DtUniqueID) const;
      virtual bool hasJoystickControlInformation(const DtUUID&) const;
      virtual bool hasJoystickControlInformation(const DtEntityType&) const;

      virtual void takeControlOf(makVrv::DtUniqueID, const std::string& configuration, const std::set<std::string>& functionalGroups);
      virtual void takeControlOf(const DtUUID&, const std::string& configuration, const std::set<std::string>& functionalGroups);

      virtual bool inControlOf(makVrv::DtUniqueID) const;
      virtual bool inControlOf(const DtUUID&) const;

      virtual bool inControlOf(const DtUUID&, const std::string&) const;

      virtual bool canAnyFunctionGroupBeAssigned(makVrv::DtUniqueID, const std::string& configuration) const;
      virtual bool canAnyFunctionGroupBeAssigned(const DtUUID&, const std::string& configuration) const;

      virtual void releaseControlOf(makVrv::DtUniqueID, const std::set<std::string>& functionalGroups = std::set<std::string>(),
         bool objectRemoved = false);
      virtual void releaseControlOf(const DtUUID&, const std::set<std::string>& functionalGroups = std::set<std::string>(),
         bool objectRemoved = false);

      virtual void releaseControlOfAll();

      const JoystickControlsMap& joystickControlsMap() const { return myJoystickControlsMap; };

      virtual std::set<std::string> uncontrolledFunctionGroups(makVrv::DtUniqueID) const;
      virtual std::set<std::string> uncontrolledFunctionGroups(const DtUUID&) const;

      virtual std::set<std::string> functionGroupsDefinedFor(makVrv::DtUniqueID) const;
      virtual std::set<std::string> functionGroupsDefinedFor(const DtUUID&) const;

      virtual bool canFunctionGroupBeAssigned(const DtUUID& uuid, 
         const std::string& configuration, const std::string& functionGroup) const;

      virtual bool canHaveJoystickControls(makVrv::DtUniqueID id) const;
      virtual bool canHaveJoystickControls(const DtUUID&) const;

      boost::signals2::signal<void (const DtUUID&, const std::string& configuration, const std::set<std::string>&)> signal_hasTakenControl;

      boost::signals2::signal<void (const DtUUID&, const std::set<std::string>&)> signal_hasReleasedControl;

      boost::signals2::signal<void (const DtEntityType&, const JoystickControls&)> signal_joystickControlsAdded;

   protected:
      virtual void initialize();
      virtual void slot_stateAdded(DtSimObjectReference sv);
      virtual void slot_stateRemoved(DtSimObjectReference sv);

      virtual void processJoystickControlsResponse(DtSimMessage*);

      virtual void cleanupHandlers();

   protected:
      makVrv::DtDe& myDe;

      makVrv::DtSignalConnectionManager myConnections;
      JoystickControlsMap myJoystickControlsMap;

      boost::unordered_set<DtUUID> myAwaitingResponses;

      DtGuiThreadVrfRemoteController& myRemoteController;

      typedef boost::unordered_map<DtUUID, DtVrfGuiJoystickControlHandler*> InControlOf;
      InControlOf myInControlOf;

      std::vector<DtVrfGuiJoystickControlHandler*> myCleanupQueue;
   };
}