makVrv::DtSharedEntityDisplaySettings Class Reference

The shared simulation settings.

Inheritance diagram for makVrv::DtSharedEntityDisplaySettings:

Public Member Functions
virtual	~DtSharedEntityDisplaySettings ()
void	setFromRecord (const makArchives::DtEntitySettingsRecord &rec)
void	getRecord (makArchives::DtEntitySettingsRecord &rec) const
virtual const DtEntityStateSettingsBackup *	settingsBackup () const
virtual DtEntityStateSettingsBackup *	settingsBackup ()
virtual void	backup ()
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	artPartSmoothingEnabled () const
void	setArtPartSmoothingEnabled (bool setting)
float	artPartSmoothingPeriod () const
void	setArtPartSmoothingPeriod (float period)
bool	entityIndicatorEnabled () const
void	setEntityIndicatorEnabled (bool shown)
bool	embarkedEntityLabelsEnabled () const
void	setEmbarkedEntityLabelsEnabled (bool shown)
bool	rotateEntitySymbols () const
void	setRotateEntitySymbols (bool shown)
bool	showStealthsEnabled () const
void	setShowStealthsEnabled (bool enabled)
bool	fireDetonateLinesEnabled () const
void	setFireDetonateLinesEnabled (bool enabled)
bool	entityEmitterVolumesEnabled () const
void	setEntityEmitterVolumesEnabled (bool enabled)
bool	entityHeightAboveTerrainLinesEnabled () const
void	setEntityHeightAboveTerrainLinesEnabled (bool enabled)
DtHeightAboveTerrainMode	entityHeightAboveTerrainMode () const
void	setEntityHeightAboveTerrainMode (DtHeightAboveTerrainMode mode)
DtColorizedModelColorType	colorizedModelColorType () const
void	setColorizedModelColorType (DtColorizedModelColorType colorType)
makArchives::DtAltitudeBasedScaleConfigurationRecordCollection &	getOrCreateDynamicScaleCollection (const std::string &collectionName)
bool	findDynamicScaleCollectionByName (const std::string &collectionName, makArchives::DtAltitudeBasedScaleConfigurationRecordCollection &collection) const
void	setDynamicScaleCollectionMap (const makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap &collectionMap)
const makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap &	dynamicScaleCollectionMap () const
bool	fixedEntityIconScalingEnabled () const
void	setFixedEntityIconScalingEnabled (bool enabled)
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)
makArchives::DtEntitySettingsRecord::BuoyancyCullType	buoyancyCullType () const
void	setBuoyancyCullType (makArchives::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)
bool	occupantsVisible () const
void	setOccupantsVisible (bool visible)
bool	wheelRotationEnabled () const
void	setWheelRotationEnabled (bool setting)
bool	adaptiveTickRateEnabled () const
void	setAdaptiveTickRateEnabled (bool setting)
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 ()

Protected Member Functions
	DtSharedEntityDisplaySettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtEntitySettingsRecord &rec) const

Protected Attributes
bool	myGroundClampingEnabled
float	myGroundClampingRadiusScale
bool	myGroundClampingCullingEnabled
bool	myOrientationClampingEnabled
bool	myLifeformsUprightEnabled
bool	mySmoothingEnabled
float	mySmoothingPeriod
bool	myArtPartSmoothingEnabled
float	myArtPartSmoothingPeriod
bool	myShowEntityLabels
bool	myShowEmbarkedEntityLabels
bool	myShowStealthsEnabled
bool	myFireDetonateLinesEnabled
bool	myEntityEmitterVolumesEnabled
bool	myEntityHeightAboveTerrainLinesEnabled
DtHeightAboveTerrainMode	myEntityHeightAboveTerrainMode
DtColorizedModelColorType	myColorizedModelColorType
makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap	myDynamicScaleCollections
bool	myFixedEntityIconScalingEnabled
float	myEntityIconScaleFactor
bool	myHideEmbarked2DObjects
bool	myRotateEntitySymbols
bool	myOceanWakesEnabled
bool	myHullSprayEffectsEnabled
bool	myBuoyancyModelsEnabled
bool	myBuoyAndBeaconIconsEnabled
unsigned int	myHeightAboveTerrainPeriod
float	myBuoyancyDefaultLODDistance
float	myWakeDefaultLODDistance
float	myBuoyancyMinimumCullDistance
makArchives::DtEntitySettingsRecord::BuoyancyCullType	myBuoyancyCullType
bool	myRotorWashEnabled
bool	myOccupantsVisible
bool	myWheelRotationEnabled
bool	myAdaptiveTickRateEnabled
DtEntityStateSettingsBackup *	myEntitySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedEntityDisplaySettings >
class	DtWriteSettingsLock< DtSharedEntityDisplaySettings >
class	DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >

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

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setArtPartSmoothingEnabled

(

bool

setting

)

float makVrv::DtSharedEntityDisplaySettings::artPartSmoothingPeriod

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setArtPartSmoothingPeriod

(

float

period

)

bool makVrv::DtSharedEntityDisplaySettings::entityIndicatorEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityIndicatorEnabled

(

bool

shown

)

bool makVrv::DtSharedEntityDisplaySettings::embarkedEntityLabelsEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEmbarkedEntityLabelsEnabled

(

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

)

DtHeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettings::entityHeightAboveTerrainMode

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setEntityHeightAboveTerrainMode

(

DtHeightAboveTerrainMode

mode

)

DtColorizedModelColorType makVrv::DtSharedEntityDisplaySettings::colorizedModelColorType

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setColorizedModelColorType

(

DtColorizedModelColorType

colorType

)

makArchives::DtAltitudeBasedScaleConfigurationRecordCollection& makVrv::DtSharedEntityDisplaySettings::getOrCreateDynamicScaleCollection

(

const std::string &

collectionName

)

bool makVrv::DtSharedEntityDisplaySettings::findDynamicScaleCollectionByName	(	const std::string &	collectionName,
		makArchives::DtAltitudeBasedScaleConfigurationRecordCollection &	collection
	)		const

void makVrv::DtSharedEntityDisplaySettings::setDynamicScaleCollectionMap

(

const makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap &

collectionMap

)

const makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap& makVrv::DtSharedEntityDisplaySettings::dynamicScaleCollectionMap

(

)

const

bool makVrv::DtSharedEntityDisplaySettings::fixedEntityIconScalingEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setFixedEntityIconScalingEnabled

(

bool

enabled

)

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

)

makArchives::DtEntitySettingsRecord::BuoyancyCullType makVrv::DtSharedEntityDisplaySettings::buoyancyCullType

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setBuoyancyCullType

(

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

)

bool makVrv::DtSharedEntityDisplaySettings::occupantsVisible

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setOccupantsVisible

(

bool

visible

)

bool makVrv::DtSharedEntityDisplaySettings::wheelRotationEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setWheelRotationEnabled

(

bool

setting

)

bool makVrv::DtSharedEntityDisplaySettings::adaptiveTickRateEnabled

(

)

const

void makVrv::DtSharedEntityDisplaySettings::setAdaptiveTickRateEnabled

(

bool

setting

)

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 const std::string& makVrv::DtSharedEntityDisplaySettings::className ( )

static

The settings object's class name.

bool makVrv::DtSharedEntityDisplaySettings::applyFactoryOverrides ( makArchives::DtEntitySettingsRecord &  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< DtSharedEntityDisplaySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedEntityDisplaySettings >

friend

Use the DtWriteSettingsLock to write to the object.

friend class DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >

friend

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

protected

float makVrv::DtSharedEntityDisplaySettings::myArtPartSmoothingPeriod

protected

bool makVrv::DtSharedEntityDisplaySettings::myShowEntityLabels

protected

bool makVrv::DtSharedEntityDisplaySettings::myShowEmbarkedEntityLabels

protected

bool makVrv::DtSharedEntityDisplaySettings::myShowStealthsEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myFireDetonateLinesEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myEntityEmitterVolumesEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myEntityHeightAboveTerrainLinesEnabled

protected

DtHeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettings::myEntityHeightAboveTerrainMode

protected

DtColorizedModelColorType makVrv::DtSharedEntityDisplaySettings::myColorizedModelColorType

protected

makArchives::DtAltitudeBasedScaleConfigurationRecordCollectionMap makVrv::DtSharedEntityDisplaySettings::myDynamicScaleCollections

protected

bool makVrv::DtSharedEntityDisplaySettings::myFixedEntityIconScalingEnabled

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

makArchives::DtEntitySettingsRecord::BuoyancyCullType makVrv::DtSharedEntityDisplaySettings::myBuoyancyCullType

protected

bool makVrv::DtSharedEntityDisplaySettings::myRotorWashEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myOccupantsVisible

protected

bool makVrv::DtSharedEntityDisplaySettings::myWheelRotationEnabled

protected

bool makVrv::DtSharedEntityDisplaySettings::myAdaptiveTickRateEnabled

protected

DtEntityStateSettingsBackup* makVrv::DtSharedEntityDisplaySettings::myEntitySettingsBackup

protected

---

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

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