ignition::math::Angle Class Reference

An angle and related functions. More...

#include <ignition/math/Angle.hh>

Public Member Functions
	Angle ()
	Constructor. More...
	Angle (double _radian)
	Copy Constructor. More...
	Angle (const Angle &_angle)
	Copy constructor. More...
virtual	~Angle ()
	Destructor. More...
void	Degree (double _degree)
	Set the value from an angle in degrees. More...
double	Degree () const
	Get the angle in degrees. More...
void	Normalize ()
	Normalize the angle in the range -Pi to Pi. More...
bool	operator!= (const Angle &_angle) const
	Inequality. More...
double	operator* () const
	Dereference operator. More...
Angle	operator* (const Angle &_angle) const
	Multiplication operator, result = this * _angle. More...
Angle	operator*= (const Angle &_angle)
	Multiplication set, this = this * _angle. More...
Angle	operator+ (const Angle &_angle) const
	Addition operator, result = this + _angle. More...
Angle	operator+= (const Angle &_angle)
	Addition set, this = this + _angle. More...
Angle	operator- (const Angle &_angle) const
	Substraction, result = this - _angle. More...
Angle	operator-= (const Angle &_angle)
	Subtraction set, this = this - _angle. More...
Angle	operator/ (const Angle &_angle) const
	Division, result = this / _angle. More...
Angle	operator/= (const Angle &_angle)
	Division set, this = this / _angle. More...
bool	operator< (const Angle &_angle) const
	Less than operator. More...
bool	operator<= (const Angle &_angle) const
	Less or equal operator. More...
bool	operator== (const Angle &_angle) const
	Equality operator, result = this == _angle. More...
bool	operator> (const Angle &_angle) const
	Greater than operator. More...
bool	operator>= (const Angle &_angle) const
	Greater or equal operator. More...
void	Radian (double _radian)
	Set the value from an angle in radians. More...
double	Radian () const
	Get the angle in radians. More...

Static Public Attributes
static const Angle	HalfPi
	math::Angle(IGN_PI * 0.5) More...
static const Angle	Pi
	math::Angle(IGN_PI) More...
static const Angle	TwoPi
	math::Angle(IGN_PI * 2) More...
static const Angle	Zero
	math::Angle(0) More...

Friends
std::ostream &	operator<< (std::ostream &_out, const ignition::math::Angle &_a)
	Stream insertion operator. More...
std::istream &	operator>> (std::istream &_in, ignition::math::Angle &_a)
	Stream extraction operator. More...

Detailed Description

An angle and related functions.

Constructor & Destructor Documentation

ignition::math::Angle::Angle

(

)

Constructor.

ignition::math::Angle::Angle

(

double

_radian

)

Copy Constructor.

Parameters

[in]

_radian

Radians

ignition::math::Angle::Angle

(

const Angle &

_angle

)

Copy constructor.

Parameters

[in]

_angle

Angle to copy

virtual ignition::math::Angle::~Angle ( )

virtual

Destructor.

Member Function Documentation

void ignition::math::Angle::Degree

(

double

_degree

)

Set the value from an angle in degrees.

Parameters

[in]

_degree

Degree value

double ignition::math::Angle::Degree

(

)

const

Get the angle in degrees.

Returns

double containing the angle's degree value

void ignition::math::Angle::Normalize

(

)

Normalize the angle in the range -Pi to Pi.

bool ignition::math::Angle::operator!=

(

const Angle &

_angle

)

const

Inequality.

Parameters

[in]

_angle

Angle to check for inequality

Returns

true if this != _angle

double ignition::math::Angle::operator* ( ) const

inline

Dereference operator.

Returns

Double containing the angle's radian value

Angle ignition::math::Angle::operator*

(

const Angle &

_angle

)

const

Multiplication operator, result = this * _angle.

Parameters

[in]

_angle

Angle for multiplication

Returns

the new angle

Angle ignition::math::Angle::operator*=

(

const Angle &

_angle

)

Multiplication set, this = this * _angle.

Parameters

[in]

_angle

Angle for multiplication

Returns

angle

Angle ignition::math::Angle::operator+

(

const Angle &

_angle

)

const

Addition operator, result = this + _angle.

Parameters

[in]

_angle

Angle for addition

Returns

the new angle

Angle ignition::math::Angle::operator+=

(

const Angle &

_angle

)

Addition set, this = this + _angle.

Parameters

[in]

_angle

Angle for addition

Returns

angle

Angle ignition::math::Angle::operator-

(

const Angle &

_angle

)

const

Substraction, result = this - _angle.

Parameters

[in]

_angle

Angle for substraction

Returns

the new angle

Angle ignition::math::Angle::operator-=

(

const Angle &

_angle

)

Subtraction set, this = this - _angle.

Parameters

[in]

_angle

Angle for subtraction

Returns

angle

Angle ignition::math::Angle::operator/

(

const Angle &

_angle

)

const

Division, result = this / _angle.

Parameters

[in]

_angle

Angle for division

Returns

the new angle

Angle ignition::math::Angle::operator/=

(

const Angle &

_angle

)

Division set, this = this / _angle.

Parameters

[in]

_angle

Angle for division

Returns

angle

bool ignition::math::Angle::operator<

(

const Angle &

_angle

)

const

Less than operator.

Parameters

[in]

_angle

Angle to check

Returns

true if this < _angle

bool ignition::math::Angle::operator<=

(

const Angle &

_angle

)

const

Less or equal operator.

Parameters

[in]

_angle

Angle to check

Returns

true if this <= _angle

bool ignition::math::Angle::operator==

(

const Angle &

_angle

)

const

Equality operator, result = this == _angle.

Parameters

[in]

_angle

Angle to check for equality

Returns

true if this == _angle

bool ignition::math::Angle::operator>

(

const Angle &

_angle

)

const

Greater than operator.

Parameters

[in]

_angle

Angle to check

Returns

true if this > _angle

bool ignition::math::Angle::operator>=

(

const Angle &

_angle

)

const

Greater or equal operator.

Parameters

[in]

_angle

Angle to check

Returns

true if this >= _angle

void ignition::math::Angle::Radian

(

double

_radian

)

Set the value from an angle in radians.

Parameters

[in]

_radian

Radian value

double ignition::math::Angle::Radian

(

)

const

Get the angle in radians.

Returns

double containing the angle's radian value

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _out, const ignition::math::Angle &  _a  )

friend

Stream insertion operator.

Outputs in degrees

Parameters

[in]	_out	output stream
[in]	_a	angle to output

Returns

The output stream

std::istream& operator>> ( std::istream &  _in, ignition::math::Angle &  _a  )

friend

Stream extraction operator.

Assumes input is in radians

Parameters

in	input stream
pt	angle to read value into

Returns

The input stream

Member Data Documentation

const Angle ignition::math::Angle::HalfPi

static

math::Angle(IGN_PI * 0.5)

const Angle ignition::math::Angle::Pi

static

math::Angle(IGN_PI)

const Angle ignition::math::Angle::TwoPi

static

math::Angle(IGN_PI * 2)

const Angle ignition::math::Angle::Zero

static

math::Angle(0)

---

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

• Angle.hh