makVrv::DtForestSettingsManager Class Reference

Manager owns the forest settings. More...

Inheritance diagram for makVrv::DtForestSettingsManager:

List of all members.

Public Member Functions
virtual	~DtForestSettingsManager ()
	DTOR.
Setters/getters for settings
virtual void	setFarClippingPlane (float farPlane)
virtual float	farClippingPlane () const
virtual void	setLodDistances (float nearLod, float farLod)
virtual float	nearLodDistance () const
virtual float	farLodDistance () const
virtual void	setPerformanceProfile (int index)
virtual int	performanceProfile () const
Setting Persistence Methods
virtual void	setFromRecord (const makArchives::DtForestSettingsRecord &rec)
	Use the settings from the given settings record.
virtual void	getRecord (makArchives::DtForestSettingsRecord &rec) const
	Populate the given record with the current settings.
Static Public Member Functions
static DtForestSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.
Public Attributes
Boost signals for changed settings
boost::signal< void(float)>	signal_farClippingPlaneSet
boost::signal< void(float, float)>	signal_lodDistancesSet
boost::signal< void(int)>	signal_performanceProfileSet
Protected Member Functions
	DtForestSettingsManager (DtDe &)
	Protected CTOR ( use instance(..) )
Protected Attributes
makArchives::DtForestSettingsRecord	mySettingsRecord
Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

---

Detailed Description

Manager owns the forest settings.

---

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]

virtual float makVrv::DtForestSettingsManager::farClippingPlane

(

)

const [virtual]

virtual void makVrv::DtForestSettingsManager::setLodDistances	(	float	nearLod,
		float	farLod
	)		[virtual]

virtual float makVrv::DtForestSettingsManager::nearLodDistance

(

)

const [virtual]

virtual float makVrv::DtForestSettingsManager::farLodDistance

(

)

const [virtual]

virtual void makVrv::DtForestSettingsManager::setPerformanceProfile

(

int

index

)

[virtual]

virtual int makVrv::DtForestSettingsManager::performanceProfile

(

)

const [virtual]

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 >.

---

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.

Manager requirements: 1) Static instance function 2) Protected DtSignalConnectionManager named myConnections. 3) Member functioned called loadDefaults which takes no arguments. and loads the default settings of the manager or factory from disk. 4) define defaultManagerInstanceFunction as friend. 5) define defaultManagerRegisterInstanceFunction as friend (see below). 5) Protected Constructor which only takes a DtDe reference.

 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.

 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

boost::signal<void (float)> makVrv::DtForestSettingsManager::signal_farClippingPlaneSet

boost::signal<void (float, float)> makVrv::DtForestSettingsManager::signal_lodDistancesSet

boost::signal<void (int)> makVrv::DtForestSettingsManager::signal_performanceProfileSet

makArchives::DtForestSettingsRecord makVrv::DtForestSettingsManager::mySettingsRecord [protected]

---

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

• include/vrvCore/DtForestSettingsManager.h