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

Twist representation of 3D Euclidean transformation. More...

#include <Twist3D.h>

Public Member Functions

 Twist3D ()=default
 Default constructor.
 
 Twist3D (const SmallMatrix< T, 6, 1 > &xi)
 Constructs twist representation of 3D Euclidean transformation.
 
 Twist3D (const Twist3D< T > &rhs)
 Copy constructor.
 
virtual ~Twist3D ()=default
 Destructor.
 
Twist3D< T > & operator= (const Twist3D< T > &rhs)
 Assignment operator.
 
void set (const SmallMatrix< T, 6, 1 > &xi)
 Sets twist parameters.
 
const SmallMatrix< T, 6, 1 > asVector () const
 Twist representation of 3D Euclidean transformation as vector.
 
const T magnitude () const
 Magnitude of transformation.
 
const SmallMatrix< T, 3, 1 > axisDirection () const
 Axis direction of transformation.
 

Detailed Description

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

Twist representation of 3D Euclidean transformation.

Template Parameters
TData type.

Constructor & Destructor Documentation

◆ Twist3D() [1/3]

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

Default constructor.

◆ Twist3D() [2/3]

template<typename T >
blo::Twist3D< T >::Twist3D ( const SmallMatrix< T, 6, 1 > &  xi)
explicit

Constructs twist representation of 3D Euclidean transformation.

Parameters
xiTwist representation of 3D Euclidean transformation as a vector.

◆ Twist3D() [3/3]

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

Copy constructor.

◆ ~Twist3D()

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

Destructor.

Member Function Documentation

◆ asVector()

template<typename T >
const SmallMatrix< T, 6, 1 > blo::Twist3D< T >::asVector ( ) const

Twist representation of 3D Euclidean transformation as vector.

Returns
Twist representation of 3D Euclidean transformation as vector.

◆ axisDirection()

template<typename T >
const SmallMatrix< T, 3, 1 > blo::Twist3D< T >::axisDirection ( ) const

Axis direction of transformation.

Returns
Unit vector representing the axis direction of transformation.

◆ magnitude()

template<typename T >
const T blo::Twist3D< T >::magnitude ( ) const

Magnitude of transformation.

Returns
Magnitude of transformation.

◆ operator=()

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

Assignment operator.

◆ set()

template<typename T >
void blo::Twist3D< T >::set ( const SmallMatrix< T, 6, 1 > &  xi)

Sets twist parameters.

Parameters
xiTwist representation of 3D Euclidean transformation as a vector.

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