A model-like object that draws grid lines on a channel.

Inheritance diagram for makVrv::DtChannelGridLines:

Public Member Functions
	DtChannelGridLines (DtDe &de, DtUniqueID id)

virtual	~DtChannelGridLines ()

virtual void	setInstance (DtChannelGridLinesInstance *instance)

virtual DtChannelGridLinesInstance *	instance ()

virtual void	setVisible (bool isVisible)

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

void	setModelDefinition (const std::string &modelDefinition)

void	setGridType (unsigned gridType)

void	setUnitType (unsigned unitType, bool isAngular)

void	setMinimalGridlineLabelsEnabled (bool enabled)

void	setAutoSpacing (bool autoSpacing)

void	setFixedSpacingAmount (double amount)

void	setGarsFixedSpacing (double degs)

void	setMgrsMapSheetFixedSpacing (double meters)

void	setMinSpacing (int pixels)

void	setXOffset (double offset)

void	setYOffset (double offset)

void	setDecimalPlaces (unsigned decimalPlaces)

virtual void	setMaxGridLines (int maxGridLines)

virtual void	setMaxGridLineSegments (int maxGridLineSegments)

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

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

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

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

virtual void	setLabelFont (const std::string &fontName)

virtual void	setLabelPointSize (int pointSize)

virtual void	setLabelXOffset (int pixels)

virtual void	setLabelYOffset (int pixels)

virtual void	setLabelTextWidth (int width)

virtual void	setLabelTextHeight (int height)

virtual void	setGridLineWidth (float width)

virtual void	setLatLonLabelsCenteringCutoff (int altitude)

virtual void	setMgrsMapSheetCutoff (double alt)

virtual void	setGarsPolarLatitudeCutoff (double latitude)

Protected Attributes
DtChannelGridLinesInstance *	myInstance

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtChannelGridLines::~DtChannelGridLines ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtChannelGridLines::setInstance ( DtChannelGridLinesInstance * instance )

virtual

Set or replace the gridLines instance for the gridLines Transfers ownership.

virtual DtChannelGridLinesInstance* makVrv::DtChannelGridLines::instance ( )

virtual

Get the gridLines instance for the gridLines.

virtual void makVrv::DtChannelGridLines::setVisible ( bool isVisible )

virtual

Set the gridLines' visibility.

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

Set the name of the channel that these gridLines should be drawn on.

void makVrv::DtChannelGridLines::setModelDefinition ( const std::string & modelDefinition )

Set the model definition; note that this (potentially) includes all the other parameters enumeration below.

void makVrv::DtChannelGridLines::setGridType ( unsigned gridType )

Set the grid type.

void makVrv::DtChannelGridLines::setUnitType	(	unsigned	unitType,
		bool	isAngular
	)

Set the unit type.

void makVrv::DtChannelGridLines::setMinimalGridlineLabelsEnabled ( bool enabled )

Set whether or not minimal gridline labels are used.

void makVrv::DtChannelGridLines::setAutoSpacing ( bool autoSpacing )

Set whether auto spacing is used.

void makVrv::DtChannelGridLines::setFixedSpacingAmount ( double amount )

Set the fixed spacing amount.

void makVrv::DtChannelGridLines::setGarsFixedSpacing ( double degs )

Because GARS spacings are always 5, 15, or 30 minutes, we do not share fixed spacing values with other degree-based gridline types.

void makVrv::DtChannelGridLines::setMgrsMapSheetFixedSpacing ( double meters )

Because MGRS spacings are always 10 to the nth power (up to 100K) meters, we do not share fixed spacing values with other meters-based gridline types.

void makVrv::DtChannelGridLines::setMinSpacing ( int pixels )

Set the minimum pixel spacing for auto spacing.

void makVrv::DtChannelGridLines::setXOffset ( double offset )

Set the x offset for the origin.

void makVrv::DtChannelGridLines::setYOffset ( double offset )

Set the y offset for the origin.

void makVrv::DtChannelGridLines::setDecimalPlaces ( unsigned decimalPlaces )

Set the decimalPlaces to use.

virtual void makVrv::DtChannelGridLines::setMaxGridLines ( int maxGridLines )

virtual

The remaining parameters are normally set through the model definition If you call any of these functions BEFORE the model definition is set, and that parameter is in the model definition, it will override the value set by the mutator.

Set the max number of grid lines in each direction

virtual void makVrv::DtChannelGridLines::setMaxGridLineSegments ( int maxGridLineSegments )

virtual

Set the max number of grid line segments in each 'curved' line.

virtual void makVrv::DtChannelGridLines::setEastWestGridLineColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the color of east-west grid lines.

virtual void makVrv::DtChannelGridLines::setEastWestLabelColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the color of the labels on east-west grid lines.

virtual void makVrv::DtChannelGridLines::setNorthSouthGridLineColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the color of north-south grid lines.

virtual void makVrv::DtChannelGridLines::setNorthSouthLabelColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the color of the labels north-south grid lines.

virtual void makVrv::DtChannelGridLines::setLabelFont ( const std::string & fontName )

virtual

Set the font used for labels.

virtual void makVrv::DtChannelGridLines::setLabelPointSize ( int pointSize )

virtual

Set the point size used for labels.

virtual void makVrv::DtChannelGridLines::setLabelXOffset ( int pixels )

virtual

Set the offset of labels from the bottom of the screen.

virtual void makVrv::DtChannelGridLines::setLabelYOffset ( int pixels )

virtual

Set the offset of labels from the left side of the screen.

virtual void makVrv::DtChannelGridLines::setLabelTextWidth ( int width )

virtual

Set the width of the box used to display text in.

virtual void makVrv::DtChannelGridLines::setLabelTextHeight ( int height )

virtual

Set the height of the box used to display text in.

virtual void makVrv::DtChannelGridLines::setGridLineWidth ( float width )

virtual

Set the width of grid lines.

virtual void makVrv::DtChannelGridLines::setLatLonLabelsCenteringCutoff ( int altitude )

virtual

Set the latitude at which we stop moving longitude labels to the center of the screen.

virtual void makVrv::DtChannelGridLines::setMgrsMapSheetCutoff ( double alt )

virtual

Set the altitude in meters at which we stop drawing map sheet lines/labels when using fixed spacing.

virtual void makVrv::DtChannelGridLines::setGarsPolarLatitudeCutoff ( double latitude )

virtual

Set the latitude above which GARS grid lines are not drawn.

Member Data Documentation

DtChannelGridLinesInstance* makVrv::DtChannelGridLines::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/DtChannelGridLines.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation