envitia::maplink::earth::GeocentricDirection Class Reference

Inheritance diagram for envitia::maplink::earth::GeocentricDirection:

Detailed Description

A direction in geocentric (ECEF) space

This class is used to specify a direction vector in Earth-Centered Earth-Fixed (ECEF) space x, y, and z are specified as meters relative to the center of mass of the earth.

Public Member Functions
	GeocentricDirection ()
	Constructor.
	GeocentricDirection (double x, double y, double z)
	Constructor.
	GeocentricDirection (const GeocentricDirection &other)
	Copy Constructor.
	GeocentricDirection (const Vec3 &other)
	Copy Constructor.
virtual	~GeocentricDirection ()
	Destructor.
GeocentricPoint	toPoint () const
GeocentricPoint	toPoint (const GeocentricPoint &origin) const
bool	operator== (const GeocentricDirection &v) const
	Equality operator.
bool	operator!= (const GeocentricDirection &v) const
	Inequality operator.
bool	operator< (const Vec3 &v) const
	Less than operator.
const GeocentricDirection	operator* (const double &v) const
	Multiply the vector by a scalar value.
GeocentricDirection	operator*= (const double &v)
	Multiply the vector by a scalar value.
const GeocentricDirection	operator/ (const double &v) const
	Divide the vector by a scalar value.
GeocentricDirection	operator/= (const double &v)
	Divide the vector by a scalar value.
const GeocentricDirection	operator+ (const GeocentricDirection &v) const
	Addition operator.
GeocentricDirection	operator+= (const GeocentricDirection &v)
	Addition operator.
const GeocentricDirection	operator- (const GeocentricDirection &v) const
	Subtraction operator.
GeocentricDirection	operator-= (const GeocentricDirection &v)
	Subtraction operator.
double	operator* (const GeocentricDirection &v) const
const GeocentricDirection	operator^ (const GeocentricDirection &v) const
Public Member Functions inherited from envitia::maplink::earth::Vec3
virtual	~Vec3 ()
	Destructor.
double	x () const
	Get the x component of the vector.
double	y () const
	Get the y component of the vector.
double	z () const
	Get the z component of the vector.
void	x (double v)
	Set the x component of the vector.
void	y (double v)
	Set the y component of the vector.
void	z (double v)
	Set the z component of the vector.
double	length () const
	Get the length of the vector.
void	normalise ()

Additional Inherited Members
Protected Member Functions inherited from envitia::maplink::earth::Vec3
	Vec3 ()
	Constructor.
	Vec3 (double x, double y, double z)
	Constructor.
	Vec3 (const Vec3 &other)
	Copy Constructor.
bool	operator== (const Vec3 &v) const
	Equality operator.
bool	operator!= (const Vec3 &v) const
	Inequality operator.
bool	operator< (const Vec3 &v) const
	Less than operator.
const Vec3	operator* (const double &v) const
	Multiply the vector by a scalar value.
Vec3	operator*= (const double &v)
	Multiply the vector by a scalar value.
const Vec3	operator/ (const double &v) const
	Divide the vector by a scalar value.
Vec3	operator/= (const double &v)
	Divide the vector by a scalar value.
const Vec3	operator+ (const Vec3 &v) const
	Addition operator.
Vec3	operator+= (const Vec3 &v)
	Addition operator.
const Vec3	operator- (const Vec3 &v) const
	Subtraction operator.
Vec3	operator-= (const Vec3 &v)
	Subtraction operator.
double	operator* (const Vec3 &v) const
const Vec3	operator^ (const Vec3 &v) const
Protected Attributes inherited from envitia::maplink::earth::Vec3
double	m_v [3]

Constructor & Destructor Documentation

GeocentricDirection() [1/4]

envitia::maplink::earth::GeocentricDirection::GeocentricDirection

(

)

Constructor.

GeocentricDirection() [2/4]

envitia::maplink::earth::GeocentricDirection::GeocentricDirection	(	double	x,
		double	y,
		double	z )

Constructor.

GeocentricDirection() [3/4]

envitia::maplink::earth::GeocentricDirection::GeocentricDirection

(

const GeocentricDirection &

other

)

Copy Constructor.

GeocentricDirection() [4/4]

envitia::maplink::earth::GeocentricDirection::GeocentricDirection

(

const Vec3 &

other

)

Copy Constructor.

~GeocentricDirection()

virtual envitia::maplink::earth::GeocentricDirection::~GeocentricDirection ( )

virtual

Destructor.

Member Function Documentation

operator!=()

bool envitia::maplink::earth::GeocentricDirection::operator!=

(

const GeocentricDirection &

v

)

const

Inequality operator.

operator*() [1/2]

const GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator*

(

const double &

v

)

const

Multiply the vector by a scalar value.

operator*() [2/2]

double envitia::maplink::earth::GeocentricDirection::operator*

(

const GeocentricDirection &

v

)

const

Calculate the dot product with another vector

Parameters

v	The vector to perform a dot product against

Returns

The dot product (this . v)

operator*=()

GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator*=

(

const double &

v

)

Multiply the vector by a scalar value.

operator+()

const GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator+

(

const GeocentricDirection &

v

)

const

Addition operator.

operator+=()

GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator+=

(

const GeocentricDirection &

v

)

Addition operator.

operator-()

const GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator-

(

const GeocentricDirection &

v

)

const

Subtraction operator.

operator-=()

GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator-=

(

const GeocentricDirection &

v

)

Subtraction operator.

operator/()

const GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator/

(

const double &

v

)

const

Divide the vector by a scalar value.

operator/=()

GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator/=

(

const double &

v

)

Divide the vector by a scalar value.

operator<()

bool envitia::maplink::earth::GeocentricDirection::operator<

(

const Vec3 &

v

)

const

Less than operator.

operator==()

bool envitia::maplink::earth::GeocentricDirection::operator==

(

const GeocentricDirection &

v

)

const

Equality operator.

operator^()

const GeocentricDirection envitia::maplink::earth::GeocentricDirection::operator^

(

const GeocentricDirection &

v

)

const

Calculate the cross product with another vector

Parameters

v	The vector to perform a cross product against

Returns

The cross product (this x v)

toPoint() [1/2]

GeocentricPoint envitia::maplink::earth::GeocentricDirection::toPoint

(

)

const

Convert to a position

The position will be calculated as a translation from the origin along this direction.

The length of the direction class will be used to determine the resulting point.

toPoint() [2/2]

GeocentricPoint envitia::maplink::earth::GeocentricDirection::toPoint

(

const GeocentricPoint &

origin

)

const

Convert to a position

The position will be calculated as a translation from the origin along this direction.

The length of the direction class will be used to determine the resulting point.

Parameters

origin

The origin of the direction