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 void	setShowByDefault (bool)
virtual bool	showByDefault () const
virtual void	setShowForSelected (bool)
virtual bool	showForSelected () const
virtual void	setShowPhysicalFootprint (bool)
virtual bool	showPhysicalFootprint () const
virtual void	setSphereOpacityModifier (double)
virtual double	sphereOpacityModifier () const
virtual void	setAttackAnimationForRingEnabled (const std::string &, bool)
	Attack animations are not currently stored as part of permanent record and and only be enabled/disabled in code.
virtual bool	attackAnimationForRingEnabled (const std::string &) const
virtual const DtRangeRingsSettingsRecord::ColorOptions &	colorOptions () const
virtual DtRangeRingsSettingsRecord::ColorOption	colorOption (const std::string &) const
virtual void	setColorOptions (const DtRangeRingsSettingsRecord::ColorOptions &)
virtual bool	getColor (const std::string &type, int force, float &r, float &g, float &b, float &a, makVrv::DtUnicode &) const
virtual void	setColor (const std::string &type, int color, const makVrv::DtUnicode &)
virtual void	removeColorOption (const std::string &type)
virtual void	getRecord (DtRangeRingsSettingsRecord &rec) const
virtual void	setFromRecord (const DtRangeRingsSettingsRecord &rec)
virtual void	addColorOptionIfMissing (const std::string &option, int color, const makVrv::DtUnicode &label, bool visible=true)
	If color option is not there, add it.
virtual bool	getColorByCategory (const std::string &type, int &color) const
	Some range rings have categories.
virtual makVrv::DtUnicode	labelForType (const std::string &) const
virtual void	setVisible (const std::string &type, bool)
virtual bool	visible (const std::string &type) const
virtual bool	wasRequested (const std::string &) const
virtual void	setSectorSizeProperty (const std::string &)
virtual const std::string &	sectorSizeProperty () const
virtual bool	hasNewOptions () const
virtual void	getAndClearOptions (std::set< std::string > &newOptions, std::set< std::string > &newOptionsRequested)
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
bool	myShowByDefault
bool	myShowForSelected
bool	myShowPhysicalFootprint
double	mySphereOpacityModifier
DtRangeRingsSettingsRecord::ColorOptions	myColorOptions
std::map< std::string, bool >	myRequested
std::map< std::string, bool >	myAttackAnimationEnabled
std::string	mySectorSizeProperty
std::set< std::string >	myNewColorOptions
std::set< std::string >	myNewOptionRequested

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 void makVrf::DtSharedRangeRingsSettings::setShowByDefault ( bool )

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setSphereOpacityModifier ( double )

virtual

virtual double makVrf::DtSharedRangeRingsSettings::sphereOpacityModifier ( ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setAttackAnimationForRingEnabled	(	const std::string &	,
		bool
	)

virtual

Attack animations are not currently stored as part of permanent record and and only be enabled/disabled in code.

virtual bool makVrf::DtSharedRangeRingsSettings::attackAnimationForRingEnabled ( const std::string & ) const

virtual

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

virtual

virtual DtRangeRingsSettingsRecord::ColorOption makVrf::DtSharedRangeRingsSettings::colorOption ( const std::string & ) const

virtual

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

virtual

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

virtual

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

virtual

virtual void makVrf::DtSharedRangeRingsSettings::removeColorOption ( const std::string & type )

virtual

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

virtual

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

virtual

virtual void makVrf::DtSharedRangeRingsSettings::addColorOptionIfMissing	(	const std::string &	option,
		int	color,
		const makVrv::DtUnicode &	label,
		bool	visible = `true`
	)

virtual

If color option is not there, add it.

virtual bool makVrf::DtSharedRangeRingsSettings::getColorByCategory	(	const std::string &	type,
		int &	color
	)		const

virtual

Some range rings have categories.

These are included in the type. For instance: "Combat-Power.Anti-Tank.Range". Finds the color associated with the base category (e.g. "Combat-Power" in the example above) of the given type.

virtual makVrv::DtUnicode makVrf::DtSharedRangeRingsSettings::labelForType ( const std::string & ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setVisible	(	const std::string &	type,
		bool
	)

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::visible ( const std::string & type ) const

virtual

virtual bool makVrf::DtSharedRangeRingsSettings::wasRequested ( const std::string & ) const

virtual

virtual void makVrf::DtSharedRangeRingsSettings::setSectorSizeProperty ( const std::string & )

virtual

virtual const std::string& makVrf::DtSharedRangeRingsSettings::sectorSizeProperty ( ) const

virtual

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

virtual

virtual void makVrf::DtSharedRangeRingsSettings::getAndClearOptions	(	std::set< std::string > &	newOptions,
		std::set< std::string > &	newOptionsRequested
	)

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

bool makVrf::DtSharedRangeRingsSettings::myShowByDefault

protected

bool makVrf::DtSharedRangeRingsSettings::myShowForSelected

protected

bool makVrf::DtSharedRangeRingsSettings::myShowPhysicalFootprint

protected

double makVrf::DtSharedRangeRingsSettings::mySphereOpacityModifier

protected

DtRangeRingsSettingsRecord::ColorOptions makVrf::DtSharedRangeRingsSettings::myColorOptions

protected

std::map<std::string, bool> makVrf::DtSharedRangeRingsSettings::myRequested

protected

std::map<std::string, bool> makVrf::DtSharedRangeRingsSettings::myAttackAnimationEnabled

protected

std::string makVrf::DtSharedRangeRingsSettings::mySectorSizeProperty

protected

std::set<std::string> makVrf::DtSharedRangeRingsSettings::myNewColorOptions

protected

std::set<std::string> makVrf::DtSharedRangeRingsSettings::myNewOptionRequested

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/rangeRingsManager.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation