This class defines an informational section that can be added to the map information overlay which displays a map scale based on the current observer's position for the channel the map information overlay is on.

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.

See Also: DtMapInformationOverlay

Inheritance diagram for makVrv::DtMapScaleSectionOverlay:

[legend]

Public Member Functions
virtual	~DtMapScaleSectionOverlay ()

	DtMapScaleSectionOverlay ()=delete

	DtMapScaleSectionOverlay (const DtMapScaleSectionOverlay &other)=delete

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

virtual void	createVisuals ()

virtual void	destroyVisuals ()

virtual bool	isVisualized () const

virtual void	update () override

virtual bool	getSize (int &width, int &height) override

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

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

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

virtual void	setPixelRatio (float pixelRatio)

Public Member Functions inherited from makVrv::DtMapInformationSectionOverlay
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	setAreBoundsVisualized (bool areBoundsVisualized)

virtual bool	areBoundsVisualized () const

Protected Member Functions
virtual double	findDistanceFromResolution (double viewResolution, DtUnicode &label) const

	DtMapScaleSectionOverlay (DtDe &de)

Protected Member Functions inherited from makVrv::DtMapInformationSectionOverlay
	DtMapInformationSectionOverlay (DtDe &de)

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

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

Protected Attributes
DtWindowText *	myScaleText

DtWindowLine *	myHorizontalLine

int	myLineWidth

bool	myNeedsUpdate

double	myPreviousViewResolution

int	myLabelTextHeight

int	myLabelTextWidth

int	myActualScaleWidth

int	myTargetScaleWidth

int	myLabelScaleBarSpacing

int	myLeftAndRightMarginSpacing

Protected Attributes inherited from makVrv::DtMapInformationSectionOverlay
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	DtMapScaleSectionOverlayCreator

Additional Inherited Members
Public Attributes inherited from makVrv::DtMapInformationSectionOverlay
boost::signalslib::signal< void()>	signal_sectionOverlayDimensionsChanged

Constructor & Destructor Documentation

virtual makVrv::DtMapScaleSectionOverlay::~DtMapScaleSectionOverlay ( )

virtual

DTOR.

makVrv::DtMapScaleSectionOverlay::DtMapScaleSectionOverlay ( )

delete

not allowed

makVrv::DtMapScaleSectionOverlay::DtMapScaleSectionOverlay ( const DtMapScaleSectionOverlay & other )

delete

not allowed

makVrv::DtMapScaleSectionOverlay::DtMapScaleSectionOverlay ( DtDe & de )

protected

CTOR Protected so that instances of this class can only be created using a DtMapInformationSectionOverlayCreator.

Member Function Documentation

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

delete

not allowed

virtual void makVrv::DtMapScaleSectionOverlay::createVisuals ( )

virtual

Create the visuals for this section overlay.

Reimplemented from makVrv::DtMapInformationSectionOverlay.

virtual void makVrv::DtMapScaleSectionOverlay::destroyVisuals ( )

virtual

Destroy the visuals for this section overlay.

Reimplemented from makVrv::DtMapInformationSectionOverlay.

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

virtual

Return whether or not the section overlay has been visualized.

Implements makVrv::DtMapInformationSectionOverlay.

virtual void makVrv::DtMapScaleSectionOverlay::update ( )

overridevirtual

Updates the section overlay - called every frame.

Reimplemented from makVrv::DtMapInformationSectionOverlay.

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

overridevirtual

Get the size needed for this section overlay.

Implements makVrv::DtMapInformationSectionOverlay.

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

overridevirtual

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

Reimplemented from makVrv::DtMapInformationSectionOverlay.

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

overridevirtual

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

Reimplemented from makVrv::DtMapInformationSectionOverlay.

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

overridevirtual

Set the font color to display the text in.

Reimplemented from makVrv::DtMapInformationSectionOverlay.

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

virtual

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

Reimplemented from makVrv::DtMapInformationSectionOverlay.

virtual double makVrv::DtMapScaleSectionOverlay::findDistanceFromResolution	(	double	viewResolution,
		DtUnicode &	label
	)		const

protectedvirtual

Given a view resolution (meters/pixel) get a distance that will be used to display on the screen.

Friends And Related Function Documentation

friend class DtMapScaleSectionOverlayCreator

friend

Member Data Documentation

DtWindowText* makVrv::DtMapScaleSectionOverlay::myScaleText

protected

DtWindowLine* makVrv::DtMapScaleSectionOverlay::myHorizontalLine

protected

int makVrv::DtMapScaleSectionOverlay::myLineWidth

protected

bool makVrv::DtMapScaleSectionOverlay::myNeedsUpdate

protected

double makVrv::DtMapScaleSectionOverlay::myPreviousViewResolution

protected

int makVrv::DtMapScaleSectionOverlay::myLabelTextHeight

protected

int makVrv::DtMapScaleSectionOverlay::myLabelTextWidth

protected

int makVrv::DtMapScaleSectionOverlay::myActualScaleWidth

protected

int makVrv::DtMapScaleSectionOverlay::myTargetScaleWidth

protected

int makVrv::DtMapScaleSectionOverlay::myLabelScaleBarSpacing

protected

int makVrv::DtMapScaleSectionOverlay::myLeftAndRightMarginSpacing

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation