makVrv::DtSharedDiGuySettings Class Reference

This class maintains the diguy settings. More...

Inheritance diagram for makVrv::DtSharedDiGuySettings:

Public Member Functions
virtual	~DtSharedDiGuySettings ()
	DTOR.
Setting Getters/Setters
virtual bool	instancingEnabled () const
	Gets whether or not diguy instancing is enabled.
virtual void	setInstancingEnabled (bool enabled)
	Sets whether or not diguy instancing is enabled.
virtual int	instancedLod () const
	Gets lod to use for instanced diguys (1-7)
virtual void	setInstancedLod (int lod)
	Sets lod to use for instanced diguys (1-7)
virtual bool	visualizeInstancing () const
	Gets whether or not visualizing diguy instancing is enabled.
virtual void	setVisualizeInstancing (bool enabled)
	Sets whether or not visualizing diguy instancing is enabled.
virtual float	maxDrawDistance () const
	Gets Maximum distance to draw diguys (-1 is no limit)
virtual void	setMaxDrawDistance (float distance)
	Sets Maximum distance to draw diguys (-1 is no limit)
virtual bool	multiThreadUpdate () const
	Gets whether or not multiple threads will be used for diguy updates.
virtual void	setMultiThreadUpdate (bool enabled)
	Sets whether or not multiple threads will be used for diguy updates.
Settings record / backup methods
void	setFromRecord (const makArchives::DtDiGuySettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtDiGuySettingsRecord &rec) const
	Get the settings as a record.
virtual const DtDiGuySettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtDiGuySettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	The class name for this settings object.

Protected Member Functions
	DtSharedDiGuySettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Protected Attributes
bool	myDiGuyInstancingEnabled
int	myDiGuyInstancedLod
bool	myDiGuyVisualizeInstancing
float	myDiGuyMaxDrawDistance
bool	myDiGuyMultiThreadUpdate
DtDiGuySettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedDiGuySettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedDiGuySettings >
	Use the DtWriteSettingsLock to write to the object.

Detailed Description

This class maintains the diguy settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedDiGuySettings::~DtSharedDiGuySettings ( )

virtual

DTOR.

makVrv::DtSharedDiGuySettings::DtSharedDiGuySettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

virtual bool makVrv::DtSharedDiGuySettings::instancingEnabled ( ) const

virtual

Gets whether or not diguy instancing is enabled.

virtual void makVrv::DtSharedDiGuySettings::setInstancingEnabled ( bool  enabled )

virtual

Sets whether or not diguy instancing is enabled.

virtual int makVrv::DtSharedDiGuySettings::instancedLod ( ) const

virtual

Gets lod to use for instanced diguys (1-7)

virtual void makVrv::DtSharedDiGuySettings::setInstancedLod ( int  lod )

virtual

Sets lod to use for instanced diguys (1-7)

virtual bool makVrv::DtSharedDiGuySettings::visualizeInstancing ( ) const

virtual

Gets whether or not visualizing diguy instancing is enabled.

virtual void makVrv::DtSharedDiGuySettings::setVisualizeInstancing ( bool  enabled )

virtual

Sets whether or not visualizing diguy instancing is enabled.

virtual float makVrv::DtSharedDiGuySettings::maxDrawDistance ( ) const

virtual

Gets Maximum distance to draw diguys (-1 is no limit)

virtual void makVrv::DtSharedDiGuySettings::setMaxDrawDistance ( float  distance )

virtual

Sets Maximum distance to draw diguys (-1 is no limit)

virtual bool makVrv::DtSharedDiGuySettings::multiThreadUpdate ( ) const

virtual

Gets whether or not multiple threads will be used for diguy updates.

virtual void makVrv::DtSharedDiGuySettings::setMultiThreadUpdate ( bool  enabled )

virtual

Sets whether or not multiple threads will be used for diguy updates.

void makVrv::DtSharedDiGuySettings::setFromRecord

(

const makArchives::DtDiGuySettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedDiGuySettings::getRecord

(

makArchives::DtDiGuySettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtDiGuySettingsBackup* makVrv::DtSharedDiGuySettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtDiGuySettingsBackup* makVrv::DtSharedDiGuySettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedDiGuySettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static std::string makVrv::DtSharedDiGuySettings::className ( )

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedDiGuySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedDiGuySettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

bool makVrv::DtSharedDiGuySettings::myDiGuyInstancingEnabled

protected

int makVrv::DtSharedDiGuySettings::myDiGuyInstancedLod

protected

bool makVrv::DtSharedDiGuySettings::myDiGuyVisualizeInstancing

protected

float makVrv::DtSharedDiGuySettings::myDiGuyMaxDrawDistance

protected

bool makVrv::DtSharedDiGuySettings::myDiGuyMultiThreadUpdate

protected

DtDiGuySettingsBackup* makVrv::DtSharedDiGuySettings::mySettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtSharedDiGuySettings.h