makVrv::DtGridLinesParameters Class Reference

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

Inheritance diagram for makVrv::DtGridLinesParameters:

Public Member Functions
	DtGridLinesParameters ()
	CTOR.
virtual	~DtGridLinesParameters ()
	DTOR.
	DtGridLinesParameters (const DtGridLinesParameters &orig)
	Copy constructor.
DtGridLinesParameters &	operator= (const DtGridLinesParameters &orig)
	\ brief Assignment operator
virtual void	setGridType (makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType)
	Set the grid type.
virtual void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unitType)
	Set the unit type.
virtual void	setUnitType (makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unitType)
	Set the unit type.
virtual void	setAutoSpacing (bool autoSpacing)
	Set whether auto spacing is used.
virtual void	setMinSpacing (int pixels)
	Set the minimum pixel spacing for auto spacing.
virtual void	setFixedSpacingAmount (double amount)
	Set the fixed spacing amount.
virtual void	setXOffset (double offset)
	Set the x offset for the origin in current units.
virtual void	setYOffset (double offset)
	Set the y offset amount in current units.
virtual void	setDecimalPlaces (unsigned decimalPlaces)
	Set the number of decimals or, in the case of MGRS, decimalPlaces.
virtual void	setMaxGridLines (int maxGridLines)
	Set the max number of grid lines in each direction.
virtual void	setEastWestGridLineColor (float r, float g, float b, float a)
	Set the color of east-west grid lines.
virtual void	setEastWestLabelColor (float r, float g, float b, float a)
	Set the color of the labels on east-west grid lines.
virtual void	setNorthSouthGridLineColor (float r, float g, float b, float a)
	Set the color of north-south grid lines.
virtual void	setNorthSouthLabelColor (float r, float g, float b, float a)
	Set the color of the labels north-south grid lines.
virtual void	setLabelFont (const std::string &fontName)
	Set the font used for labels.
virtual void	setLabelPointSize (int pointSize)
	Set the point size used for labels.
virtual void	setLabelXOffset (int pixels)
	Set the offset of labels from the bottom of the screen.
virtual void	setLabelYOffset (int pixels)
	Set the offset of labels from the left side of the screen.
virtual void	setLabelTextWidth (int width)
	Set the width of the box used to display text in.
virtual void	setLabelTextHeight (int height)
	Set the height of the box used to display text in.
virtual void	setGridLineWidth (float width)
	Set the width of grid lines.

Protected Attributes
makArchives::DtDisplayUnitsSettingsRecord::CoordSys	myGridType
bool	myUnitTypeIsAngular
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits	myUnitType
makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits	myAngularUnitType
bool	myAutoSpacing
int	myMinSpacing
double	mySpacing
double	myXOffset
double	myYOffset
unsigned	myDecimalPlaces
int	myMaxGridLines
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

Detailed Description

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

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::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::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::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.

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::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

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtGridLinesParameters.h