makVrv::DtChannelGridLinesInstance Class Reference

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

Inheritance diagram for makVrv::DtChannelGridLinesInstance:

Public Member Functions
	DtChannelGridLinesInstance ()
	Default CTOR.
virtual	~DtChannelGridLinesInstance ()
	Virtual DTOR.
virtual void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)
	Set the name of the channel that this compass should be drawn on.
virtual void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition; note that this (potentially) includes all the other parameters enumeration below.
virtual void	setVisible (bool isVisible)
	Set the grid lines to visible or invisible.
virtual bool	visible ()
	Return visibility status.
virtual void	updateGridLines ()=0
	Called anytime any of the grid line parameters change, and when the observer heading changes.
Public Member Functions inherited from makVrv::DtSetVisibilityInterface
virtual	~DtSetVisibilityInterface ()
Public Member Functions inherited from makVrv::DtGridLinesParameters
	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
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	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 a DtChannelGridLinesInstance An object that draws a 2D compass.

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:

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