makVrv::DtSymbolDecorationSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSymbolDecorationSettings:

Public Types
typedef std::set< std::string >	DecorationSet
	a decoration set is a set of creator names for the enabled decorations
typedef std::set< std::string >	DecorationSettings
	decoration settings globally enable or disable visualization of decorations for sets that have them

Public Member Functions
virtual	~DtSymbolDecorationSettings ()
	DTOR.
Setting Setters/Getters
DecorationSet	getOrCreateDecorationSet (const std::string &setId) const
	Get a decoration set by its id string (create it if necessary).
void	setDecorationSet (const std::string &setId, DecorationSet &decorationSet)
	Set the decoration set associated with an id.
void	enableDecoration (const std::string &decorationCreator)
	Enable a decoration globally.
void	disableDecoration (const std::string &decorationCreator)
	Disable a decoration globally.
bool	decorationEnabled (const std::string &decorationCreator) const
	Check whether a decoration is globally enabled.
const DecorationSettings &	decorationSettings () const
	Get the decoration settings (read only).
DecorationSet	enabledDecorationsInSet (const std::string &setId) const
	Get a decoration set filtered by globally enabled decorations.
bool	decorationEnabledForSet (const std::string &setId, const std::string &decorationCreator) const
	Check whether a decoration is enabled in a particular decoration set (and enabled globally).
void	setForegroundColor (float r, float g, float b)
	Sets the foreground color for the symbol decorations.
void	foregroundColor (float &r, float &g, float &b) const
	Gets the foreground color for the symbol decorations.
void	setBackgroundColor (float r, float g, float b)
	Sets the background color for the symbol decorations.
void	backgroundColor (float &r, float &g, float &b) const
	Gets the background color for the symbol decorations.
void	setBackgroundOpacity (float opacity)
	Sets the background opacity for the symbol decorations.
float	backgroundOpacity () const
	Gets the background opacity for the symbol decorations.
void	setShadowText (bool enabled)
	Sets whether the symbol decoration text has a shadow or not.
bool	shadowText () const
	Gets whether the symbol decoration text has a shadow or not.
Setting persistence methods.
void	setFromRecord (const makArchives::DtSymbolDecorationSettingsRecord &rec)
	Set the settings from a record.
void	getRecord (makArchives::DtSymbolDecorationSettingsRecord &rec) const
	Get the settings as a record.
const DtSymbolDecorationSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
DtSymbolDecorationSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the current 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 Types
typedef boost::unordered_map < std::string, DecorationSet >	DecorationSetMap

Protected Member Functions
	DtSymbolDecorationSettings (DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
DecorationSettings	myDecorationSettings
DecorationSetMap	myDecorationSets
float	myForegroundColorR
float	myForegroundColorG
float	myForegroundColorB
float	myBackgroundColorR
float	myBackgroundColorG
float	myBackgroundColorB
float	myBackgroundColorA
bool	myShadowTextFlag
DtSymbolDecorationSettingsBackup *	mySettingsBackup

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

Detailed Description

The shared simulation settings.

Member Typedef Documentation

typedef std::set<std::string> makVrv::DtSymbolDecorationSettings::DecorationSet

a decoration set is a set of creator names for the enabled decorations

typedef std::set<std::string> makVrv::DtSymbolDecorationSettings::DecorationSettings

decoration settings globally enable or disable visualization of decorations for sets that have them

typedef boost::unordered_map<std::string, DecorationSet> makVrv::DtSymbolDecorationSettings::DecorationSetMap

protected

Constructor & Destructor Documentation

virtual makVrv::DtSymbolDecorationSettings::~DtSymbolDecorationSettings ( )

virtual

DTOR.

makVrv::DtSymbolDecorationSettings::DtSymbolDecorationSettings ( DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

DecorationSet makVrv::DtSymbolDecorationSettings::getOrCreateDecorationSet

(

const std::string &

setId

)

const

Get a decoration set by its id string (create it if necessary).

void makVrv::DtSymbolDecorationSettings::setDecorationSet	(	const std::string &	setId,
		DecorationSet &	decorationSet
	)

Set the decoration set associated with an id.

void makVrv::DtSymbolDecorationSettings::enableDecoration

(

const std::string &

decorationCreator

)

Enable a decoration globally.

void makVrv::DtSymbolDecorationSettings::disableDecoration

(

const std::string &

decorationCreator

)

Disable a decoration globally.

bool makVrv::DtSymbolDecorationSettings::decorationEnabled

(

const std::string &

decorationCreator

)

const

Check whether a decoration is globally enabled.

const DecorationSettings& makVrv::DtSymbolDecorationSettings::decorationSettings

(

)

const

Get the decoration settings (read only).

DecorationSet makVrv::DtSymbolDecorationSettings::enabledDecorationsInSet

(

const std::string &

setId

)

const

Get a decoration set filtered by globally enabled decorations.

bool makVrv::DtSymbolDecorationSettings::decorationEnabledForSet	(	const std::string &	setId,
		const std::string &	decorationCreator
	)		const

Check whether a decoration is enabled in a particular decoration set (and enabled globally).

void makVrv::DtSymbolDecorationSettings::setForegroundColor	(	float	r,
		float	g,
		float	b
	)

Sets the foreground color for the symbol decorations.

void makVrv::DtSymbolDecorationSettings::foregroundColor	(	float &	r,
		float &	g,
		float &	b
	)		const

Gets the foreground color for the symbol decorations.

void makVrv::DtSymbolDecorationSettings::setBackgroundColor	(	float	r,
		float	g,
		float	b
	)

Sets the background color for the symbol decorations.

void makVrv::DtSymbolDecorationSettings::backgroundColor	(	float &	r,
		float &	g,
		float &	b
	)		const

Gets the background color for the symbol decorations.

void makVrv::DtSymbolDecorationSettings::setBackgroundOpacity

(

float

opacity

)

Sets the background opacity for the symbol decorations.

float makVrv::DtSymbolDecorationSettings::backgroundOpacity

(

)

const

Gets the background opacity for the symbol decorations.

void makVrv::DtSymbolDecorationSettings::setShadowText

(

bool

enabled

)

Sets whether the symbol decoration text has a shadow or not.

bool makVrv::DtSymbolDecorationSettings::shadowText

(

)

const

Gets whether the symbol decoration text has a shadow or not.

void makVrv::DtSymbolDecorationSettings::setFromRecord

(

const makArchives::DtSymbolDecorationSettingsRecord &

rec

)

Set the settings from a record.

void makVrv::DtSymbolDecorationSettings::getRecord

(

makArchives::DtSymbolDecorationSettingsRecord &

rec

)

const

Get the settings as a record.

const DtSymbolDecorationSettingsBackup* makVrv::DtSymbolDecorationSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

DtSymbolDecorationSettingsBackup* makVrv::DtSymbolDecorationSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSymbolDecorationSettings::backup ( )

virtual

Called to back up the current settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSymbolDecorationSettings >

friend

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

friend class DtWriteSettingsLock< DtSymbolDecorationSettings >

friend

friend class DtSharedSettingsManager

friend

Member Data Documentation

DecorationSettings makVrv::DtSymbolDecorationSettings::myDecorationSettings

protected

DecorationSetMap makVrv::DtSymbolDecorationSettings::myDecorationSets

protected

float makVrv::DtSymbolDecorationSettings::myForegroundColorR

protected

float makVrv::DtSymbolDecorationSettings::myForegroundColorG

protected

float makVrv::DtSymbolDecorationSettings::myForegroundColorB

protected

float makVrv::DtSymbolDecorationSettings::myBackgroundColorR

protected

float makVrv::DtSymbolDecorationSettings::myBackgroundColorG

protected

float makVrv::DtSymbolDecorationSettings::myBackgroundColorB

protected

float makVrv::DtSymbolDecorationSettings::myBackgroundColorA

protected

bool makVrv::DtSymbolDecorationSettings::myShadowTextFlag

protected

DtSymbolDecorationSettingsBackup* makVrv::DtSymbolDecorationSettings::mySettingsBackup

protected

---

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

• include/vrvCore/DtSymbolDecorationSettings.h