DtMapInformationSectionOverlay is an abstract base class that contains functionality common to all informational sections in the map information overlay, DtMapInformationOverlay. The map information overlay is responsible for creating/destroying the sections, when their observer visual type settings change, and calling their update functions every frame.

Inheritance diagram for makVrv::DtMapInformationSectionOverlay:

[legend]

Public Member Functions
virtual	~DtMapInformationSectionOverlay ()

virtual void	setChannelOverlay (const std::string &displayName, const std::string &windowName, const std::string &channelName)

virtual void	setChannel (DtChannel *channel)

virtual void	setGroup (unsigned int group)

virtual void	setPixelRatio (float pixelRatio)

virtual void	createVisuals ()

virtual void	destroyVisuals ()

virtual bool	isVisualized () const =0

virtual void	update ()

virtual bool	getSize (int &width, int &height)=0

virtual void	setGeometry (double left, double bottom, double width, double height)

virtual void	setFont (const std::string &fontFile, float sizeInPoints)

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

virtual void	setAreBoundsVisualized (bool areBoundsVisualized)

virtual bool	areBoundsVisualized () const

Public Attributes
boost::signalslib::signal< void()>	signal_sectionOverlayDimensionsChanged

Protected Member Functions
	DtMapInformationSectionOverlay (DtDe &de)

virtual bool	getChannelDimensionsInPixels (int &widthPixels, int &heightPixels) const

virtual bool	getParentOverlayCenter (double &normalizedX, double &normalizedY) const

Protected Attributes
DtDe &	myDe

std::string	myDisplayName

std::string	myWindowName

std::string	myChannelName

DtChannel *	myChannel

bool	myVisualizeBoundsEnabled

DtWindowPolygon *	myBoundsQuad

DtSignalConnectionManager	myPixelRatioConnection

float	myPixelRatio

unsigned int	myGroup

double	myLeft

double	myBottom

double	myRight

double	myTop

std::string	myFontFile

float	myFontColor [4]

int	myFontPointSize

Friends
class	DtMapInformationSectionOverlayCreator

Constructor & Destructor Documentation

virtual makVrv::DtMapInformationSectionOverlay::~DtMapInformationSectionOverlay ( )

virtual

DTOR.

makVrv::DtMapInformationSectionOverlay::DtMapInformationSectionOverlay ( DtDe & de )

protected

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

Member Function Documentation

virtual void makVrv::DtMapInformationSectionOverlay::setChannelOverlay	(	const std::string &	displayName,
		const std::string &	windowName,
		const std::string &	channelName
	)

virtual

Set the channel this section overlay will be rendered on. This function can override setChannel. Do not use if the provided channel is not fully realized yet - use setChannel(DtChannel*) instead.

virtual void makVrv::DtMapInformationSectionOverlay::setChannel ( DtChannel * channel )

virtual

Set the channel this section overlay will be rendered on. This function can override setChannelOverlay and is useful if a channel isn't fully realized yet.

virtual void makVrv::DtMapInformationSectionOverlay::setGroup ( unsigned int group )

virtual

Set the group this section overlay will be rendered in. The higher the group number the "closer" the element will be drawn to the eye point.

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

virtual

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

Reimplemented in makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::createVisuals ( )

virtual

Create the visuals for this section overlay. This class's function implementation only does something if setAreBoundsVisualized.

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::destroyVisuals ( )

virtual

Destroy the visuals for this section overlay. This class's function implementation only does something if setAreBoundsVisualized.

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual bool makVrv::DtMapInformationSectionOverlay::isVisualized ( ) const

pure virtual

Return whether or not the section overlay has been visualized.

Implemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::update ( )

virtual

Updates the section overlay - called every frame.

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual bool makVrv::DtMapInformationSectionOverlay::getSize	(	int &	width,
		int &	height
	)

pure virtual

Get the size needed for this section overlay.

Implemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::setGeometry	(	double	left,
		double	bottom,
		double	width,
		double	height
	)

virtual

Set the geometry of this section overlay in normalized screen space [0-1].

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::setFont	(	const std::string &	fontFile,
		float	sizeInPoints
	)

virtual

Set the font file and size in points to display the text in.

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

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

virtual

Set the font color to display the text in.

Reimplemented in makVrv::DtMapMouseCursorPositionFromBullseyeSectionOverlay, makVrv::DtMapMouseCursorToWorldPositionSectionOverlay, and makVrv::DtMapScaleSectionOverlay.

virtual void makVrv::DtMapInformationSectionOverlay::setAreBoundsVisualized ( bool areBoundsVisualized )

virtual

Set whether or not bounds for this informational section overlay are visualized or not. This is a useful debugging capability.

virtual bool makVrv::DtMapInformationSectionOverlay::areBoundsVisualized ( ) const

virtual

Get whether or not bounds for this informational section overlay are visualized or not. This is a useful debugging capability.

virtual bool makVrv::DtMapInformationSectionOverlay::getChannelDimensionsInPixels	(	int &	widthPixels,
		int &	heightPixels
	)		const

protectedvirtual

Get the dimensions of the channel of this section overlay in pixels Helper function that can be used by sub-classes.

virtual bool makVrv::DtMapInformationSectionOverlay::getParentOverlayCenter	(	double &	normalizedX,
		double &	normalizedY
	)		const

protectedvirtual

Get the center for the parent overlay of this section overlay in normalized screen space [0-1].

Friends And Related Function Documentation

friend class DtMapInformationSectionOverlayCreator

friend

Member Data Documentation

boost::signalslib::signal<void()> makVrv::DtMapInformationSectionOverlay::signal_sectionOverlayDimensionsChanged

parent map overlay should resize and update other section overlays accordingly

DtDe& makVrv::DtMapInformationSectionOverlay::myDe

protected

std::string makVrv::DtMapInformationSectionOverlay::myDisplayName

protected

std::string makVrv::DtMapInformationSectionOverlay::myWindowName

protected

std::string makVrv::DtMapInformationSectionOverlay::myChannelName

protected

DtChannel* makVrv::DtMapInformationSectionOverlay::myChannel

protected

bool makVrv::DtMapInformationSectionOverlay::myVisualizeBoundsEnabled

protected

DtWindowPolygon* makVrv::DtMapInformationSectionOverlay::myBoundsQuad

protected

DtSignalConnectionManager makVrv::DtMapInformationSectionOverlay::myPixelRatioConnection

protected

float makVrv::DtMapInformationSectionOverlay::myPixelRatio

protected

unsigned int makVrv::DtMapInformationSectionOverlay::myGroup

protected

double makVrv::DtMapInformationSectionOverlay::myLeft

protected

double makVrv::DtMapInformationSectionOverlay::myBottom

protected

double makVrv::DtMapInformationSectionOverlay::myRight

protected

double makVrv::DtMapInformationSectionOverlay::myTop

protected

std::string makVrv::DtMapInformationSectionOverlay::myFontFile

protected

float makVrv::DtMapInformationSectionOverlay::myFontColor[4]

protected

int makVrv::DtMapInformationSectionOverlay::myFontPointSize

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtMapInformationSectionOverlay.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation