It defines the basic type CRadians, used to store an angle value in radians.
More...
#include <angles.h>
It defines the basic type CRadians, used to store an angle value in radians.
Definition at line 42 of file angles.h.
◆ CRadians() [1/2]
argos::CRadians::CRadians |
( |
| ) |
|
|
inline |
Class constructor It initializes m_fValue to 0 radians.
Definition at line 85 of file angles.h.
◆ CRadians() [2/2]
argos::CRadians::CRadians |
( |
Real |
f_value | ) |
|
|
inlineexplicit |
Class constructor It initializes m_fValue to the passed value.
- Parameters
-
f_value | the wanted value in radians |
Definition at line 94 of file angles.h.
◆ FromValueInDegrees()
void argos::CRadians::FromValueInDegrees |
( |
Real |
f_value | ) |
|
|
inline |
Sets the value from a value in degrees It sets m_fValue (which is in radians) converting from the passed value in degrees.
- Parameters
-
f_value | a value in degrees |
Definition at line 103 of file angles.h.
◆ GetAbsoluteValue()
Real argos::CRadians::GetAbsoluteValue |
( |
| ) |
const |
|
inline |
Returns the absolute value in radians.
- Returns
- the absolute value in radians
Definition at line 119 of file angles.h.
◆ GetValue()
Real argos::CRadians::GetValue |
( |
| ) |
const |
|
inline |
Returns the value in radians.
- Returns
- the value in radians
Definition at line 111 of file angles.h.
◆ Negate()
◆ operator!=()
bool argos::CRadians::operator!= |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator*()
◆ operator*=()
◆ operator+() [1/2]
CRadians& argos::CRadians::operator+ |
( |
| ) |
|
|
inline |
◆ operator+() [2/2]
◆ operator+=()
◆ operator-() [1/2]
CRadians argos::CRadians::operator- |
( |
| ) |
const |
|
inline |
◆ operator-() [2/2]
◆ operator-=()
◆ operator/() [1/2]
Real argos::CRadians::operator/ |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator/() [2/2]
◆ operator/=()
◆ operator<()
bool argos::CRadians::operator< |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator<=()
bool argos::CRadians::operator<= |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator==()
bool argos::CRadians::operator== |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator>()
bool argos::CRadians::operator> |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ operator>=()
bool argos::CRadians::operator>= |
( |
const CRadians & |
c_radians | ) |
const |
|
inline |
◆ SetValue()
void argos::CRadians::SetValue |
( |
Real |
f_value | ) |
|
|
inline |
Sets the value in radians.
- Parameters
-
f_value | the wanted value in radians |
Definition at line 127 of file angles.h.
◆ SignedNormalize()
CRadians& argos::CRadians::SignedNormalize |
( |
| ) |
|
|
inline |
Normalizes the value in the range [-PI:PI].
- Returns
- A reference to the current object
- See also
- CRadians::PI
-
CRange
Definition at line 137 of file angles.h.
◆ UnsignedNormalize()
CRadians& argos::CRadians::UnsignedNormalize |
( |
| ) |
|
|
inline |
◆ NormalizedDifference
Calculates the normalized difference between the given angles.
The difference is calculated as c_angle1 - c_angle2 and normalized in the range [-pi,pi].
- Parameters
-
c_angle1 | The first angle |
c_angle2 | The second angle |
- Returns
- The smallest difference between the two angles
Definition at line 510 of file angles.h.
◆ operator*
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
c_os, |
|
|
const CRadians & |
c_radians |
|
) |
| |
|
friend |
◆ operator>>
std::istream& operator>> |
( |
std::istream & |
is, |
|
|
CRadians & |
c_radians |
|
) |
| |
|
friend |
◆ ToDegrees
Converts this object to CDegrees.
- Returns
- the conversion of m_fValue into CDegrees
- Parameters
-
c_radians | the object to convert |
- Returns
- the converted CDegrees object
Definition at line 489 of file angles.h.
◆ PI
The PI constant.
Definition at line 49 of file angles.h.
◆ PI_OVER_FOUR
const CRadians argos::CRadians::PI_OVER_FOUR |
|
static |
Set to PI / 4.
Definition at line 69 of file angles.h.
◆ PI_OVER_SIX
const CRadians argos::CRadians::PI_OVER_SIX |
|
static |
Set to PI / 6.
Definition at line 74 of file angles.h.
◆ PI_OVER_THREE
const CRadians argos::CRadians::PI_OVER_THREE |
|
static |
Set to PI / 3.
Definition at line 64 of file angles.h.
◆ PI_OVER_TWO
const CRadians argos::CRadians::PI_OVER_TWO |
|
static |
Set to PI / 2.
Definition at line 59 of file angles.h.
◆ RADIANS_TO_DEGREES
const Real argos::CRadians::RADIANS_TO_DEGREES |
|
static |
Constant to convert from radians to degrees.
Definition at line 275 of file angles.h.
◆ SIGNED_RANGE
The signed normalization range [-PI:PI].
Definition at line 273 of file angles.h.
◆ TWO_PI
Set to PI * 2.
Definition at line 54 of file angles.h.
◆ UNSIGNED_RANGE
The unsigned normalization range [0:TWO_PI].
Definition at line 274 of file angles.h.
◆ ZERO
Set to zero radians.
Definition at line 79 of file angles.h.
The documentation for this class was generated from the following files: