makVrv::DtSharedTacticalGraphicsDisplaySettings Class Reference

Tactical graphics display settings shared between the main thread and connection threads. Changes to these settings are communicated using the DtTacticalGraphicsSettingsSignaler.

Inheritance diagram for makVrv::DtSharedTacticalGraphicsDisplaySettings:

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

Public Member Functions
virtual	~DtSharedTacticalGraphicsDisplaySettings ()
void	setFromRecord (const makArchives::DtTacticalGraphicsSettingsRecord &rec)
void	getRecord (makArchives::DtTacticalGraphicsSettingsRecord &rec) const
const DtTacticalGraphicsSettingsBackup *	settingsBackup () const
DtTacticalGraphicsSettingsBackup *	settingsBackup ()
virtual void	backup ()
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	tacticalGraphicsHeightLinesEnabled () const
void	setTacticalGraphicsHeightLinesEnabled (bool enabled)
bool	remoteGraphicsEnabled () const
void	setRemoteGraphicsEnabled (bool enabled)
bool	showActiveTacticalGraphicsEnabled () const
void	setShowActiveTacticalGraphicsEnabled (bool enabled)
bool	deleteTacticalGraphicsOnHide () const
void	setDeleteTacticalGraphicsOnHide (bool enabled)
vrvTacticalGraphicUtilities::FriendlyForceColorStyle	friendlyForceColorStyle () const
bool	friendlyForceColorOverrideEnabled () const
void	setFriendlyForceColorOverrideEnabled (bool enabled)
void	setFriendlyForceColorOverrideIsBlack (bool isBlack)
bool	friendlyForceColorOverrideIsBlack () 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)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

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

Protected Member Functions
void	signalFriendlyForceColorOverrideStyleChange ()
	DtSharedTacticalGraphicsDisplaySettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtTacticalGraphicsSettingsRecord &rec) const

Protected Attributes
bool	myTacticalGraphicsEnabled
bool	myTacticalGraphicsIndicatorsEnabled
bool	myTacticalGraphicsIndicatorsOnSelectedEnabled
bool	myTacticalGraphicsHeightAboveTerrainLinesEnabled
HeightAboveTerrainMode	myTacticalGraphicsHeightAboveTerrainMode
bool	myTacticalGraphicsHeightLinesEnabled
bool	myRemoteGraphicsEnabled
bool	myShowActiveTacticalGraphicsEnabled
bool	myDeleteTacticalGraphicsOnHide
bool	myFriendlyForceColorOverrideEnabled
bool	myFriendlyForceColorOverrideIsBlack
DtTacticalGraphicsSettingsBackup *	myTacticalGraphicsSettingsBackup

Friends
class	DtReadSettingsLock< DtSharedTacticalGraphicsDisplaySettings >
class	DtWriteSettingsLock< DtSharedTacticalGraphicsDisplaySettings >
class	DtBaseSharedSettingsManager< makArchives::DtTacticalGraphicsSettingsRecord, DtSharedTacticalGraphicsDisplaySettings >

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::tacticalGraphicsHeightLinesEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setTacticalGraphicsHeightLinesEnabled

(

bool

enabled

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::remoteGraphicsEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setRemoteGraphicsEnabled

(

bool

enabled

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::showActiveTacticalGraphicsEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setShowActiveTacticalGraphicsEnabled

(

bool

enabled

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::deleteTacticalGraphicsOnHide

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setDeleteTacticalGraphicsOnHide

(

bool

enabled

)

vrvTacticalGraphicUtilities::FriendlyForceColorStyle makVrv::DtSharedTacticalGraphicsDisplaySettings::friendlyForceColorStyle

(

)

const

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::friendlyForceColorOverrideEnabled

(

)

const

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setFriendlyForceColorOverrideEnabled

(

bool

enabled

)

void makVrv::DtSharedTacticalGraphicsDisplaySettings::setFriendlyForceColorOverrideIsBlack

(

bool

isBlack

)

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::friendlyForceColorOverrideIsBlack

(

)

const

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 const 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.

void makVrv::DtSharedTacticalGraphicsDisplaySettings::signalFriendlyForceColorOverrideStyleChange ( )

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::applyFactoryOverrides ( makArchives::DtTacticalGraphicsSettingsRecord &  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< DtSharedTacticalGraphicsDisplaySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedTacticalGraphicsDisplaySettings >

friend

Use the DtWriteSettingsLock to write to the object.

friend class DtBaseSharedSettingsManager< makArchives::DtTacticalGraphicsSettingsRecord, DtSharedTacticalGraphicsDisplaySettings >

friend

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::myTacticalGraphicsHeightLinesEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myRemoteGraphicsEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myShowActiveTacticalGraphicsEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myDeleteTacticalGraphicsOnHide

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myFriendlyForceColorOverrideEnabled

protected

bool makVrv::DtSharedTacticalGraphicsDisplaySettings::myFriendlyForceColorOverrideIsBlack

protected

DtTacticalGraphicsSettingsBackup* makVrv::DtSharedTacticalGraphicsDisplaySettings::myTacticalGraphicsSettingsBackup

protected

---

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

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