VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions
makVrv::DtGeocentricCoordinateDisplay Class Reference

The geocentric coordinate display information for the GUI. More...

Inheritance diagram for makVrv::DtGeocentricCoordinateDisplay:
Inheritance graph
[legend]

Public Member Functions

 DtGeocentricCoordinateDisplay (const DtCoordinateSystem &cs)
virtual ~DtGeocentricCoordinateDisplay ()
DtCoordinateDisplayclone () const
 Virtual clone function.
virtual DtUnicode name ()
virtual
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits 
xUnitsFor (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit)
virtual
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits 
yUnitsFor (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit)
virtual
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits 
zUnitsFor (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit)
virtual DtUnicode xAxisLabel ()
virtual DtUnicode yAxisLabel ()
virtual DtUnicode zAxisLabel ()
virtual DtUnicode northSouthGridLabel (DistanceUnits unit, const DtVector &geocPos, int decimals, double gridSpacing)
 Get the label for a north/south grid line at geocPos.
virtual DtUnicode eastWestGridLabel (DistanceUnits unit, const DtVector &geocPos, int decimals, double gridSpacing)
 Get the label for an east/west grid line at geocPos.
virtual std::vector< std::string > convertPositionToStringList (makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, const DtVector &geocPos, int decimals)
 Convert the geocentric position to formatted strings.
virtual void convertToGeocentric (const std::string &x, const std::string &y, const std::string &z, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits distUnits, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits altUnits, DtVector &vector)
 Converts the given coordinates (in string rep) from the base units to geocentric.
virtual DtVector convertFromGeocentric (const DtVector &geoc) const
 Converts the given coordinates from geocentric to local.
virtual DtTaitBryan headingPitchRollFor (const DtVector &location, const DtTaitBryan &geocOri) const
 Return orientation in radians.
virtual DtTaitBryan localOrientationFor (const DtVector &location, const DtTaitBryan &geocOri) const
 Return local orientation given geocentric orientation.
virtual DtVector geocToLocalVector (const DtVector &geocLoc, const DtVector &geocVec) const
virtual void regularExpressionValidator (std::string &x, std::string &y, std::string &z)
 Returns a the regexes for validating the XYZ values for this coord sys.
- Public Member Functions inherited from makVrv::DtCoordinateDisplay
 DtCoordinateDisplay (const DtCoordinateSystem &coordSys)
 CTOR DtUnitConverterCollection is a collection of classes used to convert between different units (meters, feet, miles, etc.) DtCoordinateSystem is used to do coordinate system conversions, when possible.
virtual ~DtCoordinateDisplay ()
 DTOR.
virtual DtUnicode gridBoxLabel (const DtVector &lowerLeftGeocPos, const DtVector &upperRightGeocPos)
 Some systems (such as MGRS) are not just positions but boxes with grid designators.
virtual DtUnicode northSouthGridLabel (OrientationUnits unit, const DtVector &geocPos, int decimals, double gridSpacing)
 Get a north / south label with angular units.
virtual DtUnicode eastWestGridLabel (OrientationUnits unit, const DtVector &geocPos, int decimals, double gridSpacing)
 Get an east / west label with angular units.
virtual bool clipXToGrid (double inStartX, double inEndX, double constantY, double &clippedStartX, double &clippedEndX)
 Clip a line segment in LOCAL coordinates to an existing grid defined by this coord system, if any.
virtual bool clipYToGrid (double inStartY, double inEndY, double constantX, double &clippedStartY, double &clippedEndY)
 Returns false if entire segment is outside grid.
virtual void shiftGridLineAnchors (double xSpacing, double ySpacing, double &shiftX, double &shifY)
 Normally, grid lines are started at database 0,0.
virtual bool usesDecimalsOnGridLines () const
 Enable/disable the decimals spinbox on grid settings dialog.
virtual double maxGridSpacing () const
 Maximum grid spacing allowed. 0. returned if unlimited.
virtual double minGridSpacing () const
 Minimum grid spacing allowed. 0. returned if unlimited.
virtual DtTaitBryan topoOrientationFor (const DtVector &geocPos, const DtTaitBryan &geocOri) const
const
SupportedPositionDistanceUnits
supportedPositionDistanceUnits () const
 Retrieve the the list of DistanceUnits supported by this cs display for displaying positions (coordnates).Different coordinate displays can support different distance units for position display (or, in some cases, none).
bool isSupportedPositionUnit (DistanceUnits unit) const
 Determine if the specified distance unit is supported.
void addSupportedPositionUnit (DistanceUnits unitToSupport)
 Add support for a new distance unit type.
void removeSupportedPositionUnit (DistanceUnits unitToRemove)
 Remove support for a distance unit type.
const
SupportedPositionAngularUnits
supportedPositionAngularUnits () const
 Retrieve the the list of OrientationUnits supported by this cs display.
bool isSupportedPositionUnit (OrientationUnits unit) const
 Determine if the specified distance unit is supported.
void addSupportedPositionUnit (OrientationUnits unitToSupport)
 Add support for a new distance unit type.
void removeSupportedPositionUnit (OrientationUnits unitToRemove)
 Remove support for a distance unit type.
const SupportedCSForGridLinessupportedCSForGridLines () const
 Retrieve the the list of coordinate systems that can have grid lines drawn using this display type.
bool isSupportedCSForGridLines (const std::string &cs) const
 Determine if this display supports grid lines for the specified coordinate system.
void addSupportedCSForGridLines (const std::string &cs)
 Add grid line support for a coordinate system.
void removeSupportedCSForGridLines (const std::string &cs)
 Remove grid line support for a coordinate system.

Additional Inherited Members

- Public Types inherited from makVrv::DtCoordinateDisplay
typedef
makArchives::DtDisplayUnitsSettingsRecord::CoordSys 
CoordSys
typedef
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits 
DistanceUnits
typedef
makArchives::DtDisplayUnitsSettingsRecord::VelocityUnits 
VelocityUnits
typedef
makArchives::DtDisplayUnitsSettingsRecord::AccelerationUnits 
AccelerationUnits
typedef
makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits 
OrientationUnits
typedef
makArchives::DtDisplayUnitsSettingsRecord::RotVelocityUnits 
RotVelocityUnits
typedef std::list< DistanceUnitsSupportedPositionDistanceUnits
typedef std::list
< OrientationUnits
SupportedPositionAngularUnits
typedef std::list< std::string > SupportedCSForGridLines
- Protected Attributes inherited from makVrv::DtCoordinateDisplay
const DtCoordinateSystemmyCoordinateSystem
SupportedPositionDistanceUnits mySupportedPositionDistanceUnits
SupportedPositionAngularUnits mySupportedPositionAngularUnits
SupportedCSForGridLines mySupportedCSForGridLines

Detailed Description

The geocentric coordinate display information for the GUI.

Constructor & Destructor Documentation

makVrv::DtGeocentricCoordinateDisplay::DtGeocentricCoordinateDisplay ( const DtCoordinateSystem cs)
virtual makVrv::DtGeocentricCoordinateDisplay::~DtGeocentricCoordinateDisplay ( )
virtual

Member Function Documentation

DtCoordinateDisplay* makVrv::DtGeocentricCoordinateDisplay::clone ( ) const
virtual

Virtual clone function.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtMgrsCoordinateDisplay, and makVrv::DtUtmCoordinateDisplay.

virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::name ( )
virtual
virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtGeocentricCoordinateDisplay::xUnitsFor ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit)
virtual
virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtGeocentricCoordinateDisplay::yUnitsFor ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit)
virtual
virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtGeocentricCoordinateDisplay::zUnitsFor ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit)
virtual
virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::xAxisLabel ( )
virtual
virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::yAxisLabel ( )
virtual
virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::zAxisLabel ( )
virtual
virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::northSouthGridLabel ( DistanceUnits  unit,
const DtVector geocPos,
int  decimals,
double  gridSpacing 
)
virtual

Get the label for a north/south grid line at geocPos.

Reimplemented from makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtMgrsCoordinateDisplay, and makVrv::DtUtmCoordinateDisplay.

virtual DtUnicode makVrv::DtGeocentricCoordinateDisplay::eastWestGridLabel ( DistanceUnits  unit,
const DtVector geocPos,
int  decimals,
double  gridSpacing 
)
virtual

Get the label for an east/west grid line at geocPos.

Reimplemented from makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtMgrsCoordinateDisplay, and makVrv::DtUtmCoordinateDisplay.

virtual std::vector<std::string> makVrv::DtGeocentricCoordinateDisplay::convertPositionToStringList ( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  unit,
const DtVector geocPos,
int  decimals 
)
virtual

Convert the geocentric position to formatted strings.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtMgrsCoordinateDisplay, and makVrv::DtUtmCoordinateDisplay.

virtual void makVrv::DtGeocentricCoordinateDisplay::convertToGeocentric ( const std::string &  x,
const std::string &  y,
const std::string &  z,
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  distUnits,
makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits  altUnits,
DtVector vector 
)
virtual

Converts the given coordinates (in string rep) from the base units to geocentric.

Note that the coordinates must be in the units of this collection

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtMgrsCoordinateDisplay, and makVrv::DtUtmCoordinateDisplay.

virtual DtVector makVrv::DtGeocentricCoordinateDisplay::convertFromGeocentric ( const DtVector geoc) const
virtual

Converts the given coordinates from geocentric to local.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtUtmCoordinateDisplay.

virtual DtTaitBryan makVrv::DtGeocentricCoordinateDisplay::headingPitchRollFor ( const DtVector location,
const DtTaitBryan &  geocOri 
) const
virtual

Return orientation in radians.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtUtmCoordinateDisplay.

virtual DtTaitBryan makVrv::DtGeocentricCoordinateDisplay::localOrientationFor ( const DtVector location,
const DtTaitBryan &  geocOri 
) const
virtual

Return local orientation given geocentric orientation.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtUtmCoordinateDisplay.

virtual DtVector makVrv::DtGeocentricCoordinateDisplay::geocToLocalVector ( const DtVector geocLoc,
const DtVector geocVec 
) const
virtual

Reimplemented from makVrv::DtCoordinateDisplay.

virtual void makVrv::DtGeocentricCoordinateDisplay::regularExpressionValidator ( std::string &  x,
std::string &  y,
std::string &  z 
)
virtual

Returns a the regexes for validating the XYZ values for this coord sys.

Need X, Y and Z because they may be different for a given coordinate system.

Implements makVrv::DtCoordinateDisplay.

Reimplemented in makVrv::DtUtmCoordinateDisplay, and makVrv::DtMgrsCoordinateDisplay.


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)