DtObserverSettingsManager keeps track of the mapping between string and integer keys for observer settings; display names for observer settings; which observer settings are global, projection- specific, and model set-specific; and which settings should appear on the Observer menu and Observer toolbar. More...

Inheritance diagram for makVrv::DtObserverSettingsManager:

[legend]

List of all members.

Public Types
enum	ObserverSetting { Global = 0, ShowMainModel = 1, EnableSpeedScaling, EnableTerrainDragging, EnableViewControl, ConstrainToTerrain, ShowDustClouds, ShowWakes, ShowContrails, ShowFootprints, ShowTreads, ShowFire, ShowSmokePlumes, ShowTrackHistories, ShowDetonations, ShowMuzzleFlashes, EnableModelScaling, DisplaySky, ForceNorthOrientation, DisplayCompass, DisplayGridLines, DisplayFeatures }
typedef DtVisualTypeManager::SupportedModelSets	ModelSetList
typedef std::vector< int >	GlobalSettingsList
typedef std::vector< int >	ProjectionSettingsList
typedef std::vector< int >	ModelSetSettingsList
Public Member Functions
virtual	~DtObserverSettingsManager ()
	DTOR.
int	registerGlobalObserverSetting (const std::string &stringKey, const std::string &iconName="")
	Register a setting as global, and generate an integer key.
void	registerGlobalObserverSetting (const std::string &stringKey, int intKey, const std::string &iconName="")
	Register a setting as global, specifying the integer key.
int	registerProjectionSpecificObserverSetting (const std::string &stringKey, bool is2D, const std::string &iconName="")
	Register a setting as projection-specific, and generate an integer key.
void	registerProjectionSpecificObserverSetting (const std::string &stringKey, int intKey, bool is2D, const std::string &iconName="")
	Register a setting as projection-specific, specifying the integer key.
int	registerModelSetSpecificObserverSetting (const std::string &stringKey, ModelSetList modelSets, const std::string &iconName="")
	Register a setting as model set-specific, and generate an integer key.
void	registerModelSetSpecificObserverSetting (const std::string &stringKey, int intKey, ModelSetList modelSets, const std::string &iconName="")
	Register a setting as model set-specific, specifying the integer key.
int	lookupObserverSettingIntKey (const std::string &stringKey) const
	Look up the integer key for this observer setting string key.
const std::string *	findObserverSettingStringKey (int intKey) const
	Look up the string key for this observer setting integer key.
const std::string *	findObserverSettingDisplayName (int intKey) const
	Look up the specified setting's display name.
const std::string *	findObserverSettingToolTip (int intKey) const
	Look up the specified setting's tool tip.
const std::string *	findObserverSettingIcon (int intKey) const
	Look up the specified setting's icon to use.
const GlobalSettingsList &	globalSettings () const
	Get the list of global settings.
const ProjectionSettingsList &	projectionSpecificSettings (bool is2D) const
	Get the list of projection-specific settings.
const ModelSetSettingsList &	modelSetSpecificSettings (int modelSet) const
	Get the list of model set-specific settings.
bool	isSettingValid (bool projection, int modelSet, int settingKey)
	Returns true if the setting is on the global list, the projection settings list for the projection specified, or the model set settings list for the model set specified.
DtObserverSettingsDisplayNameProvider &	displayNameProvider () const
	Returns the display name provider to add display items to the GUI for menus.
Static Public Member Functions
static DtObserverSettingsManager &	instance (DtDe &de)
	Get an instance used to emit, or to connect.
Protected Types
typedef std::map< bool, ProjectionSettingsList >	ProjectionSettingsMap
typedef std::map< int, ModelSetSettingsList >	ModelSetSettingsMap
typedef std::map< int, std::string >	IconNameMap
typedef std::map< int, bool >	InclusionMap
Protected Member Functions
void	registerSettingKey (ModelSetList modelSets, int key)
	DtObserverSettingsManager (DtDe &)
	CTOR.
void	registerProjectionSetting (bool projection, int key)
void	registerModelSetSetting (int modelSet, int key)
void	registerIconName (int key, const std::string &iconName)
Protected Attributes
DtDe &	myDe
DtSharedVisualizerTypeMappingsManager &	myMappingSharer
DtObserverSettingsDisplayNameProvider *	myDisplayNameProvider
DtObserverSettingsToolTipProvider *	myToolTipProvider
DtStringKeyConverter	myKeyConverter
GlobalSettingsList	myGlobalSettings
ProjectionSettingsMap	myProjectionSpecificSettings
ModelSetSettingsMap	myModelSetSpecificSettings
ProjectionSettingsList	myEmptyProjectionList
ModelSetSettingsList	myEmptyModelSetList
IconNameMap	myIconNameMap
Friends
class	DtObserverSettingsManagerCreator

Detailed Description

DtObserverSettingsManager keeps track of the mapping between string and integer keys for observer settings; display names for observer settings; which observer settings are global, projection- specific, and model set-specific; and which settings should appear on the Observer menu and Observer toolbar.

Observer Settings Integer keys are used everywhere internally; the string keys are written to and read from files (and the mapping from int to string and vice versa is done at write and/or read time).

Member Typedef Documentation

typedef DtVisualTypeManager::SupportedModelSets makVrv::DtObserverSettingsManager::ModelSetList

typedef std::vector<int> makVrv::DtObserverSettingsManager::GlobalSettingsList

typedef std::vector<int> makVrv::DtObserverSettingsManager::ProjectionSettingsList

typedef std::vector<int> makVrv::DtObserverSettingsManager::ModelSetSettingsList

typedef std::map<bool, ProjectionSettingsList> makVrv::DtObserverSettingsManager::ProjectionSettingsMap [protected]

typedef std::map<int, ModelSetSettingsList> makVrv::DtObserverSettingsManager::ModelSetSettingsMap [protected]

typedef std::map<int, std::string> makVrv::DtObserverSettingsManager::IconNameMap [protected]

typedef std::map<int, bool> makVrv::DtObserverSettingsManager::InclusionMap [protected]

Member Enumeration Documentation

enum makVrv::DtObserverSettingsManager::ObserverSetting

Enumerator:

Global
ShowMainModel
EnableSpeedScaling
EnableTerrainDragging
EnableViewControl
ConstrainToTerrain
ShowDustClouds
ShowWakes
ShowContrails
ShowFootprints
ShowTreads
ShowFire
ShowSmokePlumes
ShowTrackHistories
ShowDetonations
ShowMuzzleFlashes
EnableModelScaling
DisplaySky
ForceNorthOrientation
DisplayCompass
DisplayGridLines
DisplayFeatures

Constructor & Destructor Documentation

virtual makVrv::DtObserverSettingsManager::~DtObserverSettingsManager ( ) [virtual]

DTOR.

makVrv::DtObserverSettingsManager::DtObserverSettingsManager ( DtDe & ) [protected]

CTOR.

Member Function Documentation

static DtObserverSettingsManager& makVrv::DtObserverSettingsManager::instance ( DtDe & de ) [static]

Get an instance used to emit, or to connect.

int makVrv::DtObserverSettingsManager::registerGlobalObserverSetting	(	const std::string &	stringKey,
		const std::string &	iconName = `""`
	)

Register a setting as global, and generate an integer key.

void makVrv::DtObserverSettingsManager::registerGlobalObserverSetting	(	const std::string &	stringKey,
		int	intKey,
		const std::string &	iconName = `""`
	)

Register a setting as global, specifying the integer key.

int makVrv::DtObserverSettingsManager::registerProjectionSpecificObserverSetting	(	const std::string &	stringKey,
		bool	is2D,
		const std::string &	iconName = `""`
	)

Register a setting as projection-specific, and generate an integer key.

void makVrv::DtObserverSettingsManager::registerProjectionSpecificObserverSetting	(	const std::string &	stringKey,
		int	intKey,
		bool	is2D,
		const std::string &	iconName = `""`
	)

Register a setting as projection-specific, specifying the integer key.

int makVrv::DtObserverSettingsManager::registerModelSetSpecificObserverSetting	(	const std::string &	stringKey,
		ModelSetList	modelSets,
		const std::string &	iconName = `""`
	)

Register a setting as model set-specific, and generate an integer key.

void makVrv::DtObserverSettingsManager::registerModelSetSpecificObserverSetting	(	const std::string &	stringKey,
		int	intKey,
		ModelSetList	modelSets,
		const std::string &	iconName = `""`
	)

Register a setting as model set-specific, specifying the integer key.

int makVrv::DtObserverSettingsManager::lookupObserverSettingIntKey ( const std::string & stringKey ) const

Look up the integer key for this observer setting string key.

*Returns -1 if the string key doesn't exist

const std::string* makVrv::DtObserverSettingsManager::findObserverSettingStringKey ( int intKey ) const

Look up the string key for this observer setting integer key.

Returns "" if the integer key doesn't exist

const std::string* makVrv::DtObserverSettingsManager::findObserverSettingDisplayName ( int intKey ) const

Look up the specified setting's display name.

const std::string* makVrv::DtObserverSettingsManager::findObserverSettingToolTip ( int intKey ) const

Look up the specified setting's tool tip.

If the tool tip does not exist, returns display name

const std::string* makVrv::DtObserverSettingsManager::findObserverSettingIcon ( int intKey ) const

Look up the specified setting's icon to use.

const GlobalSettingsList& makVrv::DtObserverSettingsManager::globalSettings ( ) const

Get the list of global settings.

const ProjectionSettingsList& makVrv::DtObserverSettingsManager::projectionSpecificSettings ( bool is2D ) const

Get the list of projection-specific settings.

const ModelSetSettingsList& makVrv::DtObserverSettingsManager::modelSetSpecificSettings ( int modelSet ) const

Get the list of model set-specific settings.

bool makVrv::DtObserverSettingsManager::isSettingValid	(	bool	projection,
		int	modelSet,
		int	settingKey
	)

Returns true if the setting is on the global list, the projection settings list for the projection specified, or the model set settings list for the model set specified.

DtObserverSettingsDisplayNameProvider& makVrv::DtObserverSettingsManager::displayNameProvider ( ) const [inline]

Returns the display name provider to add display items to the GUI for menus.

void makVrv::DtObserverSettingsManager::registerSettingKey	(	ModelSetList	modelSets,
		int	key
	)		`[protected]`

void makVrv::DtObserverSettingsManager::registerProjectionSetting	(	bool	projection,
		int	key
	)		`[protected]`

void makVrv::DtObserverSettingsManager::registerModelSetSetting	(	int	modelSet,
		int	key
	)		`[protected]`

void makVrv::DtObserverSettingsManager::registerIconName	(	int	key,
		const std::string &	iconName
	)		`[protected]`

Friends And Related Function Documentation

friend class DtObserverSettingsManagerCreator [friend]

Member Data Documentation

DtDe& makVrv::DtObserverSettingsManager::myDe [protected]

DtSharedVisualizerTypeMappingsManager& makVrv::DtObserverSettingsManager::myMappingSharer [protected]

DtObserverSettingsDisplayNameProvider* makVrv::DtObserverSettingsManager::myDisplayNameProvider [protected]

DtObserverSettingsToolTipProvider* makVrv::DtObserverSettingsManager::myToolTipProvider [protected]

DtStringKeyConverter makVrv::DtObserverSettingsManager::myKeyConverter [protected]

GlobalSettingsList makVrv::DtObserverSettingsManager::myGlobalSettings [protected]

ProjectionSettingsMap makVrv::DtObserverSettingsManager::myProjectionSpecificSettings [protected]

ModelSetSettingsMap makVrv::DtObserverSettingsManager::myModelSetSpecificSettings [protected]

ProjectionSettingsList makVrv::DtObserverSettingsManager::myEmptyProjectionList [protected]

ModelSetSettingsList makVrv::DtObserverSettingsManager::myEmptyModelSetList [protected]

IconNameMap makVrv::DtObserverSettingsManager::myIconNameMap [protected]

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

include/vrvCore/DtObserverSettingsManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes