makVrf::DtSharedObjectSettings Class Reference

The shared simulation settings.

Inheritance diagram for makVrf::DtSharedObjectSettings:

Classes
struct	SelectionSettings

Public Types
typedef std::map< DtUUID, ObjectSetting >	ObjectSettingsMap

Public Member Functions
virtual	~DtSharedObjectSettings () override
virtual void	removeSettings (const DtUUID &)
void	setSettings (const DtUUID &, ObjectSetting)
ObjectSetting	settingsFor (const DtUUID &) const
virtual bool	hasSetting (const DtUUID &) const
void	setFlagState (const DtUUID &, ObjectSetting, bool onOff)
bool	flagState (const DtUUID &, ObjectSetting) const
virtual void	write (boost::archive::xml_oarchive &ar, int version) const
virtual void	read (boost::archive::xml_iarchive &ar, int version)
const ObjectSettingsMap &	settingsMap () const
virtual void	settingsLoaded ()
virtual bool	setSelectedForDisplay (int setting, const DtUUID &uuid, bool flag)
virtual bool	availableToShowForSelection (int setting, const DtUUID &, int shownByDefault=0) const
virtual void	removeAllPinnedSettings (int flag)
virtual void	setMaximumToDisplayBeforeHidingAllFromSelection (int setting, int maximum, bool replaceIfSet=true)
virtual DtUUID	getAvailableUUIDForDisplay (int setting, int shownByDefault=0) const
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
virtual	~DtSharedSettings ()
boost::shared_mutex &	mutex ()
SafetyKey	safeToEmitSignals ()
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
virtual const DtSettingsBackup *	settingsBackup () const
virtual DtSettingsBackup *	settingsBackup ()
virtual void	backup ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static std::string	className ()

Protected Types
typedef std::map < ObjectSetting, SelectionSettings >	SelectionSettingsMap

Protected Member Functions
	DtSharedObjectSettings (makVrv::DtSharedSettingsManager &manager)

Protected Attributes
ObjectSettingsMap	mySettings
SelectionSettingsMap	mySelectionSettingsMap

Friends
class	makVrv::DtReadSettingsLock< DtSharedObjectSettings >
class	makVrv::DtWriteSettingsLock< DtSharedObjectSettings >
class	makVrv::DtSharedSettingsManager

Member Typedef Documentation

typedef std::map<DtUUID, ObjectSetting> makVrf::DtSharedObjectSettings::ObjectSettingsMap

typedef std::map<ObjectSetting, SelectionSettings> makVrf::DtSharedObjectSettings::SelectionSettingsMap

protected

Constructor & Destructor Documentation

virtual makVrf::DtSharedObjectSettings::~DtSharedObjectSettings ( )

overridevirtual

DTOR.

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

protected

CTOR.

Member Function Documentation

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

static

Get an instance of the settings object. Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

virtual void makVrf::DtSharedObjectSettings::removeSettings ( const DtUUID &  )

virtual

Removes the settings associated with the specified marking text.

void makVrf::DtSharedObjectSettings::setSettings	(	const DtUUID &	,
		ObjectSetting
	)

ObjectSetting makVrf::DtSharedObjectSettings::settingsFor

(

const DtUUID &

)

const

virtual bool makVrf::DtSharedObjectSettings::hasSetting ( const DtUUID &  ) const

virtual

Returns true if a setting exists for this object.

void makVrf::DtSharedObjectSettings::setFlagState	(	const DtUUID &	,
		ObjectSetting	,
		bool	onOff
	)

bool makVrf::DtSharedObjectSettings::flagState	(	const DtUUID &	,
		ObjectSetting
	)		const

Return true if enabled.

virtual void makVrf::DtSharedObjectSettings::write ( boost::archive::xml_oarchive &  ar, int  version  ) const

virtual

virtual void makVrf::DtSharedObjectSettings::read ( boost::archive::xml_iarchive &  ar, int  version  )

virtual

const ObjectSettingsMap& makVrf::DtSharedObjectSettings::settingsMap

(

)

const

virtual bool makVrf::DtSharedObjectSettings::setSelectedForDisplay ( int  setting, const DtUUID &  uuid, bool  flag  )

virtual

Routines that are used to say what items have selected a particular setting for display because it is selected.

virtual bool makVrf::DtSharedObjectSettings::availableToShowForSelection ( int  setting, const DtUUID &  , int  shownByDefault = 0  ) const

virtual

shownByDefault are those items that are selected because they are pinned and not selected optionally

virtual void makVrf::DtSharedObjectSettings::removeAllPinnedSettings ( int  flag )

virtual

Clears out all settings that are currently pinned for any object.

virtual void makVrf::DtSharedObjectSettings::setMaximumToDisplayBeforeHidingAllFromSelection ( int  setting, int  maximum, bool  replaceIfSet = true  )

virtual

-1 means allow all to be displayed

virtual DtUUID makVrf::DtSharedObjectSettings::getAvailableUUIDForDisplay ( int  setting, int  shownByDefault = 0  ) const

virtual

Gets the first UUID available that could be used for selection for showing a visualization( shownByDefault are those items that are selected because they are pinned and not selected optionally.

virtual void makVrf::DtSharedObjectSettings::settingsLoaded ( )

virtual

Friends And Related Function Documentation

friend class makVrv::DtReadSettingsLock< DtSharedObjectSettings >

friend

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

friend class makVrv::DtWriteSettingsLock< DtSharedObjectSettings >

friend

friend class makVrv::DtSharedSettingsManager

friend

Member Data Documentation

ObjectSettingsMap makVrf::DtSharedObjectSettings::mySettings

protected

SelectionSettingsMap makVrf::DtSharedObjectSettings::mySelectionSettingsMap

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfGuiCore/objectSettingsManager.h