makVrv::DtSharedEntityDisplaySettingsManager Class Reference

Settings manager for handling entity disoplay settings.

Inheritance diagram for makVrv::DtSharedEntityDisplaySettingsManager:

Public Member Functions
virtual	~DtSharedEntityDisplaySettingsManager ()
	DtSharedEntityDisplaySettingsManager ()=delete
	DtSharedEntityDisplaySettingsManager (const DtSharedEntityDisplaySettingsManager &)=delete
DtSharedEntityDisplaySettingsManager &	operator= (const DtSharedEntityDisplaySettingsManager &)=delete
void	connectInputSignals ()
Setting Getters/Setters
virtual bool	groundClampingEnabled () const
virtual void	setGroundClampingEnabled (bool enabled)
virtual float	groundClampingRadiusScale () const
virtual void	setGroundClampingRadiusScale (float distance)
virtual bool	groundClampingCullingEnabled () const
virtual void	setGroundClampingCullingEnabled (bool enabled)
virtual bool	orientationClampingEnabled () const
virtual void	setOrientationClampingEnabled (bool enabled)
virtual bool	lifeformsUprightEnabled () const
virtual void	setLifeformsUprightEnabled (bool enabled)
virtual bool	smoothingEnabled () const
virtual void	setSmoothingEnabled (bool enabled)
virtual float	smoothingPeriod () const
virtual void	setSmoothingPeriod (float period)
virtual bool	entityIndicatorEnabled () const
virtual void	setEntityIndicatorEnabled (bool enabled)
virtual bool	embarkedEntityLabelsEnabled () const
virtual void	setEmbarkedEntityLabelsEnabled (bool enabled)
virtual bool	rotateEntitySymbols () const
virtual void	setRotateEntitySymbols (bool enabled)
virtual bool	showStealthsEnabled () const
virtual void	setShowStealthsEnabled (bool enabled)
virtual bool	fireDetonateLinesEnabled () const
virtual void	setFireDetonateLinesEnabled (bool enabled)
virtual bool	emitterVolumesVisible () const
virtual void	setEmitterVolumesVisible (bool visible)
virtual bool	entityHeightAboveTerrainLinesEnabled () const
virtual void	setEntityHeightAboveTerrainLinesEnabled (bool enabled)
virtual DtHeightAboveTerrainMode	entityHeightAboveTerrainMode () const
virtual void	setEntityHeightAboveTerrainMode (DtHeightAboveTerrainMode mode)
virtual DtColorizedModelColorType	colorizedModelColorType () const
virtual void	setColorizedModelColorType (DtColorizedModelColorType colorType)
virtual bool	fixedEntityIconScalingEnabled () const
virtual void	setFixedEntityIconScalingEnabled (bool enabled)
virtual float	entityIconScale () const
virtual void	setEntityIconScale (float scale)
virtual bool	hideEmbarked2DObjects () const
virtual void	setHideEmbarked2DObjects (bool b)
virtual bool	entityOceanWakesEnabled () const
virtual void	setEntityOceanWakesEnabled (bool enabled)
virtual bool	entityHullSprayEffectsEnabled () const
virtual void	setEntityHullSprayEffectsEnabled (bool enabled)
virtual bool	entityBuoyancyModelsEnabled () const
virtual void	setEntityBuoyancyModelsEnabled (bool enabled)
virtual float	buoyancyDefaultLODDistance () const
virtual void	setBuoyancyDefaultLODDistance (float distance)
virtual float	wakeDefaultLODDistance () const
virtual void	setWakeDefaultLODDistance (float distance)
virtual float	buoyancyMinimumCullDistance () const
virtual void	setBuoyancyMinimumCullDistance (float distance)
virtual DtEntitySettingsRecord::BuoyancyCullType	buoyancyCullType () const
virtual void	setBuoyancyCullType (DtEntitySettingsRecord::BuoyancyCullType cullType)
virtual bool	buoyAndBeaconIconsEnabled () const
virtual void	setBuoyAndBeaconIconsEnabled (bool enabled)
virtual unsigned int	heightAboveTerrainPeriod () const
virtual void	setHeightAboveTerrainPeriod (unsigned int period)
virtual bool	rotorWashEnabled () const
virtual void	setRotorWashEnabled (bool enabled)
virtual bool	occupantsVisible () const
virtual void	setOccupantsVisible (bool visible)
virtual bool	adaptiveTickRateEnabled () const
virtual void	setAdaptiveTickRateEnabled (bool enabled)
Public Member Functions inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >
	DtBaseSharedSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSharedSettingsManager ()
virtual void	initializeBackup ()
virtual void	setFromRecord (const makArchives::DtEntitySettingsRecord &record)
virtual void	getRecord (makArchives::DtEntitySettingsRecord &record) const
virtual bool	getOverriddenFactoryRecord (makArchives::DtEntitySettingsRecord &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtCommonBaseSettingsManager ()
virtual void	autoSaveIfNecessary ()
virtual void	setAutoSave (bool doit)
virtual bool	autoSave () const
virtual void	setUseDefaultSettingsRecord (bool useit)
virtual bool	useDefaultSettingsRecord () const
virtual DtDeSettings *	settings ()
virtual const DtDeSettings *	settings () const
virtual DtSettingsBackup *	settingsBackup ()
virtual const DtSettingsBackup *	settingsBackup () const
virtual void	loadDefaults ()
virtual void	saveDefaultSettings ()
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
virtual void	importSettings (const std::string &filePath)
virtual void	exportSettings (const std::string &filePath) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtSharedEntityDisplaySettingsManager &	instance (DtDe &de)

Protected Member Functions
	DtSharedEntityDisplaySettingsManager (DtDe &de)
virtual void	slot_backupRestored (const DtSettingsBackup *s)
virtual void	onObserverModeSettingChanged (int observerMode, int settingKey)
virtual void	toggleEntityIndicators ()
virtual void	toggleEmbarkedEntityLabels ()
virtual void	toggleRotateEntitySymbols ()
virtual void	toggleEntityHatLines ()
virtual void	toggleEntityHatMode ()
virtual void	toggleEmitterVolumes ()

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >
typedef DtSharedRecordSettingsBackup < DtSharedEntityDisplaySettings, makArchives::DtEntitySettingsRecord >	SharedRecordBackupType
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Constructor & Destructor Documentation

virtual makVrv::DtSharedEntityDisplaySettingsManager::~DtSharedEntityDisplaySettingsManager ( )

virtual

DTOR.

makVrv::DtSharedEntityDisplaySettingsManager::DtSharedEntityDisplaySettingsManager ( )

delete

Default CTOR (Not Implemented)

makVrv::DtSharedEntityDisplaySettingsManager::DtSharedEntityDisplaySettingsManager ( const DtSharedEntityDisplaySettingsManager &  )

delete

Copy CTOR (Not Implemented)

makVrv::DtSharedEntityDisplaySettingsManager::DtSharedEntityDisplaySettingsManager ( DtDe &  de )

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

DtSharedEntityDisplaySettingsManager& makVrv::DtSharedEntityDisplaySettingsManager::operator= ( const DtSharedEntityDisplaySettingsManager &  )

delete

Assignment Operator (Not Implemented)

void makVrv::DtSharedEntityDisplaySettingsManager::connectInputSignals

(

)

Connect to signal indicating settings have been backed up.

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::groundClampingEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setGroundClampingEnabled ( bool  enabled )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::groundClampingRadiusScale ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setGroundClampingRadiusScale ( float  distance )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::groundClampingCullingEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setGroundClampingCullingEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::orientationClampingEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setOrientationClampingEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::lifeformsUprightEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setLifeformsUprightEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::smoothingEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setSmoothingEnabled ( bool  enabled )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::smoothingPeriod ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setSmoothingPeriod ( float  period )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::entityIndicatorEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityIndicatorEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::embarkedEntityLabelsEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEmbarkedEntityLabelsEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::rotateEntitySymbols ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setRotateEntitySymbols ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::showStealthsEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setShowStealthsEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::fireDetonateLinesEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setFireDetonateLinesEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::emitterVolumesVisible ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEmitterVolumesVisible ( bool  visible )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::entityHeightAboveTerrainLinesEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityHeightAboveTerrainLinesEnabled ( bool  enabled )

virtual

virtual DtHeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettingsManager::entityHeightAboveTerrainMode ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityHeightAboveTerrainMode ( DtHeightAboveTerrainMode  mode )

virtual

virtual DtColorizedModelColorType makVrv::DtSharedEntityDisplaySettingsManager::colorizedModelColorType ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setColorizedModelColorType ( DtColorizedModelColorType  colorType )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::fixedEntityIconScalingEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setFixedEntityIconScalingEnabled ( bool  enabled )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::entityIconScale ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityIconScale ( float  scale )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::hideEmbarked2DObjects ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setHideEmbarked2DObjects ( bool  b )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::entityOceanWakesEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityOceanWakesEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::entityHullSprayEffectsEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityHullSprayEffectsEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::entityBuoyancyModelsEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityBuoyancyModelsEnabled ( bool  enabled )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::buoyancyDefaultLODDistance ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setBuoyancyDefaultLODDistance ( float  distance )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::wakeDefaultLODDistance ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setWakeDefaultLODDistance ( float  distance )

virtual

virtual float makVrv::DtSharedEntityDisplaySettingsManager::buoyancyMinimumCullDistance ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setBuoyancyMinimumCullDistance ( float  distance )

virtual

virtual DtEntitySettingsRecord::BuoyancyCullType makVrv::DtSharedEntityDisplaySettingsManager::buoyancyCullType ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setBuoyancyCullType ( DtEntitySettingsRecord::BuoyancyCullType  cullType )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::buoyAndBeaconIconsEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setBuoyAndBeaconIconsEnabled ( bool  enabled )

virtual

virtual unsigned int makVrv::DtSharedEntityDisplaySettingsManager::heightAboveTerrainPeriod ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setHeightAboveTerrainPeriod ( unsigned int  period )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::rotorWashEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setRotorWashEnabled ( bool  enabled )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::occupantsVisible ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setOccupantsVisible ( bool  visible )

virtual

virtual bool makVrv::DtSharedEntityDisplaySettingsManager::adaptiveTickRateEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setAdaptiveTickRateEnabled ( bool  enabled )

virtual

static DtSharedEntityDisplaySettingsManager& makVrv::DtSharedEntityDisplaySettingsManager::instance ( DtDe &  de )

static

Get an instance of the settings manager.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::slot_backupRestored ( const DtSettingsBackup *  s )

protectedvirtual

Called when a mapping is restored, save out if auto save is true.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::onObserverModeSettingChanged ( int  observerMode, int  settingKey  )

protectedvirtual

slot when observer mode settings change, used to turn off "Show Occupants" when model scaling enabled.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityIndicators ( )

protectedvirtual

Toggles the visibility of the entity indicators (labels).

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleEmbarkedEntityLabels ( )

protectedvirtual

Toggles the visibility of the embarked entity labels.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleRotateEntitySymbols ( )

protectedvirtual

Toggles the rotation of entity symbols.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityHatLines ( )

protectedvirtual

Toggles the visibility of the entity HAT lines.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityHatMode ( )

protectedvirtual

Toggles the HAT line render mode.

virtual void makVrv::DtSharedEntityDisplaySettingsManager::toggleEmitterVolumes ( )

protectedvirtual

Toggles the visibility of emitter volumes.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction ( DtDe &  de, bool  allowedInSlave  )

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction ( DtDe &  de, ManagerClass *  mgr  )

friend

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

---

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

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