Public Types | Public Member Functions | Protected Types
TwistBase< Derived > Class Template Reference

Base class describing a Twist. More...

#include <Twist.h>

Inheritance diagram for TwistBase< Derived >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef LieAlgebra< Matrix
< Scalar, 3, 1 > > 
AngularVelocity
typedef Base::BaseType BaseType
typedef internal::traits
< Derived >::Coefficients 
Coefficients
typedef Matrix< Scalar, 3, 1 > LinearVelocity

Public Member Functions

template<class RotationDerived >
Twist< Scalar > changeFrame (const LieGroupBase< Quaternion< Scalar >, RotationDerived > &) const
template<class OtherDerived >
Twist< Scalar > changePoint (const MatrixBase< OtherDerived > &point) const
Map< AngularVelocitygetAngularVelocity ()
Map< const AngularVelocitygetAngularVelocity () const
Map< LinearVelocitygetLinearVelocity ()
Map< const LinearVelocitygetLinearVelocity () const
Scalar rx () const
Scalar & rx ()
Scalar ry () const
Scalar & ry ()
Scalar rz () const
Scalar & rz ()
Scalar vx () const
Scalar & vx ()
Scalar vy () const
Scalar & vy ()
Scalar vz () const
Scalar & vz ()

Protected Types

typedef LieAlgebraBase< Matrix
< typename internal::traits
< Derived >::Scalar, 6, 1 >
, Derived > 
Base

Detailed Description

template<class Derived>
class TwistBase< Derived >

Base class describing a Twist.

Template Parameters:
Derivedthe derived class holding the coefficients which are of type Matrix<Scalar, 6, 1> or Map<Matrix<Scalar, 6, 1> >

This class abstracts the underlying mathematical definition and add some accessors. A twist has two part, an angular velocity and a linear velocity. It uses an Matrix internally to store its coefficients.

Definition at line 35 of file Twist.h.


Member Typedef Documentation

template<class Derived>
typedef LieAlgebra<Matrix<Scalar, 3, 1> > TwistBase< Derived >::AngularVelocity

The type of the angular part

Definition at line 79 of file Twist.h.

template<class Derived>
typedef LieAlgebraBase<Matrix<typename internal::traits<Derived>::Scalar, 6, 1>, Derived> TwistBase< Derived >::Base [protected]
template<class Derived>
typedef Base::BaseType TwistBase< Derived >::BaseType

The wrapped class

Reimplemented from LieAlgebraBase< Matrix< internal::traits< Derived >::Scalar, 6, 1 >, Derived >.

Reimplemented in Twist< _Scalar >.

Definition at line 46 of file Twist.h.

template<class Derived>
typedef internal::traits<Derived>::Coefficients TwistBase< Derived >::Coefficients

The kind of stored coefficients

Reimplemented from LieAlgebraBase< Matrix< internal::traits< Derived >::Scalar, 6, 1 >, Derived >.

Reimplemented in Map< Twist< _Scalar >, MapOptions, StrideType >, and Twist< _Scalar >.

Definition at line 48 of file Twist.h.

template<class Derived>
typedef Matrix<Scalar, 3, 1> TwistBase< Derived >::LinearVelocity

The type of the linear part

Definition at line 77 of file Twist.h.


Member Function Documentation

template<class Derived >
template<class RotationDerived >
Twist< typename internal::traits< TwistBase< Derived > >::Scalar > TwistBase< Derived >::changeFrame ( const LieGroupBase< Quaternion< Scalar >, RotationDerived > &  rot) const [inline]

Definition at line 98 of file Twist.h.

template<class Derived >
template<class OtherDerived >
Twist< typename internal::traits< TwistBase< Derived > >::Scalar > TwistBase< Derived >::changePoint ( const MatrixBase< OtherDerived > &  point) const [inline]

Definition at line 105 of file Twist.h.

template<class Derived>
Map<AngularVelocity> TwistBase< Derived >::getAngularVelocity ( ) [inline]

The accessor to the angular velocity

Definition at line 82 of file Twist.h.

template<class Derived>
Map<const AngularVelocity> TwistBase< Derived >::getAngularVelocity ( ) const [inline]

The read-only accessor to the angular velocity

Definition at line 84 of file Twist.h.

template<class Derived>
Map<LinearVelocity> TwistBase< Derived >::getLinearVelocity ( ) [inline]

The accessor to the linear velocity

Definition at line 86 of file Twist.h.

template<class Derived>
Map<const LinearVelocity> TwistBase< Derived >::getLinearVelocity ( ) const [inline]

The read-only accessor to the angular velocity

Definition at line 88 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::rx ( ) const [inline]
Returns:
the rx coefficient

Definition at line 51 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::rx ( ) [inline]
Returns:
a reference to the rx coefficient

Definition at line 64 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::ry ( ) const [inline]
Returns:
the ry coefficient

Definition at line 53 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::ry ( ) [inline]
Returns:
a reference to the ry coefficient

Definition at line 66 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::rz ( ) const [inline]
Returns:
the rz coefficient

Definition at line 55 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::rz ( ) [inline]
Returns:
a reference to the rz coefficient

Definition at line 68 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::vx ( ) const [inline]
Returns:
the vx coefficient

Definition at line 57 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::vx ( ) [inline]
Returns:
a reference to the vx coefficient

Definition at line 70 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::vy ( ) const [inline]
Returns:
the vy coefficient

Definition at line 59 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::vy ( ) [inline]
Returns:
a reference to the vy coefficient

Definition at line 72 of file Twist.h.

template<class Derived>
Scalar TwistBase< Derived >::vz ( ) const [inline]
Returns:
the vz coefficient

Definition at line 61 of file Twist.h.

template<class Derived>
Scalar& TwistBase< Derived >::vz ( ) [inline]
Returns:
a reference to the vz coefficient

Definition at line 74 of file Twist.h.


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


lgsm
Author(s): Roberto Martín-Martín
autogenerated on Sat Jun 8 2019 18:26:30