Interface for angular measurements. More...

#include <angle.hpp>

Public Types
typedef ecl::linear_algebra::Matrix< T, 2, 2 >	RotationMatrix

Public Member Functions
	Angle (const T &angle=0.0)
	Constructs an angle in radians. More...

	Angle (const RotationMatrix &rotation)
	Construct from a 2x2 rotation matrix. More...

T	degrees ()
	Returns the value of the angle in unit degrees. More...

	operator const T & () const
	Convenient equivalence to the c/c++ float type. More...

Angle< T >	operator* (const T &scalar) const
	Multiplier. More...

void	operator*= (const T &scalar)
	Multiplier that works on this instance. More...

Angle< T >	operator+ (const T &angle) const
	Sum operator. More...

Angle< T >	operator+ (const Angle< T > &angle) const
	Sum operator. More...

void	operator+= (const T &angle)
	Sum operator that works on this instance. More...

void	operator+= (const Angle< T > &angle)
	Sum operator that works on this instance. More...

Angle< T >	operator- (const T &angle) const
	Difference operator. More...

Angle< T >	operator- (const Angle< T > &angle) const
	Difference operator. More...

void	operator-= (const T &angle)
	Difference operator that works on this instance. More...

void	operator-= (const Angle< T > &angle)
	Difference operator that works on this instance. More...

const Angle< T > &	operator= (const T &angle)
	Allow assignment from float types. More...

RotationMatrix	rotationMatrix () const
	Convert to a 2x2 rotation matrix. More...

Static Public Member Functions
static Angle< T >	Degrees (const T &angle)
	Generates an angle instance from an angle in degrees. More...

static Angle< T >	Radians (const T &angle)
	Generates an angle instance from an angle in radians. More...

Private Attributes
T	value

Detailed Description

template<typename T>
class ecl::Angle< T, enable_if< is_float< T > >::type >

Interface for angular measurements.

This is a simple interface designed for scientific calculations (thus the default format is in radians). It allows free interaction with float types, does automatic wrapping on [-pi, pi] under the hood and provides some generic methods for conversions and wrapping on plain double types.

Template Parameters

T	: must be a float type (e.g. float, double, float32, float64)

Definition at line 136 of file angle.hpp.

Member Typedef Documentation

◆ RotationMatrix

template<typename T >

typedef ecl::linear_algebra::Matrix<T,2,2> ecl::Angle< T, enable_if< is_float< T > >::type >::RotationMatrix

Definition at line 141 of file angle.hpp.

Constructor & Destructor Documentation

◆ Angle() [1/2]

template<typename T >

ecl::Angle< T, enable_if< is_float< T > >::type >::Angle ( const T & angle = 0.0 )

inline

Constructs an angle in radians.

Configures the angle from the input double value. Automatically wraps this value if it doesn't fall within [-pi,pi].

Parameters

angle : input angle (radians).

Definition at line 150 of file angle.hpp.

◆ Angle() [2/2]

template<typename T >

ecl::Angle< T, enable_if< is_float< T > >::type >::Angle ( const RotationMatrix & rotation )

inline

Construct from a 2x2 rotation matrix.

Parameters

rotation : input rotation matrix.

Definition at line 155 of file angle.hpp.

Member Function Documentation

◆ degrees()

template<typename T >

T ecl::Angle< T, enable_if< is_float< T > >::type >::degrees ( )

Returns the value of the angle in unit degrees.

This does not change the internal formatting for the angle (which is in radians). It simply returns its equivalent in unit degrees. The returned value will be wrapped on [-180, 180].

Returns: T : the angle in degrees.

◆ Degrees()

template<typename T >

static Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::Degrees ( const T & angle )

static

Generates an angle instance from an angle in degrees.

Generates an angle specified in degrees as a double to a fully constructed Angle instance.

Angle angle = Angle::Degrees(45);

Parameters

angle : the angle (degrees).

Returns: Angle : the constructed instance.

◆ operator const T &()

template<typename T >

ecl::Angle< T, enable_if< is_float< T > >::type >::operator const T & ( ) const

inline

Convenient equivalence to the c/c++ float type.

Allows for easy manipulation, especially within calculations. This breaks the rule which dictates that we should never use them as they create uncertainty about an object. Here it's just ridiculously convenient and more to the point, intuitive, so we do so.

Definition at line 270 of file angle.hpp.

◆ operator*()

template<typename T >

Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::operator* ( const T & scalar ) const

Multiplier.

Note this also ensures the angle is wrapped.

Parameters

scalar : scalar multipler to apply.

Returns: Angle : the wrapped angle instance.

◆ operator*=()

template<typename T >

void ecl::Angle< T, enable_if< is_float< T > >::type >::operator*= ( const T & scalar )

Multiplier that works on this instance.

Note this also ensures the angle is wrapped.

Parameters

scalar : scalar multipler to apply.

◆ operator+() [1/2]

template<typename T >

Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::operator+ ( const T & angle ) const

Sum operator.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to add (radians).

Returns: Angle : the wrapped angle instance.

◆ operator+() [2/2]

template<typename T >

Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::operator+ ( const Angle< T > & angle ) const

Sum operator.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to add (radians).

Returns: Angle : the wrapped angle instance.

◆ operator+=() [1/2]

template<typename T >

void ecl::Angle< T, enable_if< is_float< T > >::type >::operator+= ( const T & angle )

Sum operator that works on this instance.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to add (radians).

◆ operator+=() [2/2]

template<typename T >

void ecl::Angle< T, enable_if< is_float< T > >::type >::operator+= ( const Angle< T > & angle )

Sum operator that works on this instance.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to add (radians).

◆ operator-() [1/2]

template<typename T >

Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::operator- ( const T & angle ) const

Difference operator.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to subtract (radians).

Returns: Angle : the wrapped angle instance.

◆ operator-() [2/2]

template<typename T >

Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::operator- ( const Angle< T > & angle ) const

Difference operator.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to subtract (radians).

Returns: Angle : the wrapped angle instance.

◆ operator-=() [1/2]

template<typename T >

void ecl::Angle< T, enable_if< is_float< T > >::type >::operator-= ( const T & angle )

Difference operator that works on this instance.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to subtract (radians).

◆ operator-=() [2/2]

template<typename T >

void ecl::Angle< T, enable_if< is_float< T > >::type >::operator-= ( const Angle< T > & angle )

Difference operator that works on this instance.

Note this also ensures the angle is wrapped.

Parameters

angle : angle to subtract (radians).

◆ operator=()

template<typename T >

const Angle<T>& ecl::Angle< T, enable_if< is_float< T > >::type >::operator= ( const T & angle )

Allow assignment from float types.

This allows convenient assignment from float types. It does automatic wrapping on the input value.

Parameters

angle : input angle (radians).

Returns: Angle : the wrapped angle instance.

◆ Radians()

template<typename T >

static Angle<T> ecl::Angle< T, enable_if< is_float< T > >::type >::Radians ( const T & angle )

static

Generates an angle instance from an angle in radians.

Generates an angle specified in radians as a double to a fully constructed Angle instance.

Angle angle = Angle::Radians(ecl::math::pi);

Parameters

angle : the angle (radians).

Returns: Angle : the constructed instance.

◆ rotationMatrix()

template<typename T >

RotationMatrix ecl::Angle< T, enable_if< is_float< T > >::type >::rotationMatrix ( ) const

inline

Convert to a 2x2 rotation matrix.

Returns: RotationMatrix : representation as a 2x2 rotation matrix.

Definition at line 287 of file angle.hpp.

Member Data Documentation

◆ value

template<typename T >

T ecl::Angle< T, enable_if< is_float< T > >::type >::value

private

Definition at line 323 of file angle.hpp.

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

angle.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<typename T> class ecl::Angle< T, enable_if< is_float< T > >::type >

Member Typedef Documentation

◆ RotationMatrix

Constructor & Destructor Documentation

◆ Angle() [1/2]

◆ Angle() [2/2]

Member Function Documentation

◆ degrees()

◆ Degrees()

◆ operator const T &()

◆ operator*()

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator=()

◆ Radians()

◆ rotationMatrix()

Member Data Documentation

◆ value

template<typename T>
class ecl::Angle< T, enable_if< is_float< T > >::type >