Milena (Olena)  User documentation 2.0a Id
mln::fun::x2x::rotation< n, C > Struct Template Reference

Represent a rotation function. More...

#include <rotation.hh>

Inheritance diagram for mln::fun::x2x::rotation< n, C >:
Inheritance graph

List of all members.

Public Types

typedef C data_t
 Type of the underlying data stored in vectors and matrices.
typedef rotation< n, C > invert
 Type of the inverse function.

Public Member Functions

invert inv () const
 Return the inverse function.
algebra::vec< n, C > operator() (const algebra::vec< n, C > &v) const
 Perform the rotation of the given vector.
 rotation ()
 Constructor without argument.
 rotation (C alpha, const algebra::vec< n, C > &axis)
 Constructor with radian alpha and a facultative direction (rotation axis).
 rotation (const algebra::quat &q)
 Constructor with quaternion.
 rotation (const algebra::h_mat< n, C > &m)
 Constructor with h_mat.
void set_alpha (C alpha)
 Set a new grade alpha.
void set_axis (const algebra::vec< n, C > &axis)
 Set a new rotation axis.

Detailed Description

template<unsigned n, typename C>
struct mln::fun::x2x::rotation< n, C >

Represent a rotation function.

Definition at line 150 of file rotation.hh.


Member Typedef Documentation

template<unsigned n, typename C>
typedef C mln::fun::x2x::rotation< n, C >::data_t

Type of the underlying data stored in vectors and matrices.

Definition at line 155 of file rotation.hh.

template<unsigned n, typename C>
typedef rotation<n,C> mln::fun::x2x::rotation< n, C >::invert

Type of the inverse function.

Definition at line 158 of file rotation.hh.


Constructor & Destructor Documentation

template<unsigned n, typename C >
mln::fun::x2x::rotation< n, C >::rotation ( ) [inline]

Constructor without argument.

Definition at line 195 of file rotation.hh.

template<unsigned n, typename C >
mln::fun::x2x::rotation< n, C >::rotation ( alpha,
const algebra::vec< n, C > &  axis 
) [inline]

Constructor with radian alpha and a facultative direction (rotation axis).

Definition at line 201 of file rotation.hh.

template<unsigned n, typename C >
mln::fun::x2x::rotation< n, C >::rotation ( const algebra::quat &  q) [inline]

Constructor with quaternion.

Definition at line 211 of file rotation.hh.

References mln::make::h_mat().

template<unsigned n, typename C >
mln::fun::x2x::rotation< n, C >::rotation ( const algebra::h_mat< n, C > &  m) [inline]

Constructor with h_mat.

Definition at line 241 of file rotation.hh.


Member Function Documentation

template<unsigned n, typename C >
rotation< n, C > mln::fun::x2x::rotation< n, C >::inv ( ) const [inline]

Return the inverse function.

Definition at line 268 of file rotation.hh.

template<unsigned n, typename C >
algebra::vec< n, C > mln::fun::x2x::rotation< n, C >::operator() ( const algebra::vec< n, C > &  v) const [inline]

Perform the rotation of the given vector.

Definition at line 250 of file rotation.hh.

template<unsigned n, typename C >
void mln::fun::x2x::rotation< n, C >::set_alpha ( alpha) [inline]

Set a new grade alpha.

Definition at line 277 of file rotation.hh.

template<unsigned n, typename C >
void mln::fun::x2x::rotation< n, C >::set_axis ( const algebra::vec< n, C > &  axis) [inline]

Set a new rotation axis.

Definition at line 286 of file rotation.hh.

 All Classes Namespaces Functions Variables Typedefs Enumerator