artPartParamToStateAttrMap.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file artPartParamToStateAttrMap.h
//! \brief Defines the DtArtPartParamToStateAttrMap component that maps articulated part parameters to state attributes.
//!
//! This component enables mapping of DIS articulated part parameter values to state attributes
//! within the VR Engagement system. It processes simulation state messages to extract articulated
//! part information and update corresponding state attributes based on configured mappings.
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/entityControlLogic.h"
 
namespace makVre
{
 
namespace ArtPartParamToStateAttrMapConfig
{
//! \ingroup RoleConfigParams
//! \defgroup ArtPartParamToStateAttrMapRoleParams Art Part Param To State Attr Map Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for art part param to state attr map role.
//! @{
 
//! \vreRoleParam{artPartParameters,table,{},artPartParamToStateAttrMap,Table of articulated part parameter mappings defining which DIS art part types and parameter types map to which state attributes.}
constexpr const char* artPartParameters = "artPartParameters";
 
//! @}
} // namespace ArtPartParamToStateAttrMapConfig
 
//! \brief Type identifier for DtArtPartParamToStateAttrMap component
constexpr const char* DtArtPartParamToStateAttrMapType = "DtArtPartParamToStateAttrMap";
 
//! \brief Component for mapping DIS articulated part parameters to state attributes.
//!
//! The DtArtPartParamToStateAttrMap component enables a user to map DIS articulated part
//! parameter values to state attributes. This allows the application to access and use
//! articulation values (such as turret azimuth, gun elevation, etc.) from DIS simulation
//! entities through the standard state attribute system.
//!
//! Example Lua configuration:
//! \code
//! ["artPartParamToStateAttrMap"] = {
//!    componentType = "DtArtPartParamToStateAttrMap";
//!    priority = 5;
//!    artPartParameters = {
//!       {artPartType = 4096, parameterType = 10, stateAttributeName = "primaryTurretAzimuth"};
//!       {artPartType = 4416, parameterType = 12, stateAttributeName = "primaryGunElevation"};
//!    };
//! };
//! \endcode
class VRECOMMONCOMPONENTS_DLL DtArtPartParamToStateAttrMap : public makVre::DtPlayerComponent
{
public:
   //! \brief Constructor for DtArtPartParamToStateAttrMap
   //!
   //! Initializes the component with the name "DtArtPartParamToStateAttrMap".
   DtArtPartParamToStateAttrMap();
 
   //! \brief Virtual destructor for DtArtPartParamToStateAttrMap
   virtual ~DtArtPartParamToStateAttrMap() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Processes the provided configuration to create mappings between articulated part types,
   //! parameter types, and state attribute names. Also registers a handler for simulation state messages.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters, especially the artPartParameters table
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates the component state (empty implementation)
   //!
   //! This method is called each frame, but currently has no implementation for this component.
   //!
   //! \param dt Delta time in seconds since the last tick
   virtual void tick(double dt) override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtArtPartParamToStateAttrMap
   virtual const char* type() const override;
 
protected:
   //! \brief Handles simulation state messages
   //!
   //! Processes simulation state messages to extract articulated part parameters and
   //! updates corresponding state attributes based on the configured mappings.
   //!
   //! \param msg The simulation state message to process
   //! \return HANDLED if the message was successfully processed
   virtual makVre::DtVreMessageResult handleSimState(makVre::DtVreMessage* msg);
 
   //! \brief Shuts down the component
   //!
   //! Removes the simulation state message handler.
   virtual void shutdown() override;
 
   //! \brief Structure defining mapping between an articulated part parameter and a state attribute
   using ArtPartParamStateAttrDescriptor = struct ArtPartParamStateAttrDescriptor
   {
      //! \brief DIS parameter type enumeration value
      //!
      //! Valid values include:
      //! - 0: POSITION
      //! - 1: POSITIONRATE
      //! - 2: EXTENSION
      //! - 3: EXTENSIONRATE
      //! - 4: X
      //! - 5: XRATE
      //! - 6: Y
      //! - 7: YRATE
      //! - 8: Z
      //! - 9: ZRATE
      //! - 10: AZIMUTH
      //! - 11: AZIMUTHRATE
      //! - 12: ELEVATION
      //! - 13: ELEVATIONRATE
      //! - 14: ROTATION
      //! - 15: ROTATIONRATE
      int parameterType;
 
      //! \brief Name of the state attribute to hold the parameter value
      std::string stateAttributeName;
   };
 
   //! \brief Map of art part type to parameter/state attribute descriptor
   //!
   //! The map keys are DIS articulated part type enumeration values,
   //! and the values are ArtPartParamStateAttrDescriptor structures.
   std::map<int, ArtPartParamStateAttrDescriptor> myArtPartParameterMap;
};
} // namespace makVre