DtMapInformationOverlayInstance is responsible for creating and updating an information overlay in a Plan View. The overlay has a set of informational sections that it can visualize. Informational sections can be removed from the main information overlay and custom informational sections can be added. The informational sections that the information overlay has depends on what is passed to its constructor by DtMapInformationOverlayInstanceCreator.

Toolkit users can make use of DtMapInformationOverlayInstanceCreator to customize which informational sections are visible in a map information overlay.

Inheritance diagram for makVrv::DtMapInformationOverlayInstance:

[legend]

Public Types
typedef std::map < DtObserverSettingsManager::ObserverSetting, DtMapInformationSectionOverlayCreator * >	DtMapInformationOverlayInstanceSectionCreators

typedef std::map < DtObserverSettingsManager::ObserverSetting, DtMapInformationSectionOverlay * >	DtMapInformationOverlayInstanceSections

Public Member Functions
virtual	~DtMapInformationOverlayInstance ()

	DtMapInformationOverlayInstance ()=delete

	DtMapInformationOverlayInstance (const DtMapInformationOverlayInstance &other)=delete

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

virtual void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)

virtual void	setModelDefinition (const std::string &modelDefinitionName)

virtual bool	isVisible ()

virtual void	destroyVisuals ()

virtual void	createVisuals ()

virtual void	createSectionVisuals (DtObserverSettingsManager::ObserverSetting setting)

virtual void	destroySectionVisuals (DtObserverSettingsManager::ObserverSetting setting)

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

virtual void	setOverlayGroup (int group)

virtual int	overlayGroup () const

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

virtual bool	getBackgroundColor (float &r, float &g, float &b, float &a) const

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

virtual bool	getFontColor (float &r, float &g, float &b, float &a) const

virtual void	setFontFile (const std::string &fontFile)

virtual std::string	fontFile () const

virtual void	setFontPointSize (int pointSize)

virtual int	fontPointSize () const

Protected Member Functions
virtual void	slot_sectionOverlayDimensionsChanged ()

virtual void	update ()

virtual void	updateGeometries ()

virtual void	synchronizeWindowAndChannelDimensions ()

virtual void	setPixelRatio (float pixelRatio)

virtual void	destroyBackground ()

virtual void	createBackground ()

	DtMapInformationOverlayInstance (DtDe &de, DtMapInformationOverlayInstanceSectionCreators creators)


virtual void	slot_channelCreated (DtChannelManager , DtChannel )

virtual void	slot_channelToBeDestroyed (DtChannelManager , DtChannel )

virtual void	slot_channelConfigurationModified (const std::string &deName, const std::string &winName, const std::string &oldChannelName, const DtChannelConfiguration &config)

virtual void	slot_windowConfigurationModified (const std::string &deName, const std::string &winName, const DtWindowConfiguration &config)

Protected Attributes
DtSignalConnectionManager	myConnections

DtSignalConnectionManager	myPixelRatioConnection

float	myPixelRatio

DtChannel *	myChannel

DtDe &	myDe

std::string	myDisplayName

std::string	myWindowName

std::string	myChannelName

DtWindowPolygon *	myBackgroundQuad

float	myBackgroundColor [4]

bool	myGeometryDirty

double	myPreviousWindowHeight

double	myPreviousWindowWidth

double	myPreviousViewportLeft

double	myPreviousViewportRight

double	myPreviousViewportTop

double	myPreviousViewportBottom

int	myMarginLeft

int	myMarginRight

int	myMarginTop

int	myMarginBottom

int	myRowSpacing

DtMapInformationOverlayInstanceSectionCreators	mySectionCreators

DtMapInformationOverlayInstanceSections	mySections

int	myOverlayGroup

std::string	myFontFile

float	myFontColor [4]

int	myFontPointSize

Friends
class	DtMapInformationOverlayInstanceCreator

Member Typedef Documentation

typedef std::map<DtObserverSettingsManager::ObserverSetting, DtMapInformationSectionOverlayCreator*> makVrv::DtMapInformationOverlayInstance::DtMapInformationOverlayInstanceSectionCreators

typedef std::map<DtObserverSettingsManager::ObserverSetting, DtMapInformationSectionOverlay*> makVrv::DtMapInformationOverlayInstance::DtMapInformationOverlayInstanceSections

Constructor & Destructor Documentation

virtual makVrv::DtMapInformationOverlayInstance::~DtMapInformationOverlayInstance ( )

virtual

DTOR.

makVrv::DtMapInformationOverlayInstance::DtMapInformationOverlayInstance ( )

delete

not allowed

makVrv::DtMapInformationOverlayInstance::DtMapInformationOverlayInstance ( const DtMapInformationOverlayInstance & other )

delete

not allowed

makVrv::DtMapInformationOverlayInstance::DtMapInformationOverlayInstance	(	DtDe &	de,
		DtMapInformationOverlayInstanceSectionCreators	creators
	)

protected

Constructor needs the DtDe to use. Protected because this is only called by the DtMapInformationOverlayInstanceCreator.

Member Function Documentation

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

delete

not allowed

virtual void makVrv::DtMapInformationOverlayInstance::setChannelName	(	const std::string &	deName,
		const std::string &	winName,
		const std::string &	channelName
	)

virtual

Set the channel the overlay will be visualized on.

virtual void makVrv::DtMapInformationOverlayInstance::setModelDefinition ( const std::string & modelDefinitionName )

virtual

Set the model definition the map information overlay will use when creating visuals. Model definitions are expected to follow the MapInformationOverlay schema. Visuals need to be destroyed and re-created before the values provided by the model definition, associated with the passed in name, will be used. If a model definition with the provided name does not exist, this function does nothing.

Reimplemented in makVrf::DtMapStatusTextInstance.

virtual bool makVrv::DtMapInformationOverlayInstance::isVisible ( )

virtual

Get whether or not the overlay is visible.

virtual void makVrv::DtMapInformationOverlayInstance::destroyVisuals ( )

virtual

Destroy any visuals created for the overlay - also destroys visuals for all of the overlay's informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::createVisuals ( )

virtual

Create any visuals needed for the overlay - also creates visuals for all of the overlay's informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::createSectionVisuals ( DtObserverSettingsManager::ObserverSetting setting )

virtual

Create the visuals for an informational section of the overlay using its observer setting enumerated values. This function does nothing if the informational section is already created.

Reimplemented in makVrf::DtMapStatusTextInstance.

virtual void makVrv::DtMapInformationOverlayInstance::destroySectionVisuals ( DtObserverSettingsManager::ObserverSetting setting )

virtual

Destroy the visuals for an informational section of the overlay using its observer setting enumerated values. This function does nothing if the informational section has not been created.

virtual void makVrv::DtMapInformationOverlayInstance::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.

virtual void makVrv::DtMapInformationOverlayInstance::setOverlayGroup ( int group )

virtual

Set the group this overlay will be drawn in The higher the group number, the "closer" to the eyepoint this overlay will be drawn. Use this function to stack overlay objects in the particular order you want them displayed.

virtual int makVrv::DtMapInformationOverlayInstance::overlayGroup ( ) const

virtual

Get the group this overlay will be drawn in The higher the group number, the "closer" to the eyepoint this overlay will be drawn. Use this function to stack overlay objects in the particular order you want them displayed.

virtual void makVrv::DtMapInformationOverlayInstance::setBackgroundColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the background color of the overlay.

virtual bool makVrv::DtMapInformationOverlayInstance::getBackgroundColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

Get the background color of the overlay.

virtual void makVrv::DtMapInformationOverlayInstance::setFontColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the font color to use for text on the overlay and all of its informational sections.

virtual bool makVrv::DtMapInformationOverlayInstance::getFontColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

Get the font color to use for text on the overlay and all of its informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::setFontFile ( const std::string & fontFile )

virtual

Set the font file to use for text on the overlay and all of its informational sections.

virtual std::string makVrv::DtMapInformationOverlayInstance::fontFile ( ) const

virtual

Get the font file to use for text on the overlay and all of its informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::setFontPointSize ( int pointSize )

virtual

Set the font point size to use for text on the overlay and all of its informational sections.

virtual int makVrv::DtMapInformationOverlayInstance::fontPointSize ( ) const

virtual

Get the font point size to use for text on the overlay and all of its informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::slot_channelCreated	(	DtChannelManager *	,
		DtChannel *
	)

protectedvirtual

Slots for responding to channel-related signals.

Slot executed when the channel manager signaler signals a channel has been created. This function checks if the created channel is the same channel this overlay is rendered on and ensures the internal channel is properly set if so.

virtual void makVrv::DtMapInformationOverlayInstance::slot_channelToBeDestroyed	(	DtChannelManager *	,
		DtChannel *
	)

protectedvirtual

Slot executed when the channel manager signaler signals a channel is going to be destroyed. This function destroys the overlay and its informational sections - cleaning up resources.

virtual void makVrv::DtMapInformationOverlayInstance::slot_channelConfigurationModified	(	const std::string &	deName,
		const std::string &	winName,
		const std::string &	oldChannelName,
		const DtChannelConfiguration &	config
	)

protectedvirtual

If the channel for this overlay has changed, ensure the overlay gets updated as its geometry may have changed.

virtual void makVrv::DtMapInformationOverlayInstance::slot_windowConfigurationModified	(	const std::string &	deName,
		const std::string &	winName,
		const DtWindowConfiguration &	config
	)

protectedvirtual

If the window for this overlay has changed, ensure the overlay gets updated as its geometry may have changed.

virtual void makVrv::DtMapInformationOverlayInstance::slot_sectionOverlayDimensionsChanged ( )

protectedvirtual

Called when an information section's geometry has changed meaning we should update the geometry of the overlay and other informational sections.

virtual void makVrv::DtMapInformationOverlayInstance::update ( )

protectedvirtual

Updates the overlay - called every frame.

virtual void makVrv::DtMapInformationOverlayInstance::updateGeometries ( )

protectedvirtual

Update the geometry of the overlay and its informational sections. This function does nothing if myGeometryDirty is false.

Reimplemented in makVrf::DtMapStatusTextInstance.

virtual void makVrv::DtMapInformationOverlayInstance::synchronizeWindowAndChannelDimensions ( )

protectedvirtual

Check if window/channel dimensions have changed and ensure the geometry of the overlay gets updated if it has.

virtual void makVrv::DtMapInformationOverlayInstance::setPixelRatio ( float pixelRatio )

protectedvirtual

Sets the pixel density ratio to scale the overlay on high dpi screens.

virtual void makVrv::DtMapInformationOverlayInstance::destroyBackground ( )

protectedvirtual

Destroy the background visual created for the overlay. This function does nothing if the background has not been visualized.

virtual void makVrv::DtMapInformationOverlayInstance::createBackground ( )

protectedvirtual

Create the background visual created for the overlay. This function does nothing if the background has already been visualized.

Friends And Related Function Documentation

friend class DtMapInformationOverlayInstanceCreator

friend

Member Data Documentation

DtSignalConnectionManager makVrv::DtMapInformationOverlayInstance::myConnections

protected

DtSignalConnectionManager makVrv::DtMapInformationOverlayInstance::myPixelRatioConnection

protected

float makVrv::DtMapInformationOverlayInstance::myPixelRatio

protected

DtChannel* makVrv::DtMapInformationOverlayInstance::myChannel

protected

DtDe& makVrv::DtMapInformationOverlayInstance::myDe

protected

std::string makVrv::DtMapInformationOverlayInstance::myDisplayName

protected

std::string makVrv::DtMapInformationOverlayInstance::myWindowName

protected

std::string makVrv::DtMapInformationOverlayInstance::myChannelName

protected

DtWindowPolygon* makVrv::DtMapInformationOverlayInstance::myBackgroundQuad

protected

float makVrv::DtMapInformationOverlayInstance::myBackgroundColor[4]

protected

bool makVrv::DtMapInformationOverlayInstance::myGeometryDirty

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousWindowHeight

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousWindowWidth

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousViewportLeft

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousViewportRight

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousViewportTop

protected

double makVrv::DtMapInformationOverlayInstance::myPreviousViewportBottom

protected

int makVrv::DtMapInformationOverlayInstance::myMarginLeft

protected

margin in pixels

int makVrv::DtMapInformationOverlayInstance::myMarginRight

protected

int makVrv::DtMapInformationOverlayInstance::myMarginTop

protected

int makVrv::DtMapInformationOverlayInstance::myMarginBottom

protected

int makVrv::DtMapInformationOverlayInstance::myRowSpacing

protected

space between rows in pixels

DtMapInformationOverlayInstanceSectionCreators makVrv::DtMapInformationOverlayInstance::mySectionCreators

protected

The list of overlay section creators to be used when creating a new sensor view overlay.

DtMapInformationOverlayInstanceSections makVrv::DtMapInformationOverlayInstance::mySections

protected

int makVrv::DtMapInformationOverlayInstance::myOverlayGroup

protected

std::string makVrv::DtMapInformationOverlayInstance::myFontFile

protected

float makVrv::DtMapInformationOverlayInstance::myFontColor[4]

protected

int makVrv::DtMapInformationOverlayInstance::myFontPointSize

protected

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation