vreConfiguration.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreConfiguration.h
//! \ingroup vreUtil
//! \brief Provides configuration settings for the VREngage application
//!
//! This file defines the DtVreConfiguration class which extends the VRv stealth
//! configuration to add VREngage-specific settings, primarily related to SensorFX.
 
#pragma once
 
#include "vreUtil/export.h"
 
#include <vrvCore/DtStealthConfiguration.h>
 
namespace makVre
{
//! \brief Configuration class for VREngage application settings
//!
//! This class extends the base VRv stealth configuration to provide
//! VREngage-specific configuration settings, particularly focusing on
//! SensorFX integration and related options.
class UTIL_DLL DtVreConfiguration : public makVrv::DtStealthConfiguration
{
public:
   //! \brief Default constructor
   //!
   //! Initializes default configuration values for VREngage
   DtVreConfiguration();
 
   //! \brief Destructor
   virtual ~DtVreConfiguration() override;
 
   //! \brief Sets up SensorFX configuration if enabled
   //!
   //! Loads the SensorFX DLL and "default_Sensors.sfx" file if SensorFX is enabled
   virtual void setupSensorFxConfiguration();
 
   //! \brief Enables or disables SensorFX
   //! \param setSfx True to enable SensorFX, false to disable
   void setUsingSensorFx(bool setSfx) { mySfxEnabled = setSfx; }
 
   //! \brief Sets the SensorFX DLL filename
   //! \param filename Path to the SensorFX DLL as a DtFilename
   void setSensorFxFilename(const DtFilename& filename) { mySfxFilename = filename; }
 
   //! \brief Sets the SensorFX DLL filename
   //! \param filename Path to the SensorFX DLL as a string
   void setSensorFxFilename(const std::string& filename) { mySfxFilename = filename; }
 
   //! \brief Checks if SensorFX is enabled
   //! \return True if SensorFX is enabled, false otherwise
   bool isSensorFxEnabled() const { return mySfxEnabled; }
 
   //! \brief Gets the SensorFX DLL filename
   //! \return Reference to the SensorFX DLL filename
   const DtFilename& getSensorFxFilename() const { return mySfxFilename; }
 
protected:
   //! \brief Flag indicating if SensorFX is enabled
   bool mySfxEnabled;
 
   //! \brief Path to the SensorFX DLL
   DtFilename mySfxFilename;
};
} // namespace makVre