Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pinocchio::TransformHelicalTpl< _Scalar, _Options, axis > Struct Template Reference

#include <joint-helical.hpp>

Public Types

typedef SpatialAxis< axis+LINEAR > AxisLinear
 
typedef AxisLinear::CartesianAxis3 CartesianAxis3Linear
 

Public Member Functions

Scalar & cos ()
 
const Scalar & cos () const
 
Scalar & displacement ()
 
const Scalar & displacement () const
 
bool isEqual (const TransformHelicalTpl &other) const
 
 operator PlainType () const
 
EIGEN_MAKE_ALIGNED_OPERATOR_NEW PINOCCHIO_SE3_TYPEDEF_TPL (TransformHelicalTpl)
 
PlainType plain () const
 
AngularType rotation () const
 
template<typename S2 , int O2>
SE3GroupAction< TransformHelicalTpl >::ReturnType se3action (const SE3Tpl< S2, O2 > &m) const
 
template<typename Scalar1 , typename Scalar2 , typename Scalar3 >
void setValues (const Scalar1 &sin, const Scalar2 &cos, const Scalar3 &displacement)
 
Scalar & sin ()
 
const Scalar & sin () const
 
 TransformHelicalTpl ()
 
 TransformHelicalTpl (const Scalar &sin, const Scalar &cos, const Scalar &displacement)
 
LinearType translation () const
 

Protected Member Functions

void _setRotation (typename PlainType::AngularRef &rot) const
 

Protected Attributes

Scalar m_cos
 
Scalar m_displacement
 
Scalar m_sin
 

Detailed Description

template<typename _Scalar, int _Options, int axis>
struct pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >

Definition at line 63 of file joint-helical.hpp.

Member Typedef Documentation

◆ AxisLinear

template<typename _Scalar , int _Options, int axis>
typedef SpatialAxis<axis + LINEAR> pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::AxisLinear

Definition at line 101 of file joint-helical.hpp.

◆ CartesianAxis3Linear

template<typename _Scalar , int _Options, int axis>
typedef AxisLinear::CartesianAxis3 pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::CartesianAxis3Linear

Definition at line 102 of file joint-helical.hpp.

Constructor & Destructor Documentation

◆ TransformHelicalTpl() [1/2]

template<typename _Scalar , int _Options, int axis>
pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::TransformHelicalTpl ( )
inline

Definition at line 104 of file joint-helical.hpp.

◆ TransformHelicalTpl() [2/2]

template<typename _Scalar , int _Options, int axis>
pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::TransformHelicalTpl ( const Scalar &  sin,
const Scalar &  cos,
const Scalar &  displacement 
)
inline

Definition at line 107 of file joint-helical.hpp.

Member Function Documentation

◆ _setRotation()

template<typename _Scalar , int _Options, int axis>
void pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::_setRotation ( typename PlainType::AngularRef &  rot) const
inlineprotected

Definition at line 218 of file joint-helical.hpp.

◆ cos() [1/2]

template<typename _Scalar , int _Options, int axis>
Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::cos ( )
inline

Definition at line 176 of file joint-helical.hpp.

◆ cos() [2/2]

template<typename _Scalar , int _Options, int axis>
const Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::cos ( ) const
inline

Definition at line 172 of file joint-helical.hpp.

◆ displacement() [1/2]

template<typename _Scalar , int _Options, int axis>
Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::displacement ( )
inline

Definition at line 185 of file joint-helical.hpp.

◆ displacement() [2/2]

template<typename _Scalar , int _Options, int axis>
const Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::displacement ( ) const
inline

Definition at line 181 of file joint-helical.hpp.

◆ isEqual()

template<typename _Scalar , int _Options, int axis>
bool pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::isEqual ( const TransformHelicalTpl< _Scalar, _Options, axis > &  other) const
inline

Definition at line 209 of file joint-helical.hpp.

◆ operator PlainType()

template<typename _Scalar , int _Options, int axis>
pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::operator PlainType ( ) const
inline

Definition at line 122 of file joint-helical.hpp.

◆ PINOCCHIO_SE3_TYPEDEF_TPL()

template<typename _Scalar , int _Options, int axis>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::PINOCCHIO_SE3_TYPEDEF_TPL ( TransformHelicalTpl< _Scalar, _Options, axis >  )

◆ plain()

template<typename _Scalar , int _Options, int axis>
PlainType pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::plain ( ) const
inline

Definition at line 114 of file joint-helical.hpp.

◆ rotation()

template<typename _Scalar , int _Options, int axis>
AngularType pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::rotation ( ) const
inline

Definition at line 202 of file joint-helical.hpp.

◆ se3action()

template<typename _Scalar , int _Options, int axis>
template<typename S2 , int O2>
SE3GroupAction<TransformHelicalTpl>::ReturnType pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::se3action ( const SE3Tpl< S2, O2 > &  m) const
inline

Definition at line 129 of file joint-helical.hpp.

◆ setValues()

template<typename _Scalar , int _Options, int axis>
template<typename Scalar1 , typename Scalar2 , typename Scalar3 >
void pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::setValues ( const Scalar1 &  sin,
const Scalar2 &  cos,
const Scalar3 &  displacement 
)
inline

Definition at line 191 of file joint-helical.hpp.

◆ sin() [1/2]

template<typename _Scalar , int _Options, int axis>
Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::sin ( )
inline

Definition at line 167 of file joint-helical.hpp.

◆ sin() [2/2]

template<typename _Scalar , int _Options, int axis>
const Scalar& pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::sin ( ) const
inline

Definition at line 163 of file joint-helical.hpp.

◆ translation()

template<typename _Scalar , int _Options, int axis>
LinearType pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::translation ( ) const
inline

Definition at line 198 of file joint-helical.hpp.

Member Data Documentation

◆ m_cos

template<typename _Scalar , int _Options, int axis>
Scalar pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::m_cos
protected

Definition at line 217 of file joint-helical.hpp.

◆ m_displacement

template<typename _Scalar , int _Options, int axis>
Scalar pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::m_displacement
protected

Definition at line 217 of file joint-helical.hpp.

◆ m_sin

template<typename _Scalar , int _Options, int axis>
Scalar pinocchio::TransformHelicalTpl< _Scalar, _Options, axis >::m_sin
protected

Definition at line 217 of file joint-helical.hpp.

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

pinocchio
Author(s):
autogenerated on Wed May 28 2025 02:41:25