VgEngine::VgPosition Struct Reference

This struct encapsulates a 3D position. More...

Public Member Functions
	VgPosition ()
	Default constructor. More...
	VgPosition (VgEngine::VgConstRefPtr< VgEngine::VgSRS >const &pSRS)
	Constructor. More...
	VgPosition (const VgPosition &pOther)
	Copy constructor. More...
	VgPosition (double pXOrLongitude, double pYOrLatitude, double pZOrAltitude)
	constructor for WGS84 position (because it uses NULL SRS). More...
	VgPosition (double pXOrLongitude, double pYOrLatitude, double pZOrAltitude, VgEngine::VgConstRefPtr< VgEngine::VgSRS >const &pSRS)
	constructor for position with SRS. More...
bool	operator== (const VgPosition &pPositionToCompare) const
	This is an equality test operator. More...
bool	operator!= (const VgPosition &pPositionToCompare) const
	This is an inequality test operator. More...

Public Attributes
VgEngine::VgConstRefPtr < VgEngine::VgSRS >	mSRS
	The SRS the position is expressed in. More...
double	mXOrLongitude
	Depending on the SRS used this may be local metric X coordinate, or longitude. More...
double	mYOrLatitude
	Depending on the SRS used this may be local metric Y coordinate, or latitude. More...
double	mZOrAltitude
	Depending on the SRS used this may be local metric Z coordinate, or altitude. More...

Detailed Description

This struct encapsulates a 3D position.

This interpretation of the contents depends on the spatial reference system member. As of now, it can either be local metric coordinates (x, y, z) or WGS84 coordinates (latitude, longitude, altitude) in decimal degrees (and meters above water for altitude).

Constructor & Destructor Documentation

VgEngine::VgPosition::VgPosition ( )

inline

Default constructor.

Initializes to default values: mYOrLatitude = 0.0 mXOrLongitude = 0.0 mZOrAltitude = 0.0 mSRS = NULL

Note

This default value with a null SRS will probably be irrelevant for final applications. It denotes a spot in the atlantic ocean south of Togo.

VgEngine::VgPosition::VgPosition ( VgEngine::VgConstRefPtr< VgEngine::VgSRS >const &  pSRS )

inline

Constructor.

Initializes to default values: mYOrLatitude = 0.0 mXOrLongitude = 0.0 mZOrAltitude = 0.0

Parameters

pSRS	A pointer to the spatiual reference system to express the position in.

VgEngine::VgPosition::VgPosition ( const VgPosition &  pOther )

inline

Copy constructor.

Initializes the position.

Parameters

pOther

The position object to copy.

VgEngine::VgPosition::VgPosition ( double  pXOrLongitude, double  pYOrLatitude, double  pZOrAltitude  )

inline

constructor for WGS84 position (because it uses NULL SRS).

Parameters

pXOrLongitude	longitude of point
pYOrLatitude	latitude of point
pZOrAltitude	altitude of point.

Initializes to default values: mSRS = NULL

Version

2.0.8744

VgEngine::VgPosition::VgPosition ( double  pXOrLongitude, double  pYOrLatitude, double  pZOrAltitude, VgEngine::VgConstRefPtr< VgEngine::VgSRS >const &  pSRS  )

inline

constructor for position with SRS.

The parameters will be interpreted as a function of the pSRS parameters.

Parameters

pXOrLongitude	longitude of point
pYOrLatitude	latitude of point
pZOrAltitude	altitude of point.
pSRS	A pointer to the spatiual reference system to express the position in.

Version

2.0.8744

Member Function Documentation

bool VgEngine::VgPosition::operator!= ( const VgPosition &  pPositionToCompare ) const

inline

This is an inequality test operator.

Parameters

pPositionToCompare

The position to compare.

Returns

True if the positions are not equal, false if not.

bool VgEngine::VgPosition::operator== ( const VgPosition &  pPositionToCompare ) const

inline

This is an equality test operator.

Parameters

pPositionToCompare

The position to compare to.

Returns

True if positions are equal, false if not.

References mXOrLongitude, mYOrLatitude, and mZOrAltitude.

Member Data Documentation

VgEngine::VgConstRefPtr< VgEngine::VgSRS > VgEngine::VgPosition::mSRS

The SRS the position is expressed in.

If NULL, it means the position is expressed in WGS84 coordinates.

Version

2.0

double VgEngine::VgPosition::mXOrLongitude

Depending on the SRS used this may be local metric X coordinate, or longitude.

Referenced by operator==().

double VgEngine::VgPosition::mYOrLatitude

Depending on the SRS used this may be local metric Y coordinate, or latitude.

Referenced by operator==().

double VgEngine::VgPosition::mZOrAltitude

Depending on the SRS used this may be local metric Z coordinate, or altitude.

Referenced by operator==().

---

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

• VgPosition.h