makVrf::DtSharedRangeRingsSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrf::DtSharedRangeRingsSettings:

Public Member Functions
virtual	~DtSharedRangeRingsSettings ()
	DTOR.
virtual void	setFill2D (bool)
virtual bool	fill2D () const
virtual void	setShowRangeSphere (bool)
virtual bool	showRangeSphere () const
virtual void	setShowWeaponNameLabel (bool)
virtual bool	showWeaponNameLabel () const
virtual void	setShowEntityNameLabel (bool)
virtual bool	showEntityNameLabel () const
virtual void	setShowRangeValueLabel (bool)
virtual bool	showRangeValueLabel () const
virtual const DtRangeRingsSettingsRecord::ColorOptions &	colorOptions () const
virtual void	setColorOptions (const DtRangeRingsSettingsRecord::ColorOptions &)
virtual void	getColor (int type, int force, float &r, float &g, float &b, float &a, makVrv::DtUnicode &) const
virtual void	setColor (int type, int color, const makVrv::DtUnicode &)
virtual void	removeColorOption (int type)
virtual void	getRecord (DtRangeRingsSettingsRecord &rec) const
virtual void	setFromRecord (const DtRangeRingsSettingsRecord &rec)
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.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
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 ()
	Get an instance of the settings object.

Protected Member Functions
virtual void	colorFromForce (int force, float &r, float &g, float &b)
	DtSharedRangeRingsSettings (makVrv::DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
bool	myFill2D
bool	myShowRangeSphere
bool	myShowWeaponNameLabel
bool	myShowEntityNameLabel
bool	myShowRangeValueLabel
DtRangeRingsSettingsRecord::ColorOptions	myColorOptions

Friends
class	makVrv::DtReadSettingsLock< DtSharedRangeRingsSettings >
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.
class	makVrv::DtWriteSettingsLock< DtSharedRangeRingsSettings >
class	makVrv::DtSharedSettingsManager

Detailed Description

The shared simulation settings.

Constructor & Destructor Documentation

virtual makVrf::DtSharedRangeRingsSettings::~DtSharedRangeRingsSettings ( )

virtual

DTOR.

makVrf::DtSharedRangeRingsSettings::DtSharedRangeRingsSettings ( makVrv::DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

static std::string makVrf::DtSharedRangeRingsSettings::className ( )

static

Get an instance of the settings object.

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

virtual void makVrf::DtSharedRangeRingsSettings::setFill2D ( bool  )

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::fill2D ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setShowRangeSphere ( bool  )

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::showRangeSphere ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setShowWeaponNameLabel ( bool  )

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::showWeaponNameLabel ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setShowEntityNameLabel ( bool  )

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::showEntityNameLabel ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setShowRangeValueLabel ( bool  )

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::showRangeValueLabel ( ) const

virtual

virtual const DtRangeRingsSettingsRecord::ColorOptions& makVrf::DtSharedRangeRingsSettings::colorOptions ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setColorOptions ( const DtRangeRingsSettingsRecord::ColorOptions &  )

virtual

virtual void makVrf::DtSharedRangeRingsSettings::getColor ( int  type, int  force, float &  r, float &  g, float &  b, float &  a, makVrv::DtUnicode &    ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setColor ( int  type, int  color, const makVrv::DtUnicode &    )

virtual

virtual void makVrf::DtSharedRangeRingsSettings::removeColorOption ( int  type )

virtual

virtual void makVrf::DtSharedRangeRingsSettings::getRecord ( DtRangeRingsSettingsRecord &  rec ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setFromRecord ( const DtRangeRingsSettingsRecord &  rec )

virtual

virtual void makVrf::DtSharedRangeRingsSettings::colorFromForce ( int  force, float &  r, float &  g, float &  b  )

protectedvirtual

Friends And Related Function Documentation

friend class makVrv::DtReadSettingsLock< DtSharedRangeRingsSettings >

friend

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

friend class makVrv::DtWriteSettingsLock< DtSharedRangeRingsSettings >

friend

friend class makVrv::DtSharedSettingsManager

friend

Member Data Documentation

bool makVrf::DtSharedRangeRingsSettings::myFill2D

protected

bool makVrf::DtSharedRangeRingsSettings::myShowRangeSphere

protected

bool makVrf::DtSharedRangeRingsSettings::myShowWeaponNameLabel

protected

bool makVrf::DtSharedRangeRingsSettings::myShowEntityNameLabel

protected

bool makVrf::DtSharedRangeRingsSettings::myShowRangeValueLabel

protected

DtRangeRingsSettingsRecord::ColorOptions makVrf::DtSharedRangeRingsSettings::myColorOptions

protected

---

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

• include/vrfGuiCore/DtRangeRingsManager.h