Settings manager for handling entity disoplay settings. More...

Inheritance diagram for makVrv::DtSharedEntityDisplaySettingsManager:

Public Member Functions
virtual	~DtSharedEntityDisplaySettingsManager ()
	DTOR.
void	connectInputSignals ()
	Connect to signal indicating settings have been backed up.
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	rotateEntitySymbols () const
virtual void	setRotateEntitySymbols (bool enabled)
virtual bool	showStealthsEnabled () const
virtual void	setShowStealthsEnabled (bool enabled)
virtual bool	infoPopupsOnSelectEnabled () const
virtual void	setInfoPopupsOnSelectEnabled (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 DtSharedEntityDisplaySettings::HeightAboveTerrainMode	entityHeightAboveTerrainMode () const
virtual void	setEntityHeightAboveTerrainMode (DtSharedEntityDisplaySettings::HeightAboveTerrainMode mode)
virtual bool	entitySimDataEnabled () const
virtual void	setEntitySimDataEnabled (bool enabled)
virtual DtSharedEntityDisplaySettings::ColorizedModelColorType	colorizedModelColorType () const
virtual void	setColorizedModelColorType (DtSharedEntityDisplaySettings::ColorizedModelColorType colorType)
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)
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)
	CTOR.
virtual	~DtBaseSharedSettingsManager ()
	Virtual DTOR.
virtual void	initializeBackup ()
	Creates a backup of the settings' current state.
virtual void	setFromRecord (const makArchives::DtEntitySettingsRecord &record)
	Set the current settings' state from the given record.
virtual void	getRecord (makArchives::DtEntitySettingsRecord &record) const
	Store the current settings' state in the given record.
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR.
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled.
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager.
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager.
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record.
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record.
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object.
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const).
virtual void	loadDefaults ()
	Initializes the settings and creates a backup.
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk).
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk.
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file.
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file.
virtual void	getSplitRecord (std::vector< makArchives::DtEntitySettingsRecord > &rec, std::vector< std::string > &fileNames)
	For directory support, split the main record into different sub-records and give them each a file name.
virtual void	addRecords (makArchives::DtEntitySettingsRecord &rec, makArchives::DtEntitySettingsRecord &combinedRec)
	For directory support, when reading in a directory, add the records from each file to the combined record.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtSharedEntityDisplaySettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.

Protected Member Functions
	DtSharedEntityDisplaySettingsManager (DtDe &de)
	Protected CTOR ( use instance(..) )
virtual void	slot_backupRestored (const DtSettingsBackup *s)
	Called when a mapping is restored, save out if auto save is true.

Private Member Functions
void	toggleEntityIndicators ()
	Toggles the visibility of the entity indicators.
void	toggleRotateEntitySymbols ()
	Toggles the rotation of entity symbols.
void	toggleEntityHatLines ()
	Toggles the visibility of the entity HAT lines.
void	toggleEntityHatMode ()
	Toggles the HAT line render mode.
void	toggleEmitterVolumes ()
	Toggles the visibility of emitter volumes.

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

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

Detailed Description

Settings manager for handling entity disoplay settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedEntityDisplaySettingsManager::~DtSharedEntityDisplaySettingsManager ( )

virtual

DTOR.

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

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

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

static

Get an instance of the settings manager.

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::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::infoPopupsOnSelectEnabled ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setInfoPopupsOnSelectEnabled ( 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 DtSharedEntityDisplaySettings::HeightAboveTerrainMode makVrv::DtSharedEntityDisplaySettingsManager::entityHeightAboveTerrainMode ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setEntityHeightAboveTerrainMode ( DtSharedEntityDisplaySettings::HeightAboveTerrainMode mode )

virtual

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

virtual

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

virtual

virtual DtSharedEntityDisplaySettings::ColorizedModelColorType makVrv::DtSharedEntityDisplaySettingsManager::colorizedModelColorType ( ) const

virtual

virtual void makVrv::DtSharedEntityDisplaySettingsManager::setColorizedModelColorType ( DtSharedEntityDisplaySettings::ColorizedModelColorType colorType )

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 void makVrv::DtSharedEntityDisplaySettingsManager::slot_backupRestored ( const DtSettingsBackup * s )

protectedvirtual

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

void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityIndicators ( )

private

Toggles the visibility of the entity indicators.

void makVrv::DtSharedEntityDisplaySettingsManager::toggleRotateEntitySymbols ( )

private

Toggles the rotation of entity symbols.

void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityHatLines ( )

private

Toggles the visibility of the entity HAT lines.

void makVrv::DtSharedEntityDisplaySettingsManager::toggleEntityHatMode ( )

private

Toggles the HAT line render mode.

void makVrv::DtSharedEntityDisplaySettingsManager::toggleEmitterVolumes ( )

private

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 retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  Manager requirements:
  1) Static instance function
  2) Protected DtSignalConnectionManager named myConnections.
  3) Member functioned called loadDefaults which takes no arguments.
     and loads the default settings of the manager or factory from disk.
  4) define defaultManagerInstanceFunction as friend.
  5) define defaultManagerRegisterInstanceFunction as friend (see below).
  5) Protected Constructor which only takes a DtDe reference.
  @code

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.
  @code

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 retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

  @code

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtSharedEntityDisplaySettingsManager.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation