makVrv::DtChannelGridLinesInstance Class Reference

Interface for a DtChannelGridLinesInstance An object that draws a 2D compass.

Inheritance diagram for makVrv::DtChannelGridLinesInstance:

Public Member Functions
	DtChannelGridLinesInstance ()
virtual	~DtChannelGridLinesInstance ()
virtual void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)
virtual void	setModelDefinition (const std::string &modelDefinition)
virtual void	setVisible (bool isVisible)
virtual bool	visible ()
virtual void	updateGridLines ()=0
Public Member Functions inherited from makVrv::DtSetVisibilityInterface
virtual	~DtSetVisibilityInterface ()
Public Member Functions inherited from makVrv::DtGridLinesParameters
	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
std::string	myModelDefinitionName
std::string	myDisplayEngineName
std::string	myWindowName
std::string	myChannelName
bool	myVisibleFlag
Protected Attributes inherited from makVrv::DtGridLinesParameters
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::DtChannelGridLinesInstance::DtChannelGridLinesInstance

(

)

Default CTOR.

virtual makVrv::DtChannelGridLinesInstance::~DtChannelGridLinesInstance ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

Set the name of the channel that this compass should be drawn on.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual void makVrv::DtChannelGridLinesInstance::setModelDefinition ( const std::string &  modelDefinition )

virtual

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

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

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

virtual

Set the grid lines to visible or invisible.

Implements makVrv::DtSetVisibilityInterface.

Reimplemented in makVrv::DtOsgChannelGridLinesInstance.

virtual bool makVrv::DtChannelGridLinesInstance::visible ( )

virtual

Return visibility status.

virtual void makVrv::DtChannelGridLinesInstance::updateGridLines ( )

pure virtual

Called anytime any of the grid line parameters change, and when the observer heading changes.

Implemented in makVrv::DtOsgChannelGridLinesInstance.

Member Data Documentation

std::string makVrv::DtChannelGridLinesInstance::myModelDefinitionName

protected

std::string makVrv::DtChannelGridLinesInstance::myDisplayEngineName

protected

std::string makVrv::DtChannelGridLinesInstance::myWindowName

protected

std::string makVrv::DtChannelGridLinesInstance::myChannelName

protected

bool makVrv::DtChannelGridLinesInstance::myVisibleFlag

protected

---

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

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