makVrv::DtSharedAggregateDisplaySettings Class Reference

The shared aggregate display settings object. More...

Inheritance diagram for makVrv::DtSharedAggregateDisplaySettings:

Public Types
enum	ColorizedModelColorType { UsePrimaryColors = 0, UseIconColors = 1 }

Public Member Functions
virtual	~DtSharedAggregateDisplaySettings ()
	DTOR.
void	setFromRecord (const makArchives::DtAggregateSettingsRecord &rec)
	Set the aggregate settings from record.
void	getRecord (makArchives::DtAggregateSettingsRecord &rec) const
	Get the aggregate settings from record.
virtual const DtAggregateStateSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtAggregateStateSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Aggregate Display Setting Getters/Setters
virtual bool	displayAggregates () const
	Get whether aggregate display is enabled.
virtual void	setDisplayAggregates (bool enabled)
	Set whether aggregate display is enabled.
virtual bool	displayAggregateLeafNodes () const
	Get whether aggregate leaf nodes are displayed.
virtual void	setDisplayAggregateLeafNodes (bool enabled)
	Set whether aggregate leaf nodes are displayed.
virtual bool	displayInitiallyExpanded () const
	Get whether aggregates are displayed initiallyu expanded.
virtual void	setDisplayInitiallyExpanded (bool enabled)
	Set whether aggregates are displayed initially expanded.
virtual bool	displayAggregateBoundingBoxes () const
	Get whether aggregate bounding boxes are displayed.
virtual void	setDisplayAggregateBoundingBoxes (bool enabled)
	Set whether aggregate bounding boxes are displayed.
virtual bool	displayAggregateBoundingBoxesForSelected () const
	Get whether bounding boxes are only displayed for selected aggregates.
virtual void	setDisplayAggregateBoundingBoxesForSelected (bool enabled)
	Set whether bounding boxes are only displayed for selected aggregates.
virtual bool	displayMainIcon () const
	Get whether aggregate main icons are displayed.
virtual void	setDisplayMainIcon (bool enabled)
	Set whether aggregate main icons are displayed.
virtual bool	ghostEchelonLevelItems () const
	Get whether items below the echelon level are ghosted.
virtual void	setGhostEchelonLevelItems (bool enabled)
	Set whether items below the echelon level are ghosted.
virtual bool	allowSelectionOfGhostedItems () const
	Get whether ghosted aggregate items are selectable.
virtual void	setAllowSelectionOfGhostedItems (bool enabled)
	Set whether ghosted aggregate items are selectable.
virtual int	echelonLevel () const
	Get the echelon level used for ghosting items.
virtual void	setEchelonLevel (int level)
	Set the echelon level used for ghosting items.
virtual double	ghostingTransparency () const
	Get the transparency level applied to ghosted items.
virtual void	setGhostingTransparency (double transparency)
	Set the transparency level applied to ghosted items.
virtual DtSharedAggregateDisplaySettings::ColorizedModelColorType	colorizedModelColorTypeForAggregates () const
	Get the colorized model color type to use for coloring aggregates.
virtual void	setColorizedModelColorTypeForAggregates (DtSharedAggregateDisplaySettings::ColorizedModelColorType type)
	Set the colorized model color type to use for coloring aggregates.
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 settings object's class name.

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

Protected Attributes
int	myFlags
int	myEchelonLevel
double	myGhostingTransparency
ColorizedModelColorType	myColorizedModelColorType
DtAggregateStateSettingsBackup *	myAggregateSettingsBackup

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

Detailed Description

The shared aggregate display settings object.

Member Enumeration Documentation

enum makVrv::DtSharedAggregateDisplaySettings::ColorizedModelColorType

Enumerator:

UsePrimaryColors
UseIconColors

Constructor & Destructor Documentation

virtual makVrv::DtSharedAggregateDisplaySettings::~DtSharedAggregateDisplaySettings ( )

virtual

DTOR.

makVrv::DtSharedAggregateDisplaySettings::DtSharedAggregateDisplaySettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayAggregates ( ) const

virtual

Get whether aggregate display is enabled.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayAggregates ( bool  enabled )

virtual

Set whether aggregate display is enabled.

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayAggregateLeafNodes ( ) const

virtual

Get whether aggregate leaf nodes are displayed.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayAggregateLeafNodes ( bool  enabled )

virtual

Set whether aggregate leaf nodes are displayed.

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayInitiallyExpanded ( ) const

virtual

Get whether aggregates are displayed initiallyu expanded.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayInitiallyExpanded ( bool  enabled )

virtual

Set whether aggregates are displayed initially expanded.

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayAggregateBoundingBoxes ( ) const

virtual

Get whether aggregate bounding boxes are displayed.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayAggregateBoundingBoxes ( bool  enabled )

virtual

Set whether aggregate bounding boxes are displayed.

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayAggregateBoundingBoxesForSelected ( ) const

virtual

Get whether bounding boxes are only displayed for selected aggregates.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayAggregateBoundingBoxesForSelected ( bool  enabled )

virtual

Set whether bounding boxes are only displayed for selected aggregates.

virtual bool makVrv::DtSharedAggregateDisplaySettings::displayMainIcon ( ) const

virtual

Get whether aggregate main icons are displayed.

virtual void makVrv::DtSharedAggregateDisplaySettings::setDisplayMainIcon ( bool  enabled )

virtual

Set whether aggregate main icons are displayed.

virtual bool makVrv::DtSharedAggregateDisplaySettings::ghostEchelonLevelItems ( ) const

virtual

Get whether items below the echelon level are ghosted.

virtual void makVrv::DtSharedAggregateDisplaySettings::setGhostEchelonLevelItems ( bool  enabled )

virtual

Set whether items below the echelon level are ghosted.

virtual bool makVrv::DtSharedAggregateDisplaySettings::allowSelectionOfGhostedItems ( ) const

virtual

Get whether ghosted aggregate items are selectable.

virtual void makVrv::DtSharedAggregateDisplaySettings::setAllowSelectionOfGhostedItems ( bool  enabled )

virtual

Set whether ghosted aggregate items are selectable.

virtual int makVrv::DtSharedAggregateDisplaySettings::echelonLevel ( ) const

virtual

Get the echelon level used for ghosting items.

virtual void makVrv::DtSharedAggregateDisplaySettings::setEchelonLevel ( int  level )

virtual

Set the echelon level used for ghosting items.

virtual double makVrv::DtSharedAggregateDisplaySettings::ghostingTransparency ( ) const

virtual

Get the transparency level applied to ghosted items.

virtual void makVrv::DtSharedAggregateDisplaySettings::setGhostingTransparency ( double  transparency )

virtual

Set the transparency level applied to ghosted items.

virtual DtSharedAggregateDisplaySettings::ColorizedModelColorType makVrv::DtSharedAggregateDisplaySettings::colorizedModelColorTypeForAggregates ( ) const

virtual

Get the colorized model color type to use for coloring aggregates.

virtual void makVrv::DtSharedAggregateDisplaySettings::setColorizedModelColorTypeForAggregates ( DtSharedAggregateDisplaySettings::ColorizedModelColorType  type )

virtual

Set the colorized model color type to use for coloring aggregates.

void makVrv::DtSharedAggregateDisplaySettings::setFromRecord

(

const makArchives::DtAggregateSettingsRecord &

rec

)

Set the aggregate settings from record.

void makVrv::DtSharedAggregateDisplaySettings::getRecord

(

makArchives::DtAggregateSettingsRecord &

rec

)

const

Get the aggregate settings from record.

virtual const DtAggregateStateSettingsBackup* makVrv::DtSharedAggregateDisplaySettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtAggregateStateSettingsBackup* makVrv::DtSharedAggregateDisplaySettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedAggregateDisplaySettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The settings object's class name.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedAggregateDisplaySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedAggregateDisplaySettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

int makVrv::DtSharedAggregateDisplaySettings::myFlags

protected

int makVrv::DtSharedAggregateDisplaySettings::myEchelonLevel

protected

double makVrv::DtSharedAggregateDisplaySettings::myGhostingTransparency

protected

ColorizedModelColorType makVrv::DtSharedAggregateDisplaySettings::myColorizedModelColorType

protected

DtAggregateStateSettingsBackup* makVrv::DtSharedAggregateDisplaySettings::myAggregateSettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtSharedAggregateDisplaySettings.h