CxUtils::Orientation Class Reference

Simple class for doing angle difference or other needed orientation methods. More...

#include <coordinates.h>

List of all members.

Static Public Member Functions
static double	AngleDiff (const double angleSrc, const double angleDest, const bool radiansFlag=true)
	Calculates the difference between two angles. All angle values are ` in the range of (-PI, PI].
static Point3D	AngleDiff (const Point3D &angleSrc, const Point3D &angleDest, const bool radiansFlag=true)
	Calculates the difference between multiple angles. All angle values are in the range of (-PI, PI].
static double	AddToAngle (const double angleSrc, const double angleDiff, const bool radiansFlag=true)
	Add two angles, calculate the result between (-PI, PI].
static Point3D	AddAngles (const Point3D &src, const Point3D &delta, const bool radiansFlag=true)
	Add two angles, calculate the result between (-PI, PI].
static double	GetGlobalAngle (const Wgs &srcPos, const Wgs &destPos, const bool radiansFlag=true)
	Calculates the compass heading from one point to another.
static double	GetGlobalAngle (const Utm &srcPos, const Utm &destPos, const bool radiansFlag=true)
	Calculates the compass heading from one point to another.

---

Detailed Description

Simple class for doing angle difference or other needed orientation methods.

Definition at line 204 of file coordinates.h.

---

Member Function Documentation

Point3D Orientation::AddAngles	(	const Point3D &	src,
		const Point3D &	delta,
		const bool	radiansFlag = true
	)		[static]

Add two angles, calculate the result between (-PI, PI].

Parameters:

[in]	src	The source angle (e.g. your current heading).
[in]	delta	The angle you want to add.
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

The result of the addition between (-PI, PI].

Definition at line 1483 of file coordinates.cpp.

double Orientation::AddToAngle	(	const double	angleSrc,
		const double	angleDiff,
		const bool	radiansFlag = true
	)		[static]

Add two angles, calculate the result between (-PI, PI].

Parameters:

[in]	angleSrc	The source angle (e.g. your current heading).
[in]	angleDiff	The angle you want to add.
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

The result of the addition between (-PI, PI].

Definition at line 1437 of file coordinates.cpp.

Point3D Orientation::AngleDiff	(	const Point3D &	angleSrc,
		const Point3D &	angleDest,
		const bool	radiansFlag = true
	)		[static]

Calculates the difference between multiple angles. All angle values are in the range of (-PI, PI].

Parameters:

[in]	angleSrc	The source angles (e.g. your current heading).
[in]	angleDest	The destination angles (e.g. where you want to face).
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

Difference between the destination angles, the source angles.

Definition at line 1417 of file coordinates.cpp.

double Orientation::AngleDiff	(	const double	angleSrc,
		const double	angleDest,
		const bool	radiansFlag = true
	)		[static]

Calculates the difference between two angles. All angle values are ` in the range of (-PI, PI].

Calculates the difference between two angles. All angle values are in the range of (-PI, PI].

Parameters:

[in]	angleSrc	The source angle (e.g. your current heading).
[in]	angleDest	The destination angle (e.g. where you want to face).
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

Difference between the destination angle, the source angle.

Definition at line 1372 of file coordinates.cpp.

double Orientation::GetGlobalAngle	(	const Utm &	srcPos,
		const Utm &	destPos,
		const bool	radiansFlag = true
	)		[static]

Calculates the compass heading from one point to another.

Parameters:

[in]	srcPos	The starting position.
[in]	destPos	Destination position.
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

The angle to drive at to hit the destination point.

Definition at line 1526 of file coordinates.cpp.

double Orientation::GetGlobalAngle	(	const Wgs &	srcPos,
		const Wgs &	destPos,
		const bool	radiansFlag = true
	)		[static]

Calculates the compass heading from one point to another.

Parameters:

[in]	srcPos	The starting position.
[in]	destPos	Destination position.
[in]	radiansFlag	If true, values are in radians, otherwise degrees.

Returns:

The angle to drive at to hit the destination point.

Definition at line 1505 of file coordinates.cpp.

---

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

• C:/Active/libraries/cxutils/2.0/include/cxutils/math/coordinates.h
• C:/Active/libraries/cxutils/2.0/src/cxutils/math/coordinates.cpp