makVrv::DtSharedEntityDisplaySettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedEntityDisplaySettings:

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	rotateEntitySymbols () const
void	setRotateEntitySymbols (bool shown)
bool	showStealthsEnabled () const
void	setShowStealthsEnabled (bool enabled)
bool	infoPopupsOnSelectEnabled () const
void	setInfoPopupsOnSelectEnabled (bool enabled)
bool	fireDetonateLinesEnabled () const
void	setFireDetonateLinesEnabled (bool enabled)
bool	entityEmitterVolumesEnabled () const
void	setEntityEmitterVolumesEnabled (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)
bool	entityOceanWakesEnabled () const
void	setEntityOceanWakesEnabled (bool enabled)
bool	entityHullSprayEffectsEnabled () const
void	setEntityHullSprayEffectsEnabled (bool enabled)
bool	entityBuoyancyModelsEnabled () const
void	setEntityBuoyancyModelsEnabled (bool enabled)
float	buoyancyDefaultLODDistance () const
void	setBuoyancyDefaultLODDistance (float distance)
float	wakeDefaultLODDistance () const
void	setWakeDefaultLODDistance (float distance)
float	buoyancyMinimumCullDistance () const
void	setBuoyancyMinimumCullDistance (float distance)
DtEntitySettingsRecord::BuoyancyCullType	buoyancyCullType () const
void	setBuoyancyCullType (DtEntitySettingsRecord::BuoyancyCullType cullType)
bool	buoyAndBeaconIconsEnabled () const
void	setBuoyAndBeaconIconsEnabled (bool enabled)
unsigned int	heightAboveTerrainPeriod () const
void	setHeightAboveTerrainPeriod (unsigned int period)
bool	rotorWashEnabled () const
void	setRotorWashEnabled (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.

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	myEntityEmitterVolumesEnabled
bool	myEntityHeightAboveTerrainLinesEnabled
HeightAboveTerrainMode	myEntityHeightAboveTerrainMode
bool	myEntitySimDataEnabled
ColorizedModelColorType	myColorizedModelColorType
float	myEntityIconScaleFactor
bool	myHideEmbarked2DObjects
bool	myRotateEntitySymbols
bool	myOceanWakesEnabled
bool	myHullSprayEffectsEnabled
bool	myBuoyancyModelsEnabled
bool	myBuoyAndBeaconIconsEnabled
unsigned int	myHeightAboveTerrainPeriod
float	myBuoyancyDefaultLODDistance
float	myWakeDefaultLODDistance
float	myBuoyancyMinimumCullDistance
DtEntitySettingsRecord::BuoyancyCullType	myBuoyancyCullType
bool	myRotorWashEnabled
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::rotateEntitySymbols

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setRotateEntitySymbols

(

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

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityEmitterVolumesEnabled

(

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

)

bool makVrv::DtSharedEntityDisplaySettings::entityOceanWakesEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityOceanWakesEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::entityHullSprayEffectsEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityHullSprayEffectsEnabled

(

bool

enabled

)

bool makVrv::DtSharedEntityDisplaySettings::entityBuoyancyModelsEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityBuoyancyModelsEnabled

(

bool

enabled

)

float makVrv::DtSharedEntityDisplaySettings::buoyancyDefaultLODDistance

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setBuoyancyDefaultLODDistance

(

float

distance

)

float makVrv::DtSharedEntityDisplaySettings::wakeDefaultLODDistance

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setWakeDefaultLODDistance

(

float

distance

)

float makVrv::DtSharedEntityDisplaySettings::buoyancyMinimumCullDistance

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setBuoyancyMinimumCullDistance

(

float

distance

)

DtEntitySettingsRecord::BuoyancyCullType makVrv::DtSharedEntityDisplaySettings::buoyancyCullType

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setBuoyancyCullType

(

DtEntitySettingsRecord::BuoyancyCullType

cullType

)

bool makVrv::DtSharedEntityDisplaySettings::buoyAndBeaconIconsEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setBuoyAndBeaconIconsEnabled

(

bool

enabled

)

unsigned int makVrv::DtSharedEntityDisplaySettings::heightAboveTerrainPeriod

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setHeightAboveTerrainPeriod

(

unsigned int

period

)

bool makVrv::DtSharedEntityDisplaySettings::rotorWashEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setRotorWashEnabled

(

bool

enabled

)

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

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

bool makVrv::DtSharedEntityDisplaySettings::myRotateEntitySymbols

protected

bool makVrv::DtSharedEntityDisplaySettings::myOceanWakesEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myHullSprayEffectsEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myBuoyancyModelsEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myBuoyAndBeaconIconsEnabled

protected

unsigned int makVrv::DtSharedEntityDisplaySettings::myHeightAboveTerrainPeriod

protected

float makVrv::DtSharedEntityDisplaySettings::myBuoyancyDefaultLODDistance

protected

float makVrv::DtSharedEntityDisplaySettings::myWakeDefaultLODDistance

protected

float makVrv::DtSharedEntityDisplaySettings::myBuoyancyMinimumCullDistance

protected

DtEntitySettingsRecord::BuoyancyCullType makVrv::DtSharedEntityDisplaySettings::myBuoyancyCullType

protected

bool makVrv::DtSharedEntityDisplaySettings::myRotorWashEnabled

protected

DtEntityStateSettingsBackup* makVrv::DtSharedEntityDisplaySettings::myEntitySettingsBackup

protected

---

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

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