settingsOverrideComponent.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file settingsOverrideComponent.h
//! \brief Component for overriding and restoring rendering settings per role
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
 
#include <makArchives/DtShadowSettingsCollectionRecord.h>
 
namespace makVrv
{
class DtObserver;
}
 
namespace makVre
{
namespace SettingsOverrideComponentConfig
{
//! \ingroup RoleConfigParams
//! \defgroup SettingsOverrideComponentRoleParams Settings Override Component Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for settings override component role.
//! @{
 
//! \vreRoleParam{disableHbao,bool,false,settingsOverrideComponent,Whether to disable Horizon Based Ambient Occlusion (HBAO) graphics setting for this role.}
constexpr const char* disableHbao = "disableHbao";
 
//! \vreRoleParam{disableHdr,bool,false,settingsOverrideComponent,Whether to disable High Dynamic Range (HDR) graphics setting for this role.}
constexpr const char* disableHdr = "disableHdr";
 
//! \vreRoleParam{shadowSettingsFile,string,"",settingsOverrideComponent,Path to shadow settings file for overriding shadow configuration during role engagement.}
constexpr const char* shadowSettingsFile = "shadowSettingsFile";
 
//! @}
} // namespace SettingsOverrideComponentConfig
 
//! \brief Type identifier for DtSettingsOverrideComponent component
constexpr const char* DtSettingsOverrideComponentType = "DtSettingsOverrideComponent";
 
//! \brief Component that temporarily overrides graphics settings for specific roles
//!
//! DtSettingsOverrideComponent provides functionality to override graphics settings
//! such as shadow quality, HDR, and HBAO during role engagement, and then restore
//! the original settings when the role is exited. This allows roles to have
//! customized graphics settings that optimize performance or visual quality for
//! specific operational needs without permanently changing the user's preferences.
class VRECOMMONCOMPONENTS_DLL DtSettingsOverrideComponent : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtSettingsOverrideComponent
   //!
   //! Initializes the component with default settings and empty restoration maps
   DtSettingsOverrideComponent();
 
   //! \brief Virtual destructor for DtSettingsOverrideComponent
   virtual ~DtSettingsOverrideComponent() override;
 
   //! \brief Initializes the settings override component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing override settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Reads configuration settings for shadow quality, HBAO, and HDR overrides,
   //! applies the specified overrides, and caches original settings for restoration
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
   //! \brief Called every frame to update the component state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Current implementation is empty as the component operates on initialization and shutdown
   virtual void tick(double dt) override;
   //! \brief Shuts down the settings override component
   //!
   //! Restores all previously cached graphics settings to their original values
   //! before the component was initialized
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtSettingsOverrideComponent
   virtual const char* type() const override;
 
protected:
   //! \brief Handler for observer mode change events
   //! \param observer Pointer to the observer that changed modes
   //! \param newMode New observer mode index
   //!
   //! When the observer changes to a mode not previously cached, this function
   //! captures the current HBAO setting and disables it if necessary
   void slot_observerModeChanged(makVrv::DtObserver* observer, int newMode);
 
protected:
   //! \brief Flag indicating if shadow settings need to be restored on shutdown
   bool myRestoreShadowSettings;
 
   //! \brief Original shadow settings cached during initialization
   makArchives::DtShadowSettingsCollectionRecord myOriginalShadowSettings;
 
   //! \brief Original HDR state to restore on shutdown
   bool myRestoreHdr;
 
   //! \brief Map of observer modes to their original HBAO settings
   //!
   //! Maps observer mode IDs to the original HBAO enabled state for restoration
   std::map<int, bool> myHbaoRestoreMap;
};
} // namespace makVre