A singleton settings manager, rooted in the display engine, that maintains default values for some cloud layer properties, by cloud type. The properties the manager maintains default values for are length and width. This settings manager is used by the global environment to initialize these properties to their defaults whenever a cloud layer is added or when the cloud layer's type changes. These defaults are needed because clouds created in the global environment are visualized to appear 'infinite'. This effect is achieved by creating cloud layer(s) of some length and width, determined by these default settings, and rendering the cloud layer(s) in every scene view based on the position of the observer(s) we are rendering the scene view(s) for. The cloud layer being rendered with respect to the observer's in the scene make it appear as if clouds are present globally since it appears in every observer's scene view no matter where they are on the globe. Changing the default properties modifies the dimensions of the cloud layers being rendered making them either 1) appear at further distances from the observer (if increasing the dimensions) or 2) reduce the vicinity around the observer the cloud layers appear (if decreasing the dimensions).

See Also: makArchives::DtCloudLayerListRecord; vrvCore::DtEnvironment

Inheritance diagram for makVrv::DtCloudLayerSettingsManager:

[legend]

Public Types
typedef std::map < DtCloudTypeMapper::CloudType, makArchives::DtCloudLayerRecord >	DtCloudTypeToCloudLayerRecordMap

Public Member Functions
	DtCloudLayerSettingsManager ()=delete

	DtCloudLayerSettingsManager (const DtCloudLayerSettingsManager &orig)=delete

DtCloudLayerSettingsManager &	operator= (const DtCloudLayerSettingsManager &orig)=delete

virtual	~DtCloudLayerSettingsManager ()

Setting Mutator/Accessor Methods
void	setDefaultLengthForCloudType (DtCloudTypeMapper::CloudType type, float defaultLength)

float	defaultLengthForCloudType (DtCloudTypeMapper::CloudType type) const

void	setDefaultWidthForCloudType (DtCloudTypeMapper::CloudType type, float defaultWidth)

float	defaultWidthForCloudType (DtCloudTypeMapper::CloudType type) const

Setting Persistence Methods
void	setFromRecord (const makArchives::DtCloudLayerListRecord &rec)

void	getRecord (makArchives::DtCloudLayerListRecord &rec) const

Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtCloudLayerListRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtBaseSettingsManager ()

virtual void	initializeBackup ()

virtual bool	getOverriddenFactoryRecord (makArchives::DtCloudLayerListRecord &record) const

Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtCloudLayerListRecord >
	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 ()

Static Public Member Functions
static DtCloudLayerSettingsManager &	instance (DtDe &de)

Protected Member Functions
	DtCloudLayerSettingsManager (DtDe &de)

virtual bool	applyFactoryOverrides (makArchives::DtCloudLayerListRecord &rec) const

Protected Attributes
DtCloudTypeToCloudLayerRecordMap	myCloudTypeToCloudLayerRecordMap

Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtCloudLayerListRecord >
DtSignalConnectionManager	myConnections

std::string	myName

std::string	myExtension

std::string	myDisplayName

bool	myUseDefaultSettingsRecordFlag

bool	myAutoSaveFlag

DtSettingsBackup *	mySettingsBackup

DtDe &	myDe

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)

template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtCloudLayerListRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtCloudLayerListRecord > , makArchives::DtCloudLayerListRecord >	RecordBackupType

Member Typedef Documentation

typedef std::map<DtCloudTypeMapper::CloudType, makArchives::DtCloudLayerRecord> makVrv::DtCloudLayerSettingsManager::DtCloudTypeToCloudLayerRecordMap

Constructor & Destructor Documentation

makVrv::DtCloudLayerSettingsManager::DtCloudLayerSettingsManager ( )

delete

CTOR.

makVrv::DtCloudLayerSettingsManager::DtCloudLayerSettingsManager ( const DtCloudLayerSettingsManager & orig )

delete

Copy CTOR.

virtual makVrv::DtCloudLayerSettingsManager::~DtCloudLayerSettingsManager ( )

virtual

Virtual DTOR.

makVrv::DtCloudLayerSettingsManager::DtCloudLayerSettingsManager ( DtDe & de )

protected

Protected CTOR ( use instance(..) ).

Member Function Documentation

DtCloudLayerSettingsManager& makVrv::DtCloudLayerSettingsManager::operator= ( const DtCloudLayerSettingsManager & orig )

delete

Assignment OP.

static DtCloudLayerSettingsManager& makVrv::DtCloudLayerSettingsManager::instance ( DtDe & de )

static

Get an instance of the settings manager.

Parameters

[in] de is the display engine root for the singleton.

void makVrv::DtCloudLayerSettingsManager::setDefaultLengthForCloudType	(	DtCloudTypeMapper::CloudType	type,
		float	defaultLength
	)

float makVrv::DtCloudLayerSettingsManager::defaultLengthForCloudType ( DtCloudTypeMapper::CloudType type ) const

void makVrv::DtCloudLayerSettingsManager::setDefaultWidthForCloudType	(	DtCloudTypeMapper::CloudType	type,
		float	defaultWidth
	)

float makVrv::DtCloudLayerSettingsManager::defaultWidthForCloudType ( DtCloudTypeMapper::CloudType type ) const

void makVrv::DtCloudLayerSettingsManager::setFromRecord ( const makArchives::DtCloudLayerListRecord & rec )

virtual

Set the current settings' state from the given record.

Implements makVrv::DtBaseSettingsManager< makArchives::DtCloudLayerListRecord >.

void makVrv::DtCloudLayerSettingsManager::getRecord ( makArchives::DtCloudLayerListRecord & rec ) const

virtual

Store the current settings' state in the given record.

Implements makVrv::DtBaseSettingsManager< makArchives::DtCloudLayerListRecord >.

virtual bool makVrv::DtCloudLayerSettingsManager::applyFactoryOverrides ( makArchives::DtCloudLayerListRecord & rec ) const

protectedvirtual

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::DtBaseSettingsManager< makArchives::DtCloudLayerListRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction	(	DtDe &	de,
		bool	allowedInSlave
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction	(	DtDe &	de,
		ManagerClass *	mgr
	)

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

DtCloudTypeToCloudLayerRecordMap makVrv::DtCloudLayerSettingsManager::myCloudTypeToCloudLayerRecordMap

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtCloudLayerSettingsManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation