glsVreMessageUtil.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file glsVreMessageUtil.h
//! \brief Utility functions for sending VR-Engage messages from GL Studio components
//!
//! This file provides helper functions for sending common VR-Engage messages
//! from GL Studio instrument panel code. It simplifies message creation and
//! queuing for joystick inputs, SAR requests, radar controls, and other
//! cockpit-related functionality.
 
#pragma once
 
// VR-Engage includes
#include <vreMessageManager/vreMessageManager.h>
#include <vreMessages/joystick.h>
#include <vreMessages/vrfTaskEntityScript.h>
#include <vreMessages/vrfSetLightState.h>
#include <vreMessages/RequestSimulationState.h>
#include <vreMessages/windowOperation.h>
#include <vreMessages/vrfTakeControlOf.h>
#include <vreMessages/vrfReleaseControlOf.h>
#include <vreMessages/generateSarRequest.h>
#include <vreMessages/cockpitInitialized.h>
#include <vreMessages/setGimbalOverlaySections.h>
#include <vreMessages/restoreGimbalOverlaySections.h>
#include <vreMessages/minimapStartZoomIn.h>
#include <vreMessages/minimapStopZoomIn.h>
#include <vreMessages/minimapStartZoomOut.h>
#include <vreMessages/minimapStopZoomOut.h>
#include <vreMessages/glsConfigRequest.h>
#include <vreMessages/rwrSetSoundsEnabled.h>
#include <vreMessages/rwrSetEnabled.h>
#include <vreMessages/rwrPlaySound.h>
#include <vreMessages/SetRadarModeAndSubmode.h>
#include <vreMessages/gimbalCycleSensorMode.h>
#include <vreMessages/subscribeToBoss.h>
#include <vreMessages/unsubscribeFromBoss.h>
#include <vreUtil/logger.h>
 
// VR-Link includes
#include <vlpi/entityIdentifier.h>
 
#include <string>
 
namespace makVre
{
   //! Send a joystick message to the ownship entity.
   static inline void sendJoystickMessage(const DtEntityIdentifier& entity,
                                          const std::string& functionGroup, const std::string& function,
                                          double value, bool repeat = false)
   {
      JoystickMessage* msg = JoystickMessage::create();
 
      msg->setEntityId(entity);
      msg->setFunctionGroup(functionGroup);
      msg->setFunction(function);
      msg->setValue(value);
      msg->setRepeat(repeat);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Sends a SAR request using current SAR manager settings.
   static inline void sendSarRequest()
   {
      DtVreMessageManager::instance().queueMessage(GenerateSarRequestMessage::create());
   }
 
   //! Start a raise security gate task on the specified gate entity.
   static inline void raiseGate(const DtEntityIdentifier& entity)
   {
      VrfScriptedEntityTaskMessage* msg = VrfScriptedEntityTaskMessage::create();
 
      msg->setEntityId(entity);
      msg->setScriptName("Raise_Security_Gate");
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Start a lower security gate task on the specified gate entity.
   static inline void lowerGate(const DtEntityIdentifier& entity)
   {
      VrfScriptedEntityTaskMessage* msg = VrfScriptedEntityTaskMessage::create();
 
      msg->setEntityId(entity);
      msg->setScriptName("Lower_Security_Gate");
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Set state for a light on an entity.
   static inline void setLightState(const DtEntityIdentifier& entity, int light, bool state)
   {
      VrfSetLightStateMessage* msg = VrfSetLightStateMessage::create();
 
      msg->setEntityId(entity);
      std::vector<int> lights;
      lights.push_back(light);
      msg->setLights(lights);
      msg->setState(state);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Requests a SimulationStateMessage for the specified entity.
   static inline void requestSimState(const DtEntityIdentifier& entity)
   {
      RequestSimulationStateMessage* msg = RequestSimulationStateMessage::create();
 
      msg->setEntityId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Creates a gimbal view window. Once created, a RenderTextureInitializedMessage is sent when this operation is complete.
   static inline void createGimbalView(const DtEntityIdentifier& entity, int width, int height, const std::string& sensorMode)
   {
      WindowOperationMessage* msg = WindowOperationMessage::create();
 
      msg->setOperation(makVre::WindowOperationMessage::OperationType_Create);
      msg->setWindowType(makVre::WindowOperationMessage::WindowType_Gimbal);
      msg->setOwnshipEntityId(entity);
      msg->setWindowPosition(DtVector(10000, 10000, 0));
      msg->setWindowSize(DtVector(width, height, 0.0));
      msg->setIsFullScreen(false);
      msg->setSensorMode(sensorMode);
      msg->setScreen(0);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Destroy a gimbal view window.
   static inline void destroyGimbalView(const DtEntityIdentifier& entity)
   {
      WindowOperationMessage* msg = WindowOperationMessage::create();
 
      msg->setOwnshipEntityId(entity);
      msg->setOperation(makVre::WindowOperationMessage::OperationType_Destroy);
      msg->setWindowType(makVre::WindowOperationMessage::WindowType_Gimbal);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void modifyGimbalView(const DtEntityIdentifier& entity, const std::string& sensorMode)
   {
      WindowOperationMessage* msg = WindowOperationMessage::create();
 
      msg->setOperation(makVre::WindowOperationMessage::OperationType_Modify);
      msg->setWindowType(makVre::WindowOperationMessage::WindowType_Gimbal);
      msg->setOwnshipEntityId(entity);
      msg->setSensorMode(sensorMode);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void cycleGimbalView(const DtEntityIdentifier& entity)
   {
      GimbalCycleSensorModeMessage* msg = GimbalCycleSensorModeMessage::create();
 
      msg->setHostId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Creates a plan view window. Once created, a RenderTextureInitializedMessage is sent when this operation is complete.
   static inline void createPlanView(const DtEntityIdentifier& entity, int width, int height)
   {
      WindowOperationMessage* msg = WindowOperationMessage::create();
 
      msg->setOperation(makVre::WindowOperationMessage::OperationType_Create);
      msg->setWindowType(makVre::WindowOperationMessage::WindowType_PVD);
      msg->setOwnshipEntityId(entity);
      msg->setWindowPosition(DtVector(10000, 10000, 0));
      msg->setWindowSize(DtVector(width, height, 0.0));
      msg->setIsFullScreen(false);
      msg->setScreen(0);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Destroy a plan view window.
   static inline void destroyPlanView(const DtEntityIdentifier& entity)
   {
      WindowOperationMessage* msg = WindowOperationMessage::create();
 
      msg->setOwnshipEntityId(entity);
      msg->setOperation(makVre::WindowOperationMessage::OperationType_Destroy);
      msg->setWindowType(makVre::WindowOperationMessage::WindowType_PVD);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Take joystick control of an entity, for specific function groups and roles.
   static inline void takeControlOf(const DtEntityIdentifier& entity,
                                    const std::vector<std::string>& functionGroups,
                                    const std::vector<std::string>& roles)
   {
      VrfTakeControlOfMessage* msg = VrfTakeControlOfMessage::create();
 
      msg->setEntityId(entity);
      msg->setFunctionGroups(functionGroups);
      msg->setRoles(roles);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Release all joystick control for an entity.
   static inline void releaseControlOf(const DtEntityIdentifier& entity)
   {
      VrfReleaseControlOfMessage* msg = VrfReleaseControlOfMessage::create();
 
      msg->setEntityId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Sends a message confirming the cockpit has been initialized.
   static inline void sendCockpitInitialized(const std::string& cockpitName)
   {
      CockpitInitializedMessage* msg = CockpitInitializedMessage::create();
 
      msg->setName(cockpitName);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void setOverlaySections(const std::vector<std::string>& sections)
   {
      SetGimbalOverlaySectionsMessage* msg = SetGimbalOverlaySectionsMessage::create();
 
      msg->setOverlaySections(sections);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void restoreOverlaySections()
   {
      DtVreMessageManager::instance().queueMessage(RestoreGimbalOverlaySectionsMessage::create());
   }
 
   static inline void startMapZoomIn(const DtEntityIdentifier& entity)
   {
      MinimapStartZoomInMessage* msg = MinimapStartZoomInMessage::create();
 
      msg->setHostId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void startMapZoomOut(const DtEntityIdentifier& entity)
   {
      MinimapStartZoomOutMessage* msg = MinimapStartZoomOutMessage::create();
 
      msg->setHostId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void stopMapZoomIn(const DtEntityIdentifier& entity)
   {
      MinimapStopZoomInMessage* msg = MinimapStopZoomInMessage::create();
 
      msg->setHostId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void stopMapZoomOut(const DtEntityIdentifier& entity)
   {
      MinimapStopZoomOutMessage* msg = MinimapStopZoomOutMessage::create();
 
      msg->setHostId(entity);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   //! Requests any configuration specific to this panel (see the "instrumentPanels" block in pilot.lua for
   //! the configuration).
   static inline void requestGlsConfig(const DtEntityIdentifier& entity, const std::string& panelId)
   {
      GlsConfigRequestMessage* msg = GlsConfigRequestMessage::create();
 
      msg->setHostId(entity);
      msg->setPanelId(panelId);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void sendSetRwrEnabledMessage(const DtEntityIdentifier& entity, bool enabled)
   {
      RwrSetEnabledMessage* msg = RwrSetEnabledMessage::create();
 
      msg->setHostId(entity);
      msg->setEnabled(enabled);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void setRwrSoundsEnabled(bool enabled)
   {
      RwrSetSoundsEnabledMessage* msg = RwrSetSoundsEnabledMessage::create();
 
      msg->setSoundsEnabled(enabled);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void playRwrSound(const std::string& sound)
   {
      RwrPlaySoundMessage* msg = RwrPlaySoundMessage::create();
 
      msg->setPlayRwrSound(sound);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void setRadarModeAndSubmode(const DtEntityIdentifier& hostId,
                                             const std::string& mode, const std::string& submode, int sttTarget = -1)
   {
      SetRadarModeAndSubmodeMessage* msg = SetRadarModeAndSubmodeMessage::create();
 
      msg->setHostId(hostId);
      msg->setMode(mode);
      msg->setSubMode(submode);
      msg->setSttTarget(sttTarget);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void subscribeToBoss(const std::string& messageType)
   {
      SubscribeToBossMessage* msg = SubscribeToBossMessage::create();
 
      msg->setMessageName(messageType);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
 
   static inline void unsubscribeFromBoss(const std::string& messageType)
   {
      UnsubscribeFromBossMessage* msg = UnsubscribeFromBossMessage::create();
 
      msg->setMessageName(messageType);
 
      DtVreMessageManager::instance().queueMessage(msg);;
   }
}