makVrv::DtSharedTacticalGraphicsDisplaySettings Class Reference

The shared tactical graphics display settings. More...

Inheritance diagram for makVrv::DtSharedTacticalGraphicsDisplaySettings:

Public Types
enum	HeightAboveTerrainMode { ShowHatForAll = 0, ShowHatForSelected = 1 }

Public Member Functions
virtual	~DtSharedTacticalGraphicsDisplaySettings ()
	DTOR.
void	setFromRecord (const makArchives::DtTacticalGraphicsSettingsRecord &rec)
	Set the tactical graphics settings from a record.
void	getRecord (makArchives::DtTacticalGraphicsSettingsRecord &rec) const
	Write the tactical graphics settings to a record.
const DtTacticalGraphicsSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
DtTacticalGraphicsSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Tactical Graphics Setting Getters/Setters
bool	tacticalGraphicsEnabled () const
void	setTacticalGraphicsEnabled (bool enabled)
bool	tacticalGraphicsIndicatorsEnabled () const
void	setTacticalGraphicsIndicatorsEnabled (bool enabled)
bool	tacticalGraphicsHeightAboveTerrainLinesEnabled () const
void	setTacticalGraphicsHeightAboveTerrainLinesEnabled (bool enabled)
HeightAboveTerrainMode	tacticalGraphicsHeightAboveTerrainMode () const
void	setTacticalGraphicsHeightAboveTerrainMode (HeightAboveTerrainMode mode)
bool	remoteGraphicsEnabled () const
void	setRemoteGraphicsEnabled (bool enabled)
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.
static std::string	classType ()
	The settings object's class type.
static std::string	displayName ()
	The settings object's display name.

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

Protected Attributes
bool	myTacticalGraphicsEnabled
bool	myTacticalGraphicsIndicatorsEnabled
bool	myTacticalGraphicsIndicatorsOnSelectedEnabled
bool	myTacticalGraphicsHeightAboveTerrainLinesEnabled
HeightAboveTerrainMode	myTacticalGraphicsHeightAboveTerrainMode
bool	myRemoteGraphicsEnabled
DtTacticalGraphicsSettingsBackup *	myTacticalGraphicsSettingsBackup

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

Detailed Description

The shared tactical graphics display settings.

Member Enumeration Documentation

enum makVrv::DtSharedTacticalGraphicsDisplaySettings::HeightAboveTerrainMode

Enumerator:

ShowHatForAll
ShowHatForSelected

Constructor & Destructor Documentation

virtual makVrv::DtSharedTacticalGraphicsDisplaySettings::~DtSharedTacticalGraphicsDisplaySettings ( )

virtual

DTOR.

makVrv::DtSharedTacticalGraphicsDisplaySettings::DtSharedTacticalGraphicsDisplaySettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::tacticalGraphicsEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setTacticalGraphicsEnabled

(

bool

enabled

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::tacticalGraphicsIndicatorsEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setTacticalGraphicsIndicatorsEnabled

(

bool

enabled

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::tacticalGraphicsHeightAboveTerrainLinesEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setTacticalGraphicsHeightAboveTerrainLinesEnabled

(

bool

enabled

)

HeightAboveTerrainMode makVrv::DtSharedTacticalGraphicsDisplaySettings::tacticalGraphicsHeightAboveTerrainMode

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setTacticalGraphicsHeightAboveTerrainMode

(

HeightAboveTerrainMode

mode

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::remoteGraphicsEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setRemoteGraphicsEnabled

(

bool

enabled

)

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setFromRecord

(

const makArchives::DtTacticalGraphicsSettingsRecord &

rec

)

Set the tactical graphics settings from a record.

void makVrv::DtSharedTacticalGraphicsDisplaySettings::getRecord

(

makArchives::DtTacticalGraphicsSettingsRecord &

rec

)

const

Write the tactical graphics settings to a record.

const DtTacticalGraphicsSettingsBackup* makVrv::DtSharedTacticalGraphicsDisplaySettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

DtTacticalGraphicsSettingsBackup* makVrv::DtSharedTacticalGraphicsDisplaySettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedTacticalGraphicsDisplaySettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The settings object's class name.

static std::string makVrv::DtSharedTacticalGraphicsDisplaySettings::classType ( )

static

The settings object's class type.

static std::string makVrv::DtSharedTacticalGraphicsDisplaySettings::displayName ( )

static

The settings object's display name.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedTacticalGraphicsDisplaySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedTacticalGraphicsDisplaySettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsIndicatorsEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsIndicatorsOnSelectedEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsHeightAboveTerrainLinesEnabled

protected

HeightAboveTerrainMode makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsHeightAboveTerrainMode

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myRemoteGraphicsEnabled

protected

DtTacticalGraphicsSettingsBackup* makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsSettingsBackup

protected

---

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

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