makVre::DtSettingsOverrideComponent Class Reference

Detailed Description

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.

#include <settingsOverrideComponent.h>

Inheritance diagram for makVre::DtSettingsOverrideComponent:

Public Member Functions
	DtSettingsOverrideComponent ()
virtual	~DtSettingsOverrideComponent () override
virtual bool	initialize (makVre::DtPlayerStation *player, makVre::DtInitTable &config) override
virtual void	tick (double dt) override
virtual void	shutdown () override
virtual const char *	type () const override
Public Member Functions inherited from makVre::DtPlayerComponent
	DtPlayerComponent ()
virtual	~DtPlayerComponent ()
virtual bool	postInitialize ()
virtual void	setName (const std::string &name)
virtual const std::string &	name ()
virtual DtPlayerStation &	player ()
virtual DtAttributeHandle &	playerAttributeStore ()
virtual const DtAttributeHandle &	playerAttributeStore () const

Protected Member Functions
void	slot_observerModeChanged (makVrv::DtObserver *observer, int newMode)
Protected Member Functions inherited from makVre::DtPlayerComponent
virtual void	initializeStateAttributes ()

Protected Attributes
bool	myRestoreShadowSettings
makArchives::DtShadowSettingsCollectionRecord	myOriginalShadowSettings
bool	myRestoreHdr
std::map< int, bool >	myHbaoRestoreMap
Protected Attributes inherited from makVre::DtPlayerComponent
std::string	myName
DtInitTable	myConfig
DtPlayerStation *	myPlayer
makVrv::DtDe *	myDe
DtEntityResolver *	myResolver
DtAttributeCallbackManager	myAttributeCallbacks

Constructor & Destructor Documentation

DtSettingsOverrideComponent()

makVre::DtSettingsOverrideComponent::DtSettingsOverrideComponent

(

)

Constructor for DtSettingsOverrideComponent.

Initializes the component with default settings and empty restoration maps

~DtSettingsOverrideComponent()

virtual makVre::DtSettingsOverrideComponent::~DtSettingsOverrideComponent ( )

overridevirtual

Virtual destructor for DtSettingsOverrideComponent.

Member Function Documentation

initialize()

virtual bool makVre::DtSettingsOverrideComponent::initialize ( makVre::DtPlayerStation * player, makVre::DtInitTable & config )

overridevirtual

Initializes the settings override component.

Parameters

player	Pointer to the player station this component belongs to
config	Configuration table containing override settings

Returns

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

Reimplemented from makVre::DtPlayerComponent.

References makVre::DtPlayerComponent::player().

tick()

virtual void makVre::DtSettingsOverrideComponent::tick ( double dt )

overridevirtual

Called every frame to update the component state.

Parameters

dt	Delta time since the last frame in seconds

Current implementation is empty as the component operates on initialization and shutdown

Implements makVre::DtPlayerComponent.

shutdown()

virtual void makVre::DtSettingsOverrideComponent::shutdown ( )

overridevirtual

Shuts down the settings override component.

Restores all previously cached graphics settings to their original values before the component was initialized

Reimplemented from makVre::DtPlayerComponent.

type()

virtual const char * makVre::DtSettingsOverrideComponent::type ( ) const

overridevirtual

Returns the type identifier for this component.

Returns

The type string for DtSettingsOverrideComponent

Implements makVre::DtPlayerComponent.

slot_observerModeChanged()

void makVre::DtSettingsOverrideComponent::slot_observerModeChanged ( makVrv::DtObserver * observer, int newMode )

protected

Handler for observer mode change events.

Parameters

observer	Pointer to the observer that changed modes
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

Member Data Documentation

myRestoreShadowSettings

bool makVre::DtSettingsOverrideComponent::myRestoreShadowSettings

protected

Flag indicating if shadow settings need to be restored on shutdown.

myOriginalShadowSettings

makArchives::DtShadowSettingsCollectionRecord makVre::DtSettingsOverrideComponent::myOriginalShadowSettings

protected

Original shadow settings cached during initialization.

myRestoreHdr

bool makVre::DtSettingsOverrideComponent::myRestoreHdr

protected

Original HDR state to restore on shutdown.

myHbaoRestoreMap

std::map<int, bool> makVre::DtSettingsOverrideComponent::myHbaoRestoreMap

protected

Map of observer modes to their original HBAO settings.

Maps observer mode IDs to the original HBAO enabled state for restoration

---

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

• include/commonRoleLibraries/vreCommonComponents/settingsOverrideComponent.h