Interface for DtGridLinesParameters, a container class for holding all the dialog and model definition-settable parameters of grid lines.

Inheritance diagram for makVrv::DtGridLinesParameters:

[legend]

Public Member Functions
	DtGridLinesParameters ()

virtual	~DtGridLinesParameters ()

	DtGridLinesParameters (const DtGridLinesParameters &orig)

DtGridLinesParameters &	operator= (const DtGridLinesParameters &orig)

virtual void	setGridType (makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType)

virtual void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unitType)

virtual void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unitType)

virtual void	setMinimalGridlineLabelsEnabled (bool enabled)

virtual void	setAutoSpacing (bool autoSpacing)

virtual void	setMinSpacing (int pixels)

virtual void	setFixedSpacingAmount (double amount)

virtual void	setGarsFixedSpacing (double degs)

virtual void	setMgrsMapSheetFixedSpacing (double meters)

virtual void	setXOffset (double offset)

virtual void	setYOffset (double offset)

virtual 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 altitude)

virtual void	setGarsPolarLatitudeCutoff (double latitude)

Protected Attributes
makArchives::DtDisplayUnitsSettingsRecord::CoordSys	myGridType

bool	myUnitTypeIsAngular

makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits	myUnitType

makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits	myAngularUnitType

bool	myMinimalGridlineLabelsEnabled

bool	myAutoSpacing

int	myMinSpacing

double	mySpacing

double	myXOffset

double	myYOffset

unsigned	myDecimalPlaces

int	myMaxGridLines

int	myMaxGridLineSegments

float	myEastWestGridLineColor [4]

float	myEastWestLabelColor [4]

float	myNorthSouthGridLineColor [4]

float	myNorthSouthLabelColor [4]

std::string	myLabelFont

int	myLabelPointSize

int	myLabelXOffset

int	myLabelYOffset

int	myLabelTextWidth

int	myLabelTextHeight

float	myGridLineWidth

int	myLatLonLabelsCenteringCutoff

double	myMgrsMapSheetCutoff

double	myGarsFixedSpacing

double	myMgrsMapSheetFixedSpacing

double	myGarsPolarLatitudeCutoff

Constructor & Destructor Documentation

makVrv::DtGridLinesParameters::DtGridLinesParameters ( )

CTOR.

virtual makVrv::DtGridLinesParameters::~DtGridLinesParameters ( )

virtual

DTOR.

makVrv::DtGridLinesParameters::DtGridLinesParameters ( const DtGridLinesParameters & orig )

Copy constructor.

Member Function Documentation

DtGridLinesParameters& makVrv::DtGridLinesParameters::operator= ( const DtGridLinesParameters & orig )

\ brief Assignment operator

virtual void makVrv::DtGridLinesParameters::setGridType ( makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType )

virtual

Set the grid type.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setUnitType ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unitType )

virtual

Set the unit type.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setUnitType ( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unitType )

virtual

Set the unit type.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setMinimalGridlineLabelsEnabled ( bool enabled )

virtual

Set whether or not minimal gridline labels are used.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setAutoSpacing ( bool autoSpacing )

virtual

Set whether auto spacing is used.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setMinSpacing ( int pixels )

virtual

Set the minimum pixel spacing for auto spacing.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setFixedSpacingAmount ( double amount )

virtual

Set the fixed spacing amount.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setGarsFixedSpacing ( double degs )

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setMgrsMapSheetFixedSpacing ( double meters )

virtual

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.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setXOffset ( double offset )

virtual

Set the x offset for the origin in current units.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setYOffset ( double offset )

virtual

Set the y offset amount in current units.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setDecimalPlaces ( unsigned decimalPlaces )

virtual

Set the number of decimals or, in the case of MGRS, decimalPlaces.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the max number of grid lines in each direction.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance, and makVrv::DtProjectedGridLinesDrawer.

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

virtual

Set the max number of segments used to create a 'curved' grid line.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the color of east-west grid lines.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the color of north-south grid lines.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the font used for labels.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the point size used for labels.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the width of grid lines.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtGridLinesParameters::setMgrsMapSheetCutoff ( double altitude )

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance, and makVrv::DtGeocentricGridLinesDrawer.

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

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance, and makVrv::DtGeocentricGridLinesDrawer.

Member Data Documentation

makArchives::DtDisplayUnitsSettingsRecord::CoordSys makVrv::DtGridLinesParameters::myGridType

protected

bool makVrv::DtGridLinesParameters::myUnitTypeIsAngular

protected

makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtGridLinesParameters::myUnitType

protected

makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits makVrv::DtGridLinesParameters::myAngularUnitType

protected

bool makVrv::DtGridLinesParameters::myMinimalGridlineLabelsEnabled

protected

bool makVrv::DtGridLinesParameters::myAutoSpacing

protected

int makVrv::DtGridLinesParameters::myMinSpacing

protected

double makVrv::DtGridLinesParameters::mySpacing

protected

double makVrv::DtGridLinesParameters::myXOffset

protected

double makVrv::DtGridLinesParameters::myYOffset

protected

unsigned makVrv::DtGridLinesParameters::myDecimalPlaces

protected

int makVrv::DtGridLinesParameters::myMaxGridLines

protected

int makVrv::DtGridLinesParameters::myMaxGridLineSegments

protected

float makVrv::DtGridLinesParameters::myEastWestGridLineColor[4]

protected

float makVrv::DtGridLinesParameters::myEastWestLabelColor[4]

protected

float makVrv::DtGridLinesParameters::myNorthSouthGridLineColor[4]

protected

float makVrv::DtGridLinesParameters::myNorthSouthLabelColor[4]

protected

std::string makVrv::DtGridLinesParameters::myLabelFont

protected

int makVrv::DtGridLinesParameters::myLabelPointSize

protected

int makVrv::DtGridLinesParameters::myLabelXOffset

protected

int makVrv::DtGridLinesParameters::myLabelYOffset

protected

int makVrv::DtGridLinesParameters::myLabelTextWidth

protected

int makVrv::DtGridLinesParameters::myLabelTextHeight

protected

float makVrv::DtGridLinesParameters::myGridLineWidth

protected

int makVrv::DtGridLinesParameters::myLatLonLabelsCenteringCutoff

protected

double makVrv::DtGridLinesParameters::myMgrsMapSheetCutoff

protected

double makVrv::DtGridLinesParameters::myGarsFixedSpacing

protected

double makVrv::DtGridLinesParameters::myMgrsMapSheetFixedSpacing

protected

double makVrv::DtGridLinesParameters::myGarsPolarLatitudeCutoff

protected

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

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

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation