MIRA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
SignedRadian< T > Class Template Reference

Signed angle that is represented using radians. More...

#include <math/Angle.h>

Inheritance diagram for SignedRadian< T >:
Inheritance graph
[legend]

Public Member Functions

SignedRadian< T > smallestDifference (const SignedRadian &other) const
 Returns the signed difference angle between this angle and the specified other angle that has the smallest absolute value. More...
 
void reflect (Reflector &r)
 
void setValue (const T &value)
 Set the angle value. The input value is mapped into the angle interval. More...
 
const T & value () const
 Returns the raw angle value given in the native unit of the angle class. More...
 
 operator T () const
 Conversion function to native type (same as value() ) More...
 
void setSerializedValue (const T &value)
 Sets the value in the unit that is used for serialization. More...
 
serializedValue () const
 Returns the value in the unit that is used for serialization. More...
 
deg () const
 Returns the value of the angle in degrees. More...
 
rad () const
 Returns the value of the angle in radian. More...
 
SignedRadian< T > operator- () const
 Unary minus operator. More...
 
SignedRadian< T > operator+= (const AngleBase< T, OtherUnitTag, OtherDerived > &a)
 Add other angle to this angle. More...
 
SignedRadian< T > & operator+= (const T &a)
 Add float value to this angle. More...
 
SignedRadian< T > operator-= (const AngleBase< T, OtherUnitTag, OtherDerived > &a)
 Subtract other angle from this angle. More...
 
SignedRadian< T > & operator-= (const T &a)
 Subtract float value from this angle. More...
 
SignedRadian< T > & operator*= (const T &s)
 Multiply this angle with scalar. More...
 
SignedRadian< T > & operator/= (const T &s)
 Divide this angle by scalar. More...
 
smallestDifferenceValue (const SignedRadian< T > &other) const
 Returns the signed difference angle between this angle and the specified other angle that has the smallest absolute value. More...
 
bool isInInterval (const SignedRadian< T > &min, const SignedRadian< T > &max) const
 Returns true, if the angle is in the given interval [min,max]. More...
 

Static Public Member Functions

static T lower ()
 Returns the lower limit of the defined angle interval. More...
 
static T turn ()
 Returns the amount of a turn (full circle) that is equal to 360 deg. More...
 
static T convertToSerialized (T value)
 Converts own representation to serialized representation. More...
 
static T convertFromSerialized (T value)
 Converts serialized representation to own representation. More...
 
static T upper ()
 Returns the upper limit of the defined angle interval. More...
 
static const char * unit ()
 Returns the unit of this angle representation as string, e.g. More...
 

Protected Attributes

mValue
 the actual value More...
 

Friends

class Radian< T >
 

Detailed Description

template<typename T>
class mira::SignedRadian< T >

Signed angle that is represented using radians.

The values are normalized to the interval [-pi,pi). The class will take care that the values stay within this range, when operations and computations are performed.

The values are interchangeable with other angle types, conversions will be done automatically between them.

Member Function Documentation

static T lower ( )
inlinestatic

Returns the lower limit of the defined angle interval.

Note, that the lower limit is included in the interval, hence the interval is [lower,upper) .

SignedRadian<T> smallestDifference ( const SignedRadian< T > &  other) const
inline

Returns the signed difference angle between this angle and the specified other angle that has the smallest absolute value.

static T turn ( )
inlinestaticinherited

Returns the amount of a turn (full circle) that is equal to 360 deg.

static T convertToSerialized ( value)
inlinestaticinherited

Converts own representation to serialized representation.

static T convertFromSerialized ( value)
inlinestaticinherited

Converts serialized representation to own representation.

void reflect ( Reflector &  r)
inlineinherited
static T upper ( )
inlinestaticinherited

Returns the upper limit of the defined angle interval.

Note, that the upper limit does not belong to the interval itself, hence the interval is [lower,upper) .

void setValue ( const T &  value)
inlineinherited

Set the angle value. The input value is mapped into the angle interval.

const T& value ( ) const
inlineinherited

Returns the raw angle value given in the native unit of the angle class.

operator T ( ) const
inlineexplicitinherited

Conversion function to native type (same as value() )

Implicit conversion is intentionally disabled, in order to prevent potentially erroneous usage like

Angle a = 2;
T f = 5;
T r = a * f; // r is (T)Angle(2*5), which is NOT 2*5
void setSerializedValue ( const T &  value)
inlineinherited

Sets the value in the unit that is used for serialization.

The Angle and SignedAngle classes use radians for storing the value internal and degrees for serializing the value to simplify the usage for the human user. For the other classes Degree, SignedDegree, Radian and SignedRadian setValue() and setSerializedValue() are doing the same.

T serializedValue ( ) const
inlineinherited

Returns the value in the unit that is used for serialization.

The Angle and SignedAngle classes use radians for storing the value internal and degrees for serializing the value to simplify the usage for the human user. For the other classes Degree, SignedDegree, Radian and SignedRadian value() and serializedValue() yield the same result.

T deg ( ) const
inlineinherited

Returns the value of the angle in degrees.

T rad ( ) const
inlineinherited

Returns the value of the angle in radian.

SignedRadian< T > operator- ( ) const
inlineinherited

Unary minus operator.

SignedRadian< T > operator+= ( const AngleBase< T, OtherUnitTag, OtherDerived > &  a)
inlineinherited

Add other angle to this angle.

SignedRadian< T > & operator+= ( const T &  a)
inlineinherited

Add float value to this angle.

SignedRadian< T > operator-= ( const AngleBase< T, OtherUnitTag, OtherDerived > &  a)
inlineinherited

Subtract other angle from this angle.

SignedRadian< T > & operator-= ( const T &  a)
inlineinherited

Subtract float value from this angle.

SignedRadian< T > & operator*= ( const T &  s)
inlineinherited

Multiply this angle with scalar.

SignedRadian< T > & operator/= ( const T &  s)
inlineinherited

Divide this angle by scalar.

T smallestDifferenceValue ( const SignedRadian< T > &  other) const
inlineinherited

Returns the signed difference angle between this angle and the specified other angle that has the smallest absolute value.

This method is similar to smallestDifference() but returns a floating point value instead of a signed angle class object.

bool isInInterval ( const SignedRadian< T > &  min,
const SignedRadian< T > &  max 
) const
inlineinherited

Returns true, if the angle is in the given interval [min,max].

If max<min, both values will be swapped.

static const char* unit ( )
inlinestaticinherited

Returns the unit of this angle representation as string, e.g.

"rad" or "deg"

Friends And Related Function Documentation

friend class Radian< T >
friend

Member Data Documentation

T mValue
protectedinherited

the actual value


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