The blo Library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
blo::AngleAxis3D< T > Class Template Reference

Angle-axis representation of 3D rotation. More...

#include <AngleAxis3D.h>

Public Member Functions

 AngleAxis3D ()=default
 Default constructor.
 
 AngleAxis3D (const SmallMatrix< T, 3, 1 > &omega)
 Constructs angle-axis representation of 3D rotation.
 
 AngleAxis3D (const T &theta, const SmallMatrix< T, 3, 1 > &v)
 Constructs angle-axis representation of 3D rotation from rotation angle and axis that rotation is about.
 
 AngleAxis3D (const AngleAxis3D< T > &rhs)
 Copy constructor.
 
virtual ~AngleAxis3D ()=default
 Destructor.
 
AngleAxis3D< T > & operator= (const AngleAxis3D< T > &rhs)
 Assignment operator.
 
void set (const SmallMatrix< T, 3, 1 > &omega)
 Sets angle-axis parameters.
 
void set (const T &theta, const SmallMatrix< T, 3, 1 > &v)
 Sets angle-axis parameters.
 
const SmallMatrix< T, 3, 1 > asVector () const
 Angle-axis representation of 3D rotation as vector.
 
const T angle () const
 Angle of rotation.
 
const SmallMatrix< T, 3, 1 > axis () const
 Axis of rotation.
 

Detailed Description

template<typename T>
class blo::AngleAxis3D< T >

Angle-axis representation of 3D rotation.

Template Parameters
TData type.

Constructor & Destructor Documentation

◆ AngleAxis3D() [1/4]

template<typename T >
blo::AngleAxis3D< T >::AngleAxis3D ( )
default

Default constructor.

◆ AngleAxis3D() [2/4]

template<typename T >
blo::AngleAxis3D< T >::AngleAxis3D ( const SmallMatrix< T, 3, 1 > &  omega)
explicit

Constructs angle-axis representation of 3D rotation.

Parameters
omegaAngle-axis representation of 3D rotation as a vector.

◆ AngleAxis3D() [3/4]

template<typename T >
blo::AngleAxis3D< T >::AngleAxis3D ( const T &  theta,
const SmallMatrix< T, 3, 1 > &  v 
)

Constructs angle-axis representation of 3D rotation from rotation angle and axis that rotation is about.

Rotation through an angle theta about the axis represented by the vector v.

Parameters
thetaAngle of rotation in radians.
vVector representing the axis of rotation.

◆ AngleAxis3D() [4/4]

template<typename T >
blo::AngleAxis3D< T >::AngleAxis3D ( const AngleAxis3D< T > &  rhs)

Copy constructor.

◆ ~AngleAxis3D()

template<typename T >
virtual blo::AngleAxis3D< T >::~AngleAxis3D ( )
virtualdefault

Destructor.

Member Function Documentation

◆ angle()

template<typename T >
const T blo::AngleAxis3D< T >::angle ( ) const

Angle of rotation.

Returns
Angle of rotation in radians.

◆ asVector()

template<typename T >
const SmallMatrix< T, 3, 1 > blo::AngleAxis3D< T >::asVector ( ) const

Angle-axis representation of 3D rotation as vector.

Returns
Angle-axis representation of 3D rotation as vector.

◆ axis()

template<typename T >
const SmallMatrix< T, 3, 1 > blo::AngleAxis3D< T >::axis ( ) const

Axis of rotation.

Returns
Unit vector representing the axis of rotation.

◆ operator=()

template<typename T >
AngleAxis3D< T > & blo::AngleAxis3D< T >::operator= ( const AngleAxis3D< T > &  rhs)

Assignment operator.

◆ set() [1/2]

template<typename T >
void blo::AngleAxis3D< T >::set ( const SmallMatrix< T, 3, 1 > &  omega)

Sets angle-axis parameters.

Parameters
omegaAngle-axis representation of 3D rotation as a vector.

◆ set() [2/2]

template<typename T >
void blo::AngleAxis3D< T >::set ( const T &  theta,
const SmallMatrix< T, 3, 1 > &  v 
)

Sets angle-axis parameters.

Rotation through an angle theta about the axis represented by the vector v.

Parameters
thetaAngle of rotation in radians.
vVector representing the axis of rotation.

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