An angle and related functions.
More...
#include <ignition/math/Angle.hh>
|
| Angle () |
| Constructor.
|
|
| Angle (const Angle &_angle) |
| Copy constructor.
|
|
| Angle (const double _radian) |
| Conversion Constructor.
|
|
virtual | ~Angle () |
| Destructor.
|
|
double | Degree () const |
| Get the angle in degrees.
|
|
void | Degree (double _degree) |
| Set the value from an angle in degrees.
|
|
void | Normalize () |
| Normalize the angle in the range -Pi to Pi.
|
|
bool | operator!= (const Angle &_angle) const |
| Inequality.
|
|
double | operator() () const |
| Return the angle's radian value.
|
|
double | operator* () const |
| Dereference operator.
|
|
Angle | operator* (const Angle &_angle) const |
| Multiplication operator, result = this * _angle.
|
|
Angle | operator*= (const Angle &_angle) |
| Multiplication set, this = this * _angle.
|
|
Angle | operator+ (const Angle &_angle) const |
| Addition operator, result = this + _angle.
|
|
Angle | operator+= (const Angle &_angle) |
| Addition set, this = this + _angle.
|
|
Angle | operator- (const Angle &_angle) const |
| Substraction, result = this - _angle.
|
|
Angle | operator-= (const Angle &_angle) |
| Subtraction set, this = this - _angle.
|
|
Angle | operator/ (const Angle &_angle) const |
| Division, result = this / _angle.
|
|
Angle | operator/= (const Angle &_angle) |
| Division set, this = this / _angle.
|
|
bool | operator< (const Angle &_angle) const |
| Less than operator.
|
|
bool | operator<= (const Angle &_angle) const |
| Less or equal operator.
|
|
bool | operator== (const Angle &_angle) const |
| Equality operator, result = this == _angle.
|
|
bool | operator> (const Angle &_angle) const |
| Greater than operator.
|
|
bool | operator>= (const Angle &_angle) const |
| Greater or equal operator.
|
|
double | Radian () const |
| Get the angle in radians.
|
|
void | Radian (double _radian) |
| Set the value from an angle in radians.
|
|
An angle and related functions.
◆ Angle() [1/3]
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Angle |
( |
| ) |
|
◆ Angle() [2/3]
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Angle |
( |
const double | _radian | ) |
|
Conversion Constructor.
- Parameters
-
◆ Angle() [3/3]
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Angle |
( |
const Angle & | _angle | ) |
|
Copy constructor.
- Parameters
-
◆ ~Angle()
virtual ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::~Angle |
( |
| ) |
|
|
virtual |
◆ Degree() [1/2]
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Degree |
( |
| ) |
const |
Get the angle in degrees.
- Returns
- double containing the angle's degree value
◆ Degree() [2/2]
void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Degree |
( |
double | _degree | ) |
|
Set the value from an angle in degrees.
- Parameters
-
◆ Normalize()
void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Normalize |
( |
| ) |
|
◆ operator!=()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator!= |
( |
const Angle & | _angle | ) |
const |
Inequality.
- Parameters
-
[in] | _angle | Angle to check for inequality |
- Returns
- true if this != _angle
◆ operator()()
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator() |
( |
| ) |
const |
Return the angle's radian value.
- Returns
- double containing the angle's radian value
◆ operator*() [1/2]
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator* |
( |
| ) |
const |
|
inline |
Dereference operator.
- Returns
- Double containing the angle's radian value
◆ operator*() [2/2]
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator* |
( |
const Angle & | _angle | ) |
const |
Multiplication operator, result = this * _angle.
- Parameters
-
[in] | _angle | Angle for multiplication |
- Returns
- the new angle
◆ operator*=()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator*= |
( |
const Angle & | _angle | ) |
|
Multiplication set, this = this * _angle.
- Parameters
-
[in] | _angle | Angle for multiplication |
- Returns
- angle
◆ operator+()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator+ |
( |
const Angle & | _angle | ) |
const |
Addition operator, result = this + _angle.
- Parameters
-
[in] | _angle | Angle for addition |
- Returns
- the new angle
◆ operator+=()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator+= |
( |
const Angle & | _angle | ) |
|
Addition set, this = this + _angle.
- Parameters
-
[in] | _angle | Angle for addition |
- Returns
- angle
◆ operator-()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator- |
( |
const Angle & | _angle | ) |
const |
Substraction, result = this - _angle.
- Parameters
-
[in] | _angle | Angle for substraction |
- Returns
- the new angle
◆ operator-=()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator-= |
( |
const Angle & | _angle | ) |
|
Subtraction set, this = this - _angle.
- Parameters
-
[in] | _angle | Angle for subtraction |
- Returns
- angle
◆ operator/()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator/ |
( |
const Angle & | _angle | ) |
const |
Division, result = this / _angle.
- Parameters
-
[in] | _angle | Angle for division |
- Returns
- the new angle
◆ operator/=()
Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator/= |
( |
const Angle & | _angle | ) |
|
Division set, this = this / _angle.
- Parameters
-
[in] | _angle | Angle for division |
- Returns
- angle
◆ operator<()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator< |
( |
const Angle & | _angle | ) |
const |
Less than operator.
- Parameters
-
- Returns
- true if this < _angle
◆ operator<=()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator<= |
( |
const Angle & | _angle | ) |
const |
Less or equal operator.
- Parameters
-
- Returns
- true if this <= _angle
◆ operator==()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator== |
( |
const Angle & | _angle | ) |
const |
Equality operator, result = this == _angle.
- Parameters
-
[in] | _angle | Angle to check for equality |
- Returns
- true if this == _angle
◆ operator>()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator> |
( |
const Angle & | _angle | ) |
const |
Greater than operator.
- Parameters
-
- Returns
- true if this > _angle
◆ operator>=()
bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::operator>= |
( |
const Angle & | _angle | ) |
const |
Greater or equal operator.
- Parameters
-
- Returns
- true if this >= _angle
◆ Radian() [1/2]
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Radian |
( |
| ) |
const |
Get the angle in radians.
- Returns
- double containing the angle's radian value
◆ Radian() [2/2]
void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Radian |
( |
double | _radian | ) |
|
◆ HalfPi
const Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::HalfPi |
|
static |
◆ Pi
const Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Pi |
|
static |
◆ TwoPi
const Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::TwoPi |
|
static |
◆ Zero
const Angle ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Angle::Zero |
|
static |
The documentation for this class was generated from the following file: