The map information overlay is an informational overlay whose creation is dependent on the existence of a channel keyword. The way the channel keyword objects work is that the channel keyword objects are created only on the master display engine. Thus, this object may be created on the master display engine when it is meant to appear on a channel of a remote display engine, or vice versa. This class is a wrapper around the class that implements the overlay visuals and this class will only create the overlay visuals if the object is meant to be visualized on the local display engine (whether its a master or slave).

See Also: DtChannelKeywordMapInformationOverlay; DtMapInformationOverlayInstance

Public Member Functions
virtual	~DtMapInformationOverlay ()

	DtMapInformationOverlay (DtDe &de, DtUniqueID id)

	DtMapInformationOverlay ()=delete

	DtMapInformationOverlay (const DtMapInformationOverlay &other)=delete

DtMapInformationOverlay &	operator= (const DtMapInformationOverlay &other)=delete

virtual void	createVisuals (const std::string &deName, const std::string &winName, const std::string &channelName, const std::string &modelDefinitionName="")

virtual void	setSectionVisible (DtObserverSettingsManager::ObserverSetting setting, bool isVisible)

Protected Attributes
DtDe &	myDe

DtMapInformationOverlayInstance *	myInstance

Constructor & Destructor Documentation

virtual makVrv::DtMapInformationOverlay::~DtMapInformationOverlay ( )

virtual

DTOR.

makVrv::DtMapInformationOverlay::DtMapInformationOverlay	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

makVrv::DtMapInformationOverlay::DtMapInformationOverlay ( )

delete

not allowed

makVrv::DtMapInformationOverlay::DtMapInformationOverlay ( const DtMapInformationOverlay & other )

delete

not allowed

Member Function Documentation

DtMapInformationOverlay& makVrv::DtMapInformationOverlay::operator= ( const DtMapInformationOverlay & other )

delete

not allowed

virtual void makVrv::DtMapInformationOverlay::createVisuals	(	const std::string &	deName,
		const std::string &	winName,
		const std::string &	channelName,
		const std::string &	modelDefinitionName = `""`
	)

virtual

Create any visuals needed for the overlay - also creates visuals for all of the overlay's informational sections. This function does nothing if the display/window/channel combination belongs to another display engine.

virtual void makVrv::DtMapInformationOverlay::setSectionVisible	(	DtObserverSettingsManager::ObserverSetting	setting,
		bool	isVisible
	)

virtual

Set whether or not a particular informational section is visible using its corresponding observer visual type enumerated value If a section is not visible, its visuals are destroyed and its resources are cleaned up. If the section is visible, ensure its visuals have been created. The overlay must have a creator for the informational section that corresponds to the passed in observer setting in order to ensure its visuals are created.

Member Data Documentation

DtDe& makVrv::DtMapInformationOverlay::myDe

protected

DtMapInformationOverlayInstance* makVrv::DtMapInformationOverlay::myInstance

protected

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

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

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation