vreSensorModeMapper.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSensorModeMapper.h
//! \brief Defines a mapper for translating between sensor mode identifiers
//!
//! This file contains the DtVreSensorModeMapper class which provides a way to
//! refer to VR-Vantage sensor modes independently of whether the application
//! is running in CameraFX or SensorFX mode. It maps generic sensor mode
//! identifiers used in VR-Engage to the specific mode names required by the
//! VR-Vantage API based on the current sensor library configuration.
 
#include "vrePlayerStation/export.h"
 
#include "vrePlayerStation/playerStationApp.h"
 
#include <string>
#include <map>
 
namespace makVre
{
//! \brief Structure to hold sensor mode names for different sensor libraries
//!
//! DtVrvSensorModes stores the corresponding sensor mode names for both
//! CameraFX and SensorFX libraries. These names match the <myName> entries
//! found in the default_SensorModes.sfx configuration file in VR-Vantage.
using DtVrvSensorModes = struct _DtVrvSensorModes
{
   std::string sensorModeCameraFX; //!< Sensor mode name for CameraFX library
   std::string sensorModeSensorFX; //!< Sensor mode name for SensorFX library
};
 
//! \brief Type definition for a map of sensor mode identifiers to mode names
using DtVreSensorModeTable = std::map<std::string, DtVrvSensorModes>;
 
//! \brief Mapper for translating between sensor mode identifiers and actual mode names
//!
//! DtVreSensorModeMapper provides a way to use generic identifiers for sensor
//! modes in VR-Engage while properly translating them to the specific sensor mode
//! names required by VR-Vantage, which differ between CameraFX and SensorFX modes.
//! This allows VR-Engage configuration to remain independent of the underlying
//! visualization engine's sensor library implementation.
class PLAYERSTATION_DLL DtVreSensorModeMapper
{
public:
   //! \brief Constructor
   //! \param sensorLibrary The sensor library currently in use (CAMERA_FX or SENSOR_FX)
   //!
   //! Creates a new sensor mode mapper configured for the specified sensor library.
   //! Any sensor mode lookups will return the corresponding VR-Vantage sensor
   //! mode name for this sensor library.
   DtVreSensorModeMapper(DtSensorLibrary sensorLibrary);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the sensor mode mapper.
   ~DtVreSensorModeMapper();
 
   //! \brief Initializes the mapper with sensor mode mappings
   //! \param initTable LUA table containing sensor mode mappings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Initializes the table of key strings and their corresponding CameraFX/SensorFX
   //! VR-Vantage sensor mode names from the provided LUA table. The initTable
   //! parameter is typically the 'vreSensorModeMapper' table defined in
   //! playerStation.lua. Note that not every entry will have both CameraFX and
   //! SensorFX mappings, as there is not a perfect one-to-one correspondence
   //! between the sensor modes available in each library.
   virtual bool initialize(DtInitTable& initTable);
 
   //! \brief Looks up the VR-Vantage sensor mode name for a generic identifier
   //! \param key Generic sensor mode identifier
   //! \return VR-Vantage sensor mode name, or empty string if not found
   //!
   //! Translates a generic sensor mode identifier to the appropriate VR-Vantage
   //! sensor mode name based on the current sensor library configuration. For example,
   //! if the key string passed in is "IR" and the sensor library is SENSOR_FX, then
   //! the returned sensor mode might be "LWIR (SensorFX)". If the requested mode
   //! is not available in the current sensor library, an empty string is returned.
   virtual std::string lookup(std::string key) const;
 
private:
   //! \brief Copy constructor (deleted)
   //!
   //! Copy construction is not supported for this class.
   DtVreSensorModeMapper(const DtVreSensorModeMapper& orig);
 
   //! \brief Assignment operator (deleted)
   //!
   //! Assignment is not supported for this class.
   DtVreSensorModeMapper& operator=(const DtVreSensorModeMapper& orig);
 
protected:
   //! \brief Current sensor library configuration
   //!
   //! Stores which sensor library (CAMERA_FX or SENSOR_FX) is currently in use
   //! in the application. This determines which set of sensor mode names
   //! will be used during lookup operations.
   DtSensorLibrary mySensorLibrary;
 
   //! \brief Table mapping generic identifiers to sensor mode names
   //!
   //! Table of DtVrvSensorMode entries, indexed by generic string identifiers.
   //! These identifiers provide an abstraction layer for configuring sensor
   //! modes in VR-Engage independent of whether CameraFX or SensorFX is being used.
   DtVreSensorModeTable mySensorModeTable;
};
} // namespace makVre