The Master DtMapInformationOverlayManager. More...

Inheritance diagram for makVrf::DtMapInformationOverlayManager:

Classes
struct	Creator

Public Member Functions
	DtMapInformationOverlayManager (makVrv::DtDe &)

virtual	~DtMapInformationOverlayManager ()

virtual void	addInformationOverlay (int key, const makVrv::DtUnicode &menuName, const makVrv::DtUnicode &menuToolTip, const std::string &internalName, const std::string &icon, DtMapInformationOverlayInstanceCreator *creator, bool turnOnIfNotSet=false)
	This class will take ownership of the creator memory so do not delete it after passing it in. More...

virtual void	setInformationOverlayText (int key, const makVrv::DtUnicode &menuName, const makVrv::DtUnicode &menuToolTip)

virtual void	getBackgroundColor (float &r, float &g, float &b, float &a)
	Get/set the backgroud color of the map overlay. More...

virtual void	setBackgroundColor (float r, float g, float b, float a)

virtual std::vector< int >	registeredOverlays () const
	Returns the key values of the myMapInformationOverlayCreators. More...

virtual DtMapInformationOverlayInstance *	createInformationOverlay (int) const
	Creates an information overlay of the give type. More...

virtual bool	settingRegistered (int) const
	Returns whether or not there is a creator for this setting. More...

virtual void	initializeDefaultSettings ()
	If not already set by user, turns on overlays by default. More...

virtual void	setOverlayGroup (float)
	Sets the overlay group. Default is 2. More...

virtual float	overlayGroup () const

virtual void	setBulleyeModelDefinitionForForce (const std::string &, int force)
	Set up a model definition to use for a bullseye image for informational dislpay by force. More...

virtual std::string	bullseyeModelDefinitionForForce (int) const

virtual void	setUseModelDefinitionForBullseye (bool)
	Whether or not to use the model definition (true) or a square color for force bullseye on informational panels. More...

bool	useModelDefinitionForBullseye () const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtMapInformationOverlayManager &	instance (makVrv::DtDe &de)
	Returns instance of the messager. More...

static void	registerInstance (makVrv::DtDe &, DtMapInformationOverlayManager *)

Public Attributes
boost::signals2::signal< void(float, float, float, float)>	signal_backgroundColorChanged

boost::signals2::signal< void(float)>	signal_overlayGroupChanged

boost::signals2::signal< void(int, std::string)>	signal_bullseyeModelDefinitionForForceChanged

boost::signals2::signal< void(bool)>	signal_modelDefinitionForBullseyeChanged

Protected Types
typedef std::map< int, Creator >	MapInformationOverlayCreators

Protected Attributes
MapInformationOverlayCreators	myMapInformationOverlayCreators

makVrv::DtDe &	myDe

float	myBackgroundColor [4]

float	myOverlayGroup

std::map< int, std::string >	myForceToBullseyeModelDefinition

bool	myUseModelDefinitionForBullseye

Detailed Description

The Master DtMapInformationOverlayManager.

This manager will keep track of what items can go on the map information overlay. Note that the overlay is currently only supported for the projected (Plan View/2D) model set

Member Typedef Documentation

typedef std::map<int, Creator> makVrf::DtMapInformationOverlayManager::MapInformationOverlayCreators

protected

Constructor & Destructor Documentation

makVrf::DtMapInformationOverlayManager::DtMapInformationOverlayManager ( makVrv::DtDe & )

virtual makVrf::DtMapInformationOverlayManager::~DtMapInformationOverlayManager ( )

virtual

Member Function Documentation

static DtMapInformationOverlayManager& makVrf::DtMapInformationOverlayManager::instance ( makVrv::DtDe & de )

static

Returns instance of the messager.

static void makVrf::DtMapInformationOverlayManager::registerInstance	(	makVrv::DtDe &	,
		DtMapInformationOverlayManager *
	)

static

virtual void makVrf::DtMapInformationOverlayManager::addInformationOverlay	(	int	key,
		const makVrv::DtUnicode &	menuName,
		const makVrv::DtUnicode &	menuToolTip,
		const std::string &	internalName,
		const std::string &	icon,
		DtMapInformationOverlayInstanceCreator *	creator,
		bool	turnOnIfNotSet = `false`
	)

virtual

This class will take ownership of the creator memory so do not delete it after passing it in.

virtual void makVrf::DtMapInformationOverlayManager::setInformationOverlayText	(	int	key,
		const makVrv::DtUnicode &	menuName,
		const makVrv::DtUnicode &	menuToolTip
	)

virtual

virtual void makVrf::DtMapInformationOverlayManager::getBackgroundColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)

virtual

Get/set the backgroud color of the map overlay.

virtual void makVrf::DtMapInformationOverlayManager::setBackgroundColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

virtual std::vector<int> makVrf::DtMapInformationOverlayManager::registeredOverlays ( ) const

virtual

Returns the key values of the myMapInformationOverlayCreators.

virtual DtMapInformationOverlayInstance* makVrf::DtMapInformationOverlayManager::createInformationOverlay ( int ) const

virtual

Creates an information overlay of the give type.

virtual bool makVrf::DtMapInformationOverlayManager::settingRegistered ( int ) const

virtual

Returns whether or not there is a creator for this setting.

virtual void makVrf::DtMapInformationOverlayManager::initializeDefaultSettings ( )

virtual

If not already set by user, turns on overlays by default.

virtual void makVrf::DtMapInformationOverlayManager::setOverlayGroup ( float )

virtual

Sets the overlay group. Default is 2.

virtual float makVrf::DtMapInformationOverlayManager::overlayGroup ( ) const

virtual

virtual void makVrf::DtMapInformationOverlayManager::setBulleyeModelDefinitionForForce	(	const std::string &	,
		int	force
	)

virtual

Set up a model definition to use for a bullseye image for informational dislpay by force.

virtual std::string makVrf::DtMapInformationOverlayManager::bullseyeModelDefinitionForForce ( int ) const

virtual

virtual void makVrf::DtMapInformationOverlayManager::setUseModelDefinitionForBullseye ( bool )

virtual

Whether or not to use the model definition (true) or a square color for force bullseye on informational panels.

bool makVrf::DtMapInformationOverlayManager::useModelDefinitionForBullseye ( ) const

Member Data Documentation

boost::signals2::signal<void (float, float, float, float)> makVrf::DtMapInformationOverlayManager::signal_backgroundColorChanged

boost::signals2::signal<void (float)> makVrf::DtMapInformationOverlayManager::signal_overlayGroupChanged

boost::signals2::signal<void (int, std::string)> makVrf::DtMapInformationOverlayManager::signal_bullseyeModelDefinitionForForceChanged

boost::signals2::signal<void (bool)> makVrf::DtMapInformationOverlayManager::signal_modelDefinitionForBullseyeChanged

MapInformationOverlayCreators makVrf::DtMapInformationOverlayManager::myMapInformationOverlayCreators

protected

makVrv::DtDe& makVrf::DtMapInformationOverlayManager::myDe

protected

float makVrf::DtMapInformationOverlayManager::myBackgroundColor[4]

protected

float makVrf::DtMapInformationOverlayManager::myOverlayGroup

protected

std::map<int, std::string> makVrf::DtMapInformationOverlayManager::myForceToBullseyeModelDefinition

protected

bool makVrf::DtMapInformationOverlayManager::myUseModelDefinitionForBullseye

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfGuiCore/mapInformationOverlayManager.h

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation