makVre::DtVreSensorModeMapper Class Reference

Detailed Description

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.

#include <vreSensorModeMapper.h>

Public Member Functions
	DtVreSensorModeMapper (DtSensorLibrary sensorLibrary)
	~DtVreSensorModeMapper ()
virtual bool	initialize (DtInitTable &initTable)
virtual std::string	lookup (std::string key) const

Protected Attributes
DtSensorLibrary	mySensorLibrary
DtVreSensorModeTable	mySensorModeTable

Private Member Functions
	DtVreSensorModeMapper (const DtVreSensorModeMapper &orig)
DtVreSensorModeMapper &	operator= (const DtVreSensorModeMapper &orig)

Constructor & Destructor Documentation

DtVreSensorModeMapper() [1/2]

makVre::DtVreSensorModeMapper::DtVreSensorModeMapper

(

DtSensorLibrary

sensorLibrary

)

Constructor.

Parameters

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.

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

~DtVreSensorModeMapper()

makVre::DtVreSensorModeMapper::~DtVreSensorModeMapper

(

)

Destructor.

Cleans up resources used by the sensor mode mapper.

DtVreSensorModeMapper() [2/2]

makVre::DtVreSensorModeMapper::DtVreSensorModeMapper ( const DtVreSensorModeMapper & orig )

private

Copy constructor (deleted)

Copy construction is not supported for this class.

References DtVreSensorModeMapper().

Member Function Documentation

initialize()

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

virtual

Initializes the mapper with sensor mode mappings.

Parameters

initTable

LUA table containing sensor mode mappings

Returns

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.

lookup()

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

virtual

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

Parameters

key	Generic sensor mode identifier

Returns

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.

operator=()

DtVreSensorModeMapper & makVre::DtVreSensorModeMapper::operator= ( const DtVreSensorModeMapper & orig )

private

Assignment operator (deleted)

Assignment is not supported for this class.

References DtVreSensorModeMapper().

Member Data Documentation

mySensorLibrary

DtSensorLibrary makVre::DtVreSensorModeMapper::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 sensor mode names will be used during lookup operations.

mySensorModeTable

DtVreSensorModeTable makVre::DtVreSensorModeMapper::mySensorModeTable

protected

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.

---

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

• include/framework/vrePlayerStation/vreSensorModeMapper.h