VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtVreObserverModeMapper Class Reference

Detailed Description

DtVreObserverModeMapper provides a way to use generic identifiers for observer modes in VR-Engage while properly translating them to the specific observer 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.

#include <vreObserverModeMapper.h>

Public Member Functions

 DtVreObserverModeMapper (DtSensorLibrary sensorLibrary)
 
 ~DtVreObserverModeMapper ()
 
virtual bool initialize (DtInitTable &initTable)
 
virtual std::string lookup (std::string key) const
 

Protected Attributes

DtSensorLibrary mySensorLibrary
 
DtVreObserveModeTable myObserverModeTable
 

Private Member Functions

 DtVreObserverModeMapper (const DtVreObserverModeMapper &orig)
 
DtVreObserverModeMapperoperator= (const DtVreObserverModeMapper &orig)
 

Constructor & Destructor Documentation

◆ DtVreObserverModeMapper() [1/2]

makVre::DtVreObserverModeMapper::DtVreObserverModeMapper ( DtSensorLibrary sensorLibrary)

Constructor.

Parameters
sensorLibraryThe sensor library currently in use (CAMERA_FX or SENSOR_FX)

Creates a new observer mode mapper configured for the specified sensor library. Any observer mode lookups will return the corresponding VR-Vantage observer mode name for this sensor library.

Referenced by DtVreObserverModeMapper(), and operator=().

◆ ~DtVreObserverModeMapper()

makVre::DtVreObserverModeMapper::~DtVreObserverModeMapper ( )

Destructor.

Cleans up resources used by the observer mode mapper.

◆ DtVreObserverModeMapper() [2/2]

makVre::DtVreObserverModeMapper::DtVreObserverModeMapper ( const DtVreObserverModeMapper & orig)
private

Copy constructor (deleted)

Copy construction is not supported for this class.

References DtVreObserverModeMapper().

Member Function Documentation

◆ initialize()

virtual bool makVre::DtVreObserverModeMapper::initialize ( DtInitTable & initTable)
virtual

Initializes the mapper with observer mode mappings.

Parameters
initTableLUA table containing observer mode mappings
Returns
True if initialization succeeded, false otherwise

Initializes the table of key strings and their corresponding CameraFX/SensorFX VR-Vantage observer mode names from the provided LUA table. The initTable parameter is typically the 'vreObserverModeMapper' 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 observer modes available in each library.

◆ lookup()

virtual std::string makVre::DtVreObserverModeMapper::lookup ( std::string key) const
virtual

Looks up the VR-Vantage observer mode name for a generic identifier.

Parameters
keyGeneric observer mode identifier
Returns
VR-Vantage observer mode name, or empty string if not found

Translates a generic observer mode identifier to the appropriate VR-Vantage observer 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 observer mode might be "LWIR (SensorFX)". If the requested mode is not available in the current sensor library, an empty string is returned.

◆ operator=()

DtVreObserverModeMapper & makVre::DtVreObserverModeMapper::operator= ( const DtVreObserverModeMapper & orig)
private

Assignment operator (deleted)

Assignment is not supported for this class.

References DtVreObserverModeMapper().

Member Data Documentation

◆ mySensorLibrary

DtSensorLibrary makVre::DtVreObserverModeMapper::mySensorLibrary
protected

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 observer mode names will be used during lookup operations.

◆ myObserverModeTable

DtVreObserveModeTable makVre::DtVreObserverModeMapper::myObserverModeTable
protected

Table mapping generic identifiers to observer mode names.

Table of DtVrvObserverMode entries, indexed by generic string identifiers. These identifiers provide an abstraction layer for configuring observer modes in VR-Engage independent of whether CameraFX or SensorFX is being used.


The documentation for this class was generated from the following file: