makVrv::DtForestSettingsManager Class Reference

A manager for forest settings (Master Display Engines only). This manager makes use of a DtForestEnvControllerAgent to pass settings to any connected Slave Display Engines.

Inheritance diagram for makVrv::DtForestSettingsManager:

Public Member Functions
virtual	~DtForestSettingsManager ()
Setters/getters for settings
virtual void	setFarClippingPlane (float farPlane)
virtual float	farClippingPlane () const
virtual void	set3DLodDistances (float fHigh, float fLow)
virtual float	highDetail3dDistance () const
virtual float	lowDetail3dDistance () const
virtual void	setBillboardDistances (float fStart, float fEnd)
virtual void	setBillboardFadeOutRange (float range)
virtual float	billboardStartDistance () const
virtual float	billboardEndDistance () const
virtual float	billboardFadeOutRange () const
virtual void	setTreesEnabled (bool enabled)
virtual bool	treesEnabled () const
virtual void	setBillboardsEnabled (bool enable)
virtual bool	billboardsEnabled () const
virtual void	setTreeMeshesEnabled (bool enable)
virtual bool	treesMeshesEnabled () const
virtual void	setAmbientScalar (float val)
virtual float	ambientScalar () const
virtual void	setDiffuseScalar (float val)
virtual float	diffuseScalar () const
virtual void	setSpecularScalar (float val)
virtual float	specularScalar () const
virtual void	setTransmissionScalar (float val)
virtual float	transmissionScalar () const
virtual void	setAlphaScalar (float val)
virtual float	alphaScalar () const
virtual bool	receiveShadows () const
virtual void	setReceiveShadows (bool enable)
Setting Persistence Methods
virtual void	setFromRecord (const makArchives::DtForestSettingsRecord &rec)
virtual void	getRecord (makArchives::DtForestSettingsRecord &rec) const
Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSettingsManager ()
virtual void	initializeBackup ()
virtual bool	getOverriddenFactoryRecord (makArchives::DtForestSettingsRecord &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtForestSettingsRecord >
	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 DtForestSettingsManager &	instance (DtDe &de)

Protected Member Functions
	DtForestSettingsManager (DtDe &)
virtual void	slot_displayEngineAdded ()
virtual void	lazyCreateAgent (void)
virtual bool	applyFactoryOverrides (makArchives::DtForestSettingsRecord &rec) const

Protected Attributes
makArchives::DtForestSettingsRecord	mySettingsRecord
DtForestSettingsSignaler &	mySignaler
DtForestEnvControllerAgent *	myForestEnvControllerAgent
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtForestSettingsRecord >
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::DtForestSettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtForestSettingsRecord > , makArchives::DtForestSettingsRecord >	RecordBackupType

Constructor & Destructor Documentation

virtual makVrv::DtForestSettingsManager::~DtForestSettingsManager ( )

virtual

DTOR.

makVrv::DtForestSettingsManager::DtForestSettingsManager ( DtDe &  )

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

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

static

Get an instance of the settings manager.

virtual void makVrv::DtForestSettingsManager::setFarClippingPlane ( float  farPlane )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::farClippingPlane ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::set3DLodDistances ( float  fHigh, float  fLow  )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::highDetail3dDistance ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::lowDetail3dDistance ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setBillboardDistances ( float  fStart, float  fEnd  )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setBillboardFadeOutRange ( float  range )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::billboardStartDistance ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::billboardEndDistance ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::billboardFadeOutRange ( ) const

virtual

get the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setTreesEnabled ( bool  enabled )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual bool makVrv::DtForestSettingsManager::treesEnabled ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setBillboardsEnabled ( bool  enable )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual bool makVrv::DtForestSettingsManager::billboardsEnabled ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setTreeMeshesEnabled ( bool  enable )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual bool makVrv::DtForestSettingsManager::treesMeshesEnabled ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setAmbientScalar ( float  val )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::ambientScalar ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setDiffuseScalar ( float  val )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::diffuseScalar ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setSpecularScalar ( float  val )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::specularScalar ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setTransmissionScalar ( float  val )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::transmissionScalar ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setAlphaScalar ( float  val )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual float makVrv::DtForestSettingsManager::alphaScalar ( ) const

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual bool makVrv::DtForestSettingsManager::receiveShadows ( ) const

virtual

Set / get whether trees receive shadows.

virtual void makVrv::DtForestSettingsManager::setReceiveShadows ( bool  enable )

virtual

set the fade out distance for the billboards. The Range - Cull distance = start transition dist

virtual void makVrv::DtForestSettingsManager::setFromRecord ( const makArchives::DtForestSettingsRecord &  rec )

virtual

Use the settings from the given settings record.

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

virtual void makVrv::DtForestSettingsManager::getRecord ( makArchives::DtForestSettingsRecord &  rec ) const

virtual

Populate the given record with the current settings.

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

virtual void makVrv::DtForestSettingsManager::slot_displayEngineAdded ( )

protectedvirtual

Because we create an agent (lazily), we need to destroy it when a display engine is added so it can be recreated.

virtual void makVrv::DtForestSettingsManager::lazyCreateAgent ( void  )

protectedvirtual

virtual bool makVrv::DtForestSettingsManager::applyFactoryOverrides ( makArchives::DtForestSettingsRecord &  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::DtForestSettingsRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction ( DtDe &  de, bool  allowedInSlave  )

friend

Befriend the manager instance functions for instance retreival/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 retreival/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

makArchives::DtForestSettingsRecord makVrv::DtForestSettingsManager::mySettingsRecord

protected

DtForestSettingsSignaler& makVrv::DtForestSettingsManager::mySignaler

protected

DtForestEnvControllerAgent* makVrv::DtForestSettingsManager::myForestEnvControllerAgent

protected

---

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

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