Angle Class Reference

A compass bearing angle measured in degrees, with wraparound arithmetic. More...

#include <angle.h>

Public Member Functions
	Angle ()
	Default constructor — creates an invalid angle with value -1.
	Angle (double degrees)
	Construct an Angle with the given degree value.
Angle	operator+ (const Angle &other) const
	Add another Angle, wrapping around 360 degrees.
Angle	operator+ (double degrees) const
	Add a scalar degree value, wrapping around 360 degrees.
Angle	operator- (const Angle &other) const
	Subtract another Angle, wrapping around 360 degrees.
Angle	operator- (double degrees) const
	Subtract a scalar degree value, wrapping around 360 degrees.
void	operator+= (const Angle &other)
	Add another Angle in place.
void	operator+= (double degrees)
	Add a scalar degree value in place.
void	operator-= (const Angle &other)
	Subtract another Angle in place.
void	operator-= (double degrees)
	Subtract a scalar degree value in place.
double	degrees () const
	Return the angle in degrees.
void	setDegrees (double value)
	Set the angle in degrees.
void	add (double degrees)
	Add a degree amount with wraparound in place.
void	subtract (double degrees)
	Subtract a degree amount with wraparound in place.
QString	toString () const
	Format the angle as a string.

Detailed Description

A compass bearing angle measured in degrees, with wraparound arithmetic.

Represents an angle in degrees with wraparound-aware addition and subtraction.

Angles are stored in degrees. Arithmetic operators automatically keep values in the range [0, 360).

Definition at line 16 of file angle.h.

Constructor & Destructor Documentation

Angle() [1/2]

Angle::Angle ( )

inline

Default constructor — creates an invalid angle with value -1.

Definition at line 20 of file angle.h.

Angle() [2/2]

Angle::Angle ( double  degrees )

inline

Construct an Angle with the given degree value.

Parameters

degrees

Angle in degrees

Definition at line 26 of file angle.h.

Member Function Documentation

add()

void Angle::add

(

double

degrees

)

Add a degree amount with wraparound in place.

Parameters

degrees

Degrees to add

degrees()

double Angle::degrees ( ) const

inline

Return the angle in degrees.

Returns

Degree value

Definition at line 73 of file angle.h.

operator+() [1/2]

Angle Angle::operator+ ( const Angle &  other ) const

inline

Add another Angle, wrapping around 360 degrees.

Parameters

other

Angle to add

Returns

Resulting angle

Definition at line 33 of file angle.h.

operator+() [2/2]

Angle Angle::operator+

(

double

degrees

)

const

Add a scalar degree value, wrapping around 360 degrees.

Parameters

degrees

Degrees to add

Returns

Resulting angle

operator+=() [1/2]

void Angle::operator+= ( const Angle &  other )

inline

Add another Angle in place.

Parameters

other

Angle to add.

Definition at line 58 of file angle.h.

operator+=() [2/2]

void Angle::operator+= ( double  degrees )

inline

Add a scalar degree value in place.

Parameters

degrees

Degrees to add.

Definition at line 61 of file angle.h.

operator-() [1/2]

Angle Angle::operator- ( const Angle &  other ) const

inline

Subtract another Angle, wrapping around 360 degrees.

Parameters

other

Angle to subtract

Returns

Resulting angle

Definition at line 47 of file angle.h.

operator-() [2/2]

Angle Angle::operator-

(

double

degrees

)

const

Subtract a scalar degree value, wrapping around 360 degrees.

Parameters

degrees

Degrees to subtract

Returns

Resulting angle

operator-=() [1/2]

void Angle::operator-= ( const Angle &  other )

inline

Subtract another Angle in place.

Parameters

other

Angle to subtract.

Definition at line 64 of file angle.h.

operator-=() [2/2]

void Angle::operator-= ( double  degrees )

inline

Subtract a scalar degree value in place.

Parameters

degrees

Degrees to subtract.

Definition at line 67 of file angle.h.

setDegrees()

void Angle::setDegrees ( double  value )

inline

Set the angle in degrees.

Parameters

value

New degree value

Definition at line 79 of file angle.h.

subtract()

void Angle::subtract

(

double

degrees

)

Subtract a degree amount with wraparound in place.

Parameters

degrees

Degrees to subtract

toString()

QString Angle::toString ( ) const

inline

Format the angle as a string.

Returns

String of the form "X.Y deg"

Definition at line 97 of file angle.h.

---

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

• include/Kanoop/geometry/angle.h