makVrv::DtSharedEntityDisplaySettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedEntityDisplaySettings:

List of all members.

Public Types
enum	HeightAboveTerrainMode { ShowHatForAll = 0, ShowHatForSelected = 1 }
	Enumeration for the HAT mode. More...
enum	ColorizedModelColorType { UsePrimaryColors = 0, UseIconColors = 1 }
	Enumeration for the model coloring mode. More...
Public Member Functions
virtual	~DtSharedEntityDisplaySettings ()
	DTOR.
void	setFromRecord (const makArchives::DtEntitySettingsRecord &rec)
	Set the entity settings from a record.
void	getRecord (makArchives::DtEntitySettingsRecord &rec) const
	Get the entity settings as a record.
virtual const DtEntityStateSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtEntityStateSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Entity Display Setting Getters/Setters
bool	groundClampingEnabled () const
void	setGroundClampingEnabled (bool enabled)
float	groundClampingRadiusScale () const
void	setGroundClampingRadiusScale (float scale)
bool	groundClampingCullingEnabled () const
void	setGroundClampingCullingEnabled (bool enabled)
bool	orientationClampingEnabled () const
void	setOrientationClampingEnabled (bool enabled)
bool	lifeformsUprightEnabled () const
void	setLifeformsUprightEnabled (bool enabled)
bool	smoothingEnabled () const
void	setSmoothingEnabled (bool enabled)
float	smoothingPeriod () const
void	setSmoothingPeriod (float period)
bool	entityIndicatorEnabled () const
void	setEntityIndicatorEnabled (bool shown)
bool	showStealthsEnabled () const
void	setShowStealthsEnabled (bool enabled)
bool	infoPopupsOnSelectEnabled () const
void	setInfoPopupsOnSelectEnabled (bool enabled)
bool	fireDetonateLinesEnabled () const
void	setFireDetonateLinesEnabled (bool enabled)
bool	entitySensorVolumesEnabled () const
void	setEntitySensorVolumesEnabled (bool enabled)
bool	entityHeightAboveTerrainLinesEnabled () const
void	setEntityHeightAboveTerrainLinesEnabled (bool enabled)
HeightAboveTerrainMode	entityHeightAboveTerrainMode () const
void	setEntityHeightAboveTerrainMode (HeightAboveTerrainMode mode)
bool	entitySimDataEnabled () const
void	setEntitySimDataEnabled (bool enabled)
ColorizedModelColorType	colorizedModelColorType () const
void	setColorizedModelColorType (ColorizedModelColorType colorType)
float	entityIconScale () const
void	setEntityIconScale (float scale)
bool	hideEmbarked2DObjects () const
void	setHideEmbarked2DObjects (bool hide)
Static Public Member Functions
static std::string	className ()
	The settings object's class name.
Protected Member Functions
	DtSharedEntityDisplaySettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).
Protected Attributes
bool	myGroundClampingEnabled
float	myGroundClampingRadiusScale
bool	myGroundClampingCullingEnabled
bool	myOrientationClampingEnabled
bool	myLifeformsUprightEnabled
bool	mySmoothingEnabled
float	mySmoothingPeriod
bool	myShowEntityLabels
bool	myShowStealthsEnabled
bool	myInfoPopupsOnSelectEnabled
bool	myFireDetonateLinesEnabled
bool	myEntitySensorVolumesEnabled
bool	myEntityHeightAboveTerrainLinesEnabled
HeightAboveTerrainMode	myEntityHeightAboveTerrainMode
bool	myEntitySimDataEnabled
ColorizedModelColorType	myColorizedModelColorType
float	myEntityIconScaleFactor
bool	myHideEmbarked2DObjects
DtEntityStateSettingsBackup *	myEntitySettingsBackup
Friends
class	DtReadSettingsLock< DtSharedEntityDisplaySettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedEntityDisplaySettings >
	Use the DtWriteSettingsLock to write to the object.

---

Detailed Description

The shared simulation settings.

---

Member Enumeration Documentation

enum makVrv::DtSharedEntityDisplaySettings::HeightAboveTerrainMode

Enumeration for the HAT mode.

Enumerator:

ShowHatForAll
ShowHatForSelected

enum makVrv::DtSharedEntityDisplaySettings::ColorizedModelColorType

Enumeration for the model coloring mode.

Enumerator:

UsePrimaryColors
UseIconColors

---

Constructor & Destructor Documentation

virtual makVrv::DtSharedEntityDisplaySettings::~DtSharedEntityDisplaySettings

(

)

[virtual]

DTOR.

makVrv::DtSharedEntityDisplaySettings::DtSharedEntityDisplaySettings

(

DtSharedSettingsManager &

manager

)

[protected]

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

---

Member Function Documentation

bool makVrv::DtSharedEntityDisplaySettings::groundClampingEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setGroundClampingEnabled

(

bool

enabled

)

float makVrv::DtSharedEntityDisplaySettings::groundClampingRadiusScale

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setGroundClampingRadiusScale

(

float

scale

)

bool makVrv::DtSharedEntityDisplaySettings::groundClampingCullingEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setGroundClampingCullingEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::orientationClampingEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setOrientationClampingEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::lifeformsUprightEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setLifeformsUprightEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::smoothingEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setSmoothingEnabled

(

bool

enabled

)

float makVrv::DtSharedEntityDisplaySettings::smoothingPeriod

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setSmoothingPeriod

(

float

period

)

bool makVrv::DtSharedEntityDisplaySettings::entityIndicatorEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityIndicatorEnabled

(

bool

shown

)

bool makVrv::DtSharedEntityDisplaySettings::showStealthsEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setShowStealthsEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::infoPopupsOnSelectEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setInfoPopupsOnSelectEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::fireDetonateLinesEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setFireDetonateLinesEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::entitySensorVolumesEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntitySensorVolumesEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::entityHeightAboveTerrainLinesEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityHeightAboveTerrainLinesEnabled

(

bool

enabled

)

HeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettings::entityHeightAboveTerrainMode

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityHeightAboveTerrainMode

(

HeightAboveTerrainMode

mode

)

bool makVrv::DtSharedEntityDisplaySettings::entitySimDataEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntitySimDataEnabled

(

bool

enabled

)

ColorizedModelColorType makVrv::DtSharedEntityDisplaySettings::colorizedModelColorType

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setColorizedModelColorType

(

ColorizedModelColorType

colorType

)

float makVrv::DtSharedEntityDisplaySettings::entityIconScale

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityIconScale

(

float

scale

)

bool makVrv::DtSharedEntityDisplaySettings::hideEmbarked2DObjects

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setHideEmbarked2DObjects

(

bool

hide

)

void makVrv::DtSharedEntityDisplaySettings::setFromRecord

(

const makArchives::DtEntitySettingsRecord &

rec

)

Set the entity settings from a record.

void makVrv::DtSharedEntityDisplaySettings::getRecord

(

makArchives::DtEntitySettingsRecord &

rec

)

const

Get the entity settings as a record.

virtual const DtEntityStateSettingsBackup* makVrv::DtSharedEntityDisplaySettings::settingsBackup

(

)

const [virtual]

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtEntityStateSettingsBackup* makVrv::DtSharedEntityDisplaySettings::settingsBackup

(

)

[virtual]

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedEntityDisplaySettings::backup

(

)

[virtual]

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static std::string makVrv::DtSharedEntityDisplaySettings::className

(

)

[static]

The settings object's class name.

---

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedEntityDisplaySettings > [friend]

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedEntityDisplaySettings > [friend]

Use the DtWriteSettingsLock to write to the object.

---

Member Data Documentation

bool makVrv::DtSharedEntityDisplaySettings::myGroundClampingEnabled [protected]

float makVrv::DtSharedEntityDisplaySettings::myGroundClampingRadiusScale [protected]

bool makVrv::DtSharedEntityDisplaySettings::myGroundClampingCullingEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myOrientationClampingEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myLifeformsUprightEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::mySmoothingEnabled [protected]

float makVrv::DtSharedEntityDisplaySettings::mySmoothingPeriod [protected]

bool makVrv::DtSharedEntityDisplaySettings::myShowEntityLabels [protected]

bool makVrv::DtSharedEntityDisplaySettings::myShowStealthsEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myInfoPopupsOnSelectEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myFireDetonateLinesEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myEntitySensorVolumesEnabled [protected]

bool makVrv::DtSharedEntityDisplaySettings::myEntityHeightAboveTerrainLinesEnabled [protected]

HeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettings::myEntityHeightAboveTerrainMode [protected]

bool makVrv::DtSharedEntityDisplaySettings::myEntitySimDataEnabled [protected]

ColorizedModelColorType makVrv::DtSharedEntityDisplaySettings::myColorizedModelColorType [protected]

float makVrv::DtSharedEntityDisplaySettings::myEntityIconScaleFactor [protected]

bool makVrv::DtSharedEntityDisplaySettings::myHideEmbarked2DObjects [protected]

DtEntityStateSettingsBackup* makVrv::DtSharedEntityDisplaySettings::myEntitySettingsBackup [protected]

---

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

• include/vrvVrl/DtSharedEntityDisplaySettings.h