makVrv::DtBaseSettingsManager< RecordType > Class Template Reference

template<typename RecordType>
class makVrv::DtBaseSettingsManager< RecordType >

Base class for (non-shared) settings managers. Extends the functionality provided by the DtCommonBaseSettingsManager, by implementing the initializeBackup method. Since the backups for all non-shared settings are handled the same, new non-shared settings managers should use DtBaseSettingsManager as its base class to make use of the common initializeBackup code.

Inheritance diagram for makVrv::DtBaseSettingsManager< RecordType >:

Public Member Functions
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSettingsManager ()
Setting Persistence Methods
virtual void	initializeBackup ()
virtual void	setFromRecord (const RecordType &record)=0
virtual void	getRecord (RecordType &record) const =0
virtual bool	applyFactoryOverrides (RecordType &record) const =0
virtual bool	getOverriddenFactoryRecord (RecordType &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< RecordType >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtCommonBaseSettingsManager ()
virtual void	autoSaveIfNecessary ()
virtual void	setAutoSave (bool doit)
virtual bool	autoSave () const
virtual void	setUseDefaultSettingsRecord (bool useit)
virtual bool	useDefaultSettingsRecord () const
virtual DtDeSettings *	settings ()
virtual const DtDeSettings *	settings () const
virtual DtSettingsBackup *	settingsBackup ()
virtual const DtSettingsBackup *	settingsBackup () const
virtual void	loadDefaults ()
virtual void	saveDefaultSettings ()
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
virtual void	importSettings (const std::string &filePath)
virtual void	exportSettings (const std::string &filePath) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Protected Types
typedef DtRecordSettingsBackup < DtBaseSettingsManager < RecordType >, RecordType >	RecordBackupType

Additional Inherited Members
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< RecordType >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Member Typedef Documentation

template<typename RecordType>

typedef DtRecordSettingsBackup<DtBaseSettingsManager<RecordType>,RecordType> makVrv::DtBaseSettingsManager< RecordType >::RecordBackupType

protected

Constructor & Destructor Documentation

template<typename RecordType>

makVrv::DtBaseSettingsManager< RecordType >::DtBaseSettingsManager ( DtDe &  de, const std::string &  name, const std::string &  displayName, const std::string &  ext  )

inline

CTOR.

See Also

DtCommonBaseSettingsManager::DtCommonBaseSettingsManager

template<typename RecordType>

virtual makVrv::DtBaseSettingsManager< RecordType >::~DtBaseSettingsManager ( )

inlinevirtual

Virtual DTOR.

Member Function Documentation

template<typename RecordType>

virtual void makVrv::DtBaseSettingsManager< RecordType >::initializeBackup ( )

inlinevirtual

Creates a backup of the settings' current state.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

Reimplemented in makVrv::DtShadowSettingsManager, and makVrv::DtObserverModeManager.

template<typename RecordType>

virtual void makVrv::DtBaseSettingsManager< RecordType >::setFromRecord ( const RecordType &  record )

pure virtual

Set the current settings' state from the given record (abstract).

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

Implemented in makVrv::DtShadowSettingsManager, makVrv::DtObserverModeManager, makVrv::DtGridLinesSettingsManager, makVrv::DtVirtualRealitySettingsManager, makVrv::DtAudioSettingsManager, makVrv::DtIntervisibilitySettingsManager, makVrv::DtForestSettingsManager, makVrv::DtCloudLayerSettingsManager, makVrv::DtDistributedEnvironmentSettingsManager, makVrv::DtOculusSettingsManager, and makVrv::DtExampleSettingsManager.

template<typename RecordType>

virtual void makVrv::DtBaseSettingsManager< RecordType >::getRecord ( RecordType &  record ) const

pure virtual

Store the current settings' state in the given record (abstract).

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

Implemented in makVrv::DtShadowSettingsManager, makVrv::DtObserverModeManager, makVrv::DtGridLinesSettingsManager, makVrv::DtVirtualRealitySettingsManager, makVrv::DtAudioSettingsManager, makVrv::DtIntervisibilitySettingsManager, makVrv::DtForestSettingsManager, makVrv::DtCloudLayerSettingsManager, makVrv::DtDistributedEnvironmentSettingsManager, makVrv::DtOculusSettingsManager, and makVrv::DtExampleSettingsManager.

template<typename RecordType>

virtual bool makVrv::DtBaseSettingsManager< RecordType >::applyFactoryOverrides ( RecordType &  record ) const

pure virtual

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

Implemented in makVrv::DtShadowSettingsManager, makVrv::DtObserverModeManager, makVrv::DtDistributedEnvironmentSettingsManager, makVrv::DtGridLinesSettingsManager, makVrv::DtVirtualRealitySettingsManager, makVrv::DtAudioSettingsManager, makVrv::DtIntervisibilitySettingsManager, makVrv::DtForestSettingsManager, makVrv::DtCloudLayerSettingsManager, and makVrv::DtExampleSettingsManager.

Referenced by makVrv::DtBaseSettingsManager< makArchives::DtOculusSettingsRecord >::getOverriddenFactoryRecord().

template<typename RecordType>

virtual bool makVrv::DtBaseSettingsManager< RecordType >::getOverriddenFactoryRecord ( RecordType &  record ) const

inlinevirtual

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvUtil/DtBaseSettingsManager.h