makVrv::DtSharedIntersectorSettings Class Reference

The shared intersector settings. More...

Inheritance diagram for makVrv::DtSharedIntersectorSettings:

Public Member Functions
virtual	~DtSharedIntersectorSettings ()
	DTOR.
Setting Getters & Setters
bool	drawEnabled () const
	Get / Set whether intersectors are drawn.
void	setDrawEnabled (bool setting)
float	drawnDuration () const
	Get / Set duration of drawn intersectors.
void	setDrawnDuration (float setting)
void	setFailedIntersectorColor (const DtColorValue &color)
const DtColorValue &	failedIntersectorColor () const
void	setOddSegmentIntersectorColor (const DtColorValue &color)
const DtColorValue &	oddSegmentIntersectorColor () const
void	setEvenSegmentIntersectorColor (const DtColorValue &color)
const DtColorValue &	evenSegmentIntersectorColor () const
Settings record / backup methods
void	setFromRecord (const makArchives::DtIntersectorSettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtIntersectorSettingsRecord &rec) const
	Get the settings as a record.
virtual const DtIntersectorSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtIntersectorSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the 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 Member Functions
	DtSharedIntersectorSettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Protected Attributes
bool	myDrawEnabled
float	myDrawnDuration
DtColorValue	myFailedIntersectorColor
DtColorValue	myOddSegmentIntersectorColor
DtColorValue	myEvenSegmentIntersectorColor
DtIntersectorSettingsBackup *	mySettingsBackup

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

Detailed Description

The shared intersector settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedIntersectorSettings::~DtSharedIntersectorSettings ( )

virtual

DTOR.

makVrv::DtSharedIntersectorSettings::DtSharedIntersectorSettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

bool makVrv::DtSharedIntersectorSettings::drawEnabled

(

)

const

Get / Set whether intersectors are drawn.

void makVrv::DtSharedIntersectorSettings::setDrawEnabled

(

bool

setting

)

float makVrv::DtSharedIntersectorSettings::drawnDuration

(

)

const

Get / Set duration of drawn intersectors.

void makVrv::DtSharedIntersectorSettings::setDrawnDuration

(

float

setting

)

void makVrv::DtSharedIntersectorSettings::setFailedIntersectorColor

(

const DtColorValue &

color

)

Set / Get the color used to draw failed intersections. Components are normalized values (0.0 - 1.0).

const DtColorValue& makVrv::DtSharedIntersectorSettings::failedIntersectorColor

(

)

const

void makVrv::DtSharedIntersectorSettings::setOddSegmentIntersectorColor

(

const DtColorValue &

color

)

Set / Get the color used to draw the odd numbered segments of drawn intersections. Components are normalized values (0.0 - 1.0).

const DtColorValue& makVrv::DtSharedIntersectorSettings::oddSegmentIntersectorColor

(

)

const

void makVrv::DtSharedIntersectorSettings::setEvenSegmentIntersectorColor

(

const DtColorValue &

color

)

Set / Get the color used to draw the even numbered segments of drawn intersections. Components are normalized values (0.0 - 1.0).

const DtColorValue& makVrv::DtSharedIntersectorSettings::evenSegmentIntersectorColor

(

)

const

void makVrv::DtSharedIntersectorSettings::setFromRecord

(

const makArchives::DtIntersectorSettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedIntersectorSettings::getRecord

(

makArchives::DtIntersectorSettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtIntersectorSettingsBackup* makVrv::DtSharedIntersectorSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtIntersectorSettingsBackup* makVrv::DtSharedIntersectorSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedIntersectorSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedIntersectorSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedIntersectorSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

bool makVrv::DtSharedIntersectorSettings::myDrawEnabled

protected

float makVrv::DtSharedIntersectorSettings::myDrawnDuration

protected

DtColorValue makVrv::DtSharedIntersectorSettings::myFailedIntersectorColor

protected

DtColorValue makVrv::DtSharedIntersectorSettings::myOddSegmentIntersectorColor

protected

DtColorValue makVrv::DtSharedIntersectorSettings::myEvenSegmentIntersectorColor

protected

DtIntersectorSettingsBackup* makVrv::DtSharedIntersectorSettings::mySettingsBackup

protected

---

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

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