_Angle< Base > Struct Template Reference

#include <angle.h>

List of all members.

Public Types
typedef Base	BaseType
typedef Base	BaseType
Public Member Functions
	_Angle (Base a=Base(0.))
	_Angle (Base a=Base(0.))
	_Angle (const _Vector< 1, Base > &a)
	_Angle (const _Vector< 1, Base > &a)
void	_normalize ()
void	_normalize ()
Base	angle () const
Base	angle () const
_Vector< 1, Base >	angles () const
_Vector< 1, Base >	angles () const
_Angle< Base >	inverse () const
_Angle< Base >	inverse () const
	operator Base () const
	operator Base () const
_Angle< Base >	operator* (const _Angle< Base > &a) const
_Angle< Base >	operator* (const _Angle< Base > &a) const
_Vector< 2, Base >	operator* (const _Vector< 2, Base > &v) const
_Vector< 2, Base >	operator* (const _Vector< 2, Base > &v) const
_Angle< Base > &	operator*= (const _Angle< Base > &a)
_Angle< Base > &	operator*= (const _Angle< Base > &a)
_RotationMatrix2< Base >	rotationMatrix () const
_RotationMatrix2< Base >	rotationMatrix () const
Public Attributes
Base	_angle
Static Public Attributes
static const int	Angles = 1
static const int	Dimension = 2

---

Detailed Description

template<typename Base = double>
struct _Angle< Base >

simple class that implements the SO2 rotation group parametrized with a scalar. Rotations have a * operator whih represents the composition of rotations, and an inverse operator which computes the inverse rotation. Multiplying a rotation by a vector returns the rotated vector.

Definition at line 30 of file include/hogman_minimal/math/angle.h.

---

Member Typedef Documentation

template<typename Base = double>

typedef Base _Angle< Base >::BaseType

Definition at line 33 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

typedef Base _Angle< Base >::BaseType

Definition at line 33 of file src/math/angle.h.

---

Constructor & Destructor Documentation

template<typename Base = double>

_Angle< Base >::_Angle

(

Base

a = Base(0.)

)

[inline]

constructs a rotation of a radians

Definition at line 35 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle< Base >::_Angle

(

const _Vector< 1, Base > &

a

)

[inline]

constructs a rotation of v[0] radians

Definition at line 41 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle< Base >::_Angle

(

Base

a = Base(0.)

)

[inline]

constructs a rotation of a radians

Definition at line 35 of file src/math/angle.h.

template<typename Base = double>

_Angle< Base >::_Angle

(

const _Vector< 1, Base > &

a

)

[inline]

constructs a rotation of v[0] radians

Definition at line 41 of file src/math/angle.h.

---

Member Function Documentation

template<typename Base = double>

void _Angle< Base >::_normalize

(

)

[inline]

Definition at line 83 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

void _Angle< Base >::_normalize

(

)

[inline]

Definition at line 83 of file src/math/angle.h.

template<typename Base = double>

Base _Angle< Base >::angle

(

)

const [inline]

returns the angle of the rotation

Definition at line 75 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

Base _Angle< Base >::angle

(

)

const [inline]

returns the angle of the rotation

Definition at line 75 of file src/math/angle.h.

template<typename Base = double>

_Vector<1, Base> _Angle< Base >::angles

(

)

const [inline]

returns the angles of the rotation in a vector. It is provided to make an homogeneous interface with the n dimensional rotations

Definition at line 80 of file src/math/angle.h.

template<typename Base = double>

_Vector<1, Base> _Angle< Base >::angles

(

)

const [inline]

returns the angles of the rotation in a vector. It is provided to make an homogeneous interface with the n dimensional rotations

Definition at line 80 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle<Base> _Angle< Base >::inverse

(

)

const [inline]

inverts a rotation

Definition at line 65 of file src/math/angle.h.

template<typename Base = double>

_Angle<Base> _Angle< Base >::inverse

(

)

const [inline]

inverts a rotation

Definition at line 65 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle< Base >::operator Base

(

)

const [inline]

this allows an angle to be casted to a double

Definition at line 91 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle< Base >::operator Base

(

)

const [inline]

this allows an angle to be casted to a double

Definition at line 91 of file src/math/angle.h.

template<typename Base = double>

_Angle<Base> _Angle< Base >::operator*

(

const _Angle< Base > &

a

)

const [inline]

returns the rotation which result by composing this ad

Parameters:

a.	In 2d this is the sum of the angles

Definition at line 48 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle<Base> _Angle< Base >::operator*

(

const _Angle< Base > &

a

)

const [inline]

returns the rotation which result by composing this ad

Parameters:

a.	In 2d this is the sum of the angles

Definition at line 48 of file src/math/angle.h.

template<typename Base = double>

_Vector<2,Base> _Angle< Base >::operator*

(

const _Vector< 2, Base > &

v

)

const [inline]

applies a rotation to a vector

Definition at line 60 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Vector<2,Base> _Angle< Base >::operator*

(

const _Vector< 2, Base > &

v

)

const [inline]

applies a rotation to a vector

Definition at line 60 of file src/math/angle.h.

template<typename Base = double>

_Angle<Base>& _Angle< Base >::operator*=

(

const _Angle< Base > &

a

)

[inline]

accumulates a rotation

Definition at line 53 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

_Angle<Base>& _Angle< Base >::operator*=

(

const _Angle< Base > &

a

)

[inline]

accumulates a rotation

Definition at line 53 of file src/math/angle.h.

template<typename Base = double>

_RotationMatrix2<Base> _Angle< Base >::rotationMatrix

(

)

const [inline]

returns the rotation matrix

Definition at line 70 of file src/math/angle.h.

template<typename Base = double>

_RotationMatrix2<Base> _Angle< Base >::rotationMatrix

(

)

const [inline]

returns the rotation matrix

Definition at line 70 of file include/hogman_minimal/math/angle.h.

---

Member Data Documentation

template<typename Base = double>

Base _Angle< Base >::_angle

Definition at line 82 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

static const int _Angle< Base >::Angles = 1 [static]

Definition at line 32 of file include/hogman_minimal/math/angle.h.

template<typename Base = double>

static const int _Angle< Base >::Dimension = 2 [static]

Definition at line 31 of file include/hogman_minimal/math/angle.h.

---

The documentation for this struct was generated from the following files:

• include/hogman_minimal/math/angle.h
• src/math/angle.h