makVrv::DtSharedAggregateDisplaySettings Class Reference

The shared aggregate display settings object.

Inheritance diagram for makVrv::DtSharedAggregateDisplaySettings:

Public Member Functions
virtual	~DtSharedAggregateDisplaySettings ()
void	setFromRecord (const makArchives::DtAggregateSettingsRecord &rec)
void	getRecord (makArchives::DtAggregateSettingsRecord &rec) const
virtual const DtAggregateStateSettingsBackup *	settingsBackup () const
virtual DtAggregateStateSettingsBackup *	settingsBackup ()
virtual void	backup ()
Aggregate Display Setting Getters/Setters
virtual bool	displayAggregates () const
virtual void	setDisplayAggregates (bool enabled)
virtual bool	displayAggregateLeafNodes () const
virtual void	setDisplayAggregateLeafNodes (bool enabled)
virtual bool	displayInitiallyExpanded () const
virtual void	setDisplayInitiallyExpanded (bool enabled)
virtual bool	displayAggregateBoundingBoxes () const
virtual void	setDisplayAggregateBoundingBoxes (bool enabled)
virtual bool	displayAggregateBoundingBoxesForSelected () const
virtual void	setDisplayAggregateBoundingBoxesForSelected (bool enabled)
virtual bool	displayMainIcon () const
virtual void	setDisplayMainIcon (bool enabled)
virtual bool	ghostEchelonLevelItems () const
virtual void	setGhostEchelonLevelItems (bool enabled)
virtual bool	ghostEchelonLevelItemLabels () const
virtual void	setGhostEchelonLevelItemLabels (bool enabled)
virtual bool	allowSelectionOfGhostedItems () const
virtual void	setAllowSelectionOfGhostedItems (bool enabled)
virtual int	echelonLevel () const
virtual void	setEchelonLevel (int level)
virtual double	ghostingTransparency () const
virtual void	setGhostingTransparency (double transparency)
virtual DtColorizedModelColorType	colorizedModelColorTypeForAggregates () const
virtual void	setColorizedModelColorTypeForAggregates (DtColorizedModelColorType type)
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)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

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

Protected Member Functions
	DtSharedAggregateDisplaySettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtAggregateSettingsRecord &rec) const

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

Friends
class	DtReadSettingsLock< DtSharedAggregateDisplaySettings >
class	DtWriteSettingsLock< DtSharedAggregateDisplaySettings >
class	DtBaseSharedSettingsManager< makArchives::DtAggregateSettingsRecord, DtSharedAggregateDisplaySettings >

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::ghostEchelonLevelItemLabels ( ) const

virtual

Get whether items below the echelon level have their labels shown.

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

virtual

Set whether items below the echelon level have their labels shown.

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 DtColorizedModelColorType makVrv::DtSharedAggregateDisplaySettings::colorizedModelColorTypeForAggregates ( ) const

virtual

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

virtual void makVrv::DtSharedAggregateDisplaySettings::setColorizedModelColorTypeForAggregates ( DtColorizedModelColorType  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 const std::string& makVrv::DtSharedAggregateDisplaySettings::className ( )

static

The settings object's class name.

bool makVrv::DtSharedAggregateDisplaySettings::applyFactoryOverrides ( makArchives::DtAggregateSettingsRecord &  rec ) const

protected

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

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.

friend class DtBaseSharedSettingsManager< makArchives::DtAggregateSettingsRecord, DtSharedAggregateDisplaySettings >

friend

Member Data Documentation

int makVrv::DtSharedAggregateDisplaySettings::myFlags

protected

int makVrv::DtSharedAggregateDisplaySettings::myEchelonLevel

protected

double makVrv::DtSharedAggregateDisplaySettings::myGhostingTransparency

protected

DtColorizedModelColorType makVrv::DtSharedAggregateDisplaySettings::myColorizedModelColorType

protected

DtAggregateStateSettingsBackup* makVrv::DtSharedAggregateDisplaySettings::myAggregateSettingsBackup

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtSharedAggregateDisplaySettings.h