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

#include <fwd.hpp>

Public Types

enum  { MaxNVMimicked = traits<JointDerived>::MaxNVMimicked }
 
typedef InertiaTpl< Scalar, OptionsInertia
 
typedef JointCollectionTpl< Scalar, OptionsJointCollection
 
typedef JointMimicTpl< _Scalar, _Options, JointCollectionTpl > JointDerived
 
typedef JointModelTpl< Scalar, Options, JointCollectionTpl > JointModel
 
typedef MotionTpl< Scalar, OptionsMotion
 
typedef SE3Tpl< Scalar, OptionsSE3
 

Public Member Functions

Basebase ()
 
const Basebase () const
 
template<typename ConfigVector >
PINOCCHIO_DONT_INLINE void calc (JointDataDerived &jdata, const typename Eigen::MatrixBase< ConfigVector > &qs) const
 
template<typename ConfigVector , typename TangentVector >
PINOCCHIO_DONT_INLINE void calc (JointDataDerived &jdata, const typename Eigen::MatrixBase< ConfigVector > &qs, const typename Eigen::MatrixBase< TangentVector > &vs) const
 
template<typename VectorLike , typename Matrix6Like >
void calc_aba (JointDataDerived &, const Eigen::MatrixBase< VectorLike > &, const Eigen::MatrixBase< Matrix6Like > &, const bool) const
 
template<typename NewScalar >
CastType< NewScalar, JointModelMimicTpl >::type cast () const
 
JointDataDerived createData () const
 
void disp (std::ostream &os) const
 
const std::vector< bool > hasConfigurationLimit () const
 
const std::vector< bool > hasConfigurationLimitInTangent () const
 
JointModeljmodel ()
 
const JointModeljmodel () const
 
template<typename D >
SizeDepType< NV >::template BlockReturn< D >::ConstType jointBlock_impl (const Eigen::MatrixBase< D > &Mat) const
 
template<typename D >
SizeDepType< NV >::template BlockReturn< D >::Type jointBlock_impl (Eigen::MatrixBase< D > &Mat) const
 
template<typename D >
SizeDepType< NV >::template ColsReturn< D >::ConstType jointCols_impl (const Eigen::MatrixBase< D > &A) const
 
template<typename D >
SizeDepType< NV >::template ColsReturn< D >::Type jointCols_impl (Eigen::MatrixBase< D > &A) const
 
template<typename D >
SizeDepType< NQ >::template SegmentReturn< D >::ConstType JointMappedConfigSelector_impl (const Eigen::MatrixBase< D > &a) const
 
template<typename D >
SizeDepType< NQ >::template SegmentReturn< D >::Type JointMappedConfigSelector_impl (Eigen::MatrixBase< D > &a) const
 
template<typename D >
SizeDepType< NQ >::template SegmentReturn< D >::ConstType JointMappedVelocitySelector_impl (const Eigen::MatrixBase< D > &a) const
 
template<typename D >
SizeDepType< NQ >::template SegmentReturn< D >::Type JointMappedVelocitySelector_impl (Eigen::MatrixBase< D > &a) const
 
 JointModelMimicTpl ()
 
template<typename JointModel >
 JointModelMimicTpl (const JointModelBase< JointModel > &jmodel, const Scalar &scaling, const Scalar &offset)
 
template<typename JointModelMimicking , typename JointModelMimicked >
 JointModelMimicTpl (const JointModelBase< JointModelMimicking > &jmodel_mimicking, const JointModelBase< JointModelMimicked > &jmodel_mimicked, const Scalar &scaling, const Scalar &offset)
 
template<typename D >
SizeDepType< NV >::template RowsReturn< D >::ConstType jointRows_impl (const Eigen::MatrixBase< D > &A) const
 
template<typename D >
SizeDepType< NV >::template RowsReturn< D >::Type jointRows_impl (Eigen::MatrixBase< D > &A) const
 
int nq_impl () const
 
int nv_impl () const
 
int nvExtended_impl () const
 
Scalaroffset ()
 
const Scalaroffset () const
 
 PINOCCHIO_JOINT_TYPEDEF_TEMPLATE (JointDerived)
 
Scalarscaling ()
 
const Scalarscaling () const
 
void setIndexes_impl (JointIndex id, int, int, int vExtended)
 
void setMimicIndexes (JointIndex id, int q, int v, int vExtended)
 Specific way for mimic joints to set the mimicked q,v indexes. Used for manipulating tree (e.g. appendModel) More...
 
std::string shortname () const
 

Static Public Member Functions

static std::string classname ()
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef JointModelBase< JointModelMimicTplBase
 

Protected Attributes

JointModel m_jmodel_mimicking
 
int m_nqExtended
 
int m_nvExtended
 
Scalar m_offset
 
Scalar m_scaling
 

Detailed Description

template<typename _Scalar, int _Options, template< typename S, int O > class JointCollectionTpl>
struct pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >

Definition at line 155 of file multibody/joint/fwd.hpp.

Member Typedef Documentation

◆ Inertia

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef InertiaTpl<Scalar, Options> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::Inertia

Definition at line 575 of file joint-mimic.hpp.

◆ JointCollection

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef JointCollectionTpl<Scalar, Options> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointCollection

Definition at line 570 of file joint-mimic.hpp.

◆ JointDerived

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef JointMimicTpl<_Scalar, _Options, JointCollectionTpl> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointDerived

Definition at line 563 of file joint-mimic.hpp.

◆ JointModel

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef JointModelTpl<Scalar, Options, JointCollectionTpl> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointModel

Definition at line 571 of file joint-mimic.hpp.

◆ Motion

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef MotionTpl<Scalar, Options> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::Motion

Definition at line 574 of file joint-mimic.hpp.

◆ SE3

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
typedef SE3Tpl<Scalar, Options> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::SE3

Definition at line 573 of file joint-mimic.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
anonymous enum
Enumerator
MaxNVMimicked 

Definition at line 565 of file joint-mimic.hpp.

Constructor & Destructor Documentation

◆ JointModelMimicTpl() [1/3]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointModelMimicTpl ( )
inline

Definition at line 586 of file joint-mimic.hpp.

◆ JointModelMimicTpl() [2/3]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename JointModel >
pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointModelMimicTpl ( const JointModelBase< JointModel > &  jmodel,
const Scalar scaling,
const Scalar offset 
)
inline

Definition at line 591 of file joint-mimic.hpp.

◆ JointModelMimicTpl() [3/3]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename JointModelMimicking , typename JointModelMimicked >
pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointModelMimicTpl ( const JointModelBase< JointModelMimicking > &  jmodel_mimicking,
const JointModelBase< JointModelMimicked > &  jmodel_mimicked,
const Scalar scaling,
const Scalar offset 
)
inline

Definition at line 598 of file joint-mimic.hpp.

Member Function Documentation

◆ base() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
Base& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::base ( )
inline

Definition at line 618 of file joint-mimic.hpp.

◆ base() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const Base& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::base ( ) const
inline

Definition at line 622 of file joint-mimic.hpp.

◆ calc() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename ConfigVector >
PINOCCHIO_DONT_INLINE void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::calc ( JointDataDerived &  jdata,
const typename Eigen::MatrixBase< ConfigVector > &  qs 
) const
inline

Definition at line 694 of file joint-mimic.hpp.

◆ calc() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename ConfigVector , typename TangentVector >
PINOCCHIO_DONT_INLINE void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::calc ( JointDataDerived &  jdata,
const typename Eigen::MatrixBase< ConfigVector > &  qs,
const typename Eigen::MatrixBase< TangentVector > &  vs 
) const
inline

Definition at line 703 of file joint-mimic.hpp.

◆ calc_aba()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename VectorLike , typename Matrix6Like >
void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::calc_aba ( JointDataDerived &  ,
const Eigen::MatrixBase< VectorLike > &  ,
const Eigen::MatrixBase< Matrix6Like > &  ,
const bool   
) const
inline

Definition at line 719 of file joint-mimic.hpp.

◆ cast()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename NewScalar >
CastType<NewScalar, JointModelMimicTpl>::type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::cast ( ) const
inline
Returns
An expression of *this with the Scalar type casted to NewScalar.

Definition at line 743 of file joint-mimic.hpp.

◆ classname()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
static std::string pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::classname ( )
inlinestatic

Definition at line 731 of file joint-mimic.hpp.

◆ createData()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
JointDataDerived pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::createData ( ) const
inline

Definition at line 676 of file joint-mimic.hpp.

◆ disp()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::disp ( std::ostream &  os) const
inline

Definition at line 876 of file joint-mimic.hpp.

◆ hasConfigurationLimit()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const std::vector<bool> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::hasConfigurationLimit ( ) const
inline

Definition at line 682 of file joint-mimic.hpp.

◆ hasConfigurationLimitInTangent()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const std::vector<bool> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::hasConfigurationLimitInTangent ( ) const
inline

Definition at line 687 of file joint-mimic.hpp.

◆ jmodel() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
JointModel& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jmodel ( )
inline

Definition at line 759 of file joint-mimic.hpp.

◆ jmodel() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const JointModel& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jmodel ( ) const
inline

Definition at line 755 of file joint-mimic.hpp.

◆ jointBlock_impl() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template BlockReturn<D>::ConstType pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointBlock_impl ( const Eigen::MatrixBase< D > &  Mat) const
inline

Definition at line 861 of file joint-mimic.hpp.

◆ jointBlock_impl() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template BlockReturn<D>::Type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointBlock_impl ( Eigen::MatrixBase< D > &  Mat) const
inline

Definition at line 870 of file joint-mimic.hpp.

◆ jointCols_impl() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template ColsReturn<D>::ConstType pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointCols_impl ( const Eigen::MatrixBase< D > &  A) const
inline

Definition at line 826 of file joint-mimic.hpp.

◆ jointCols_impl() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template ColsReturn<D>::Type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointCols_impl ( Eigen::MatrixBase< D > &  A) const
inline

Definition at line 834 of file joint-mimic.hpp.

◆ JointMappedConfigSelector_impl() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NQ>::template SegmentReturn<D>::ConstType pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointMappedConfigSelector_impl ( const Eigen::MatrixBase< D > &  a) const
inline

Definition at line 793 of file joint-mimic.hpp.

◆ JointMappedConfigSelector_impl() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NQ>::template SegmentReturn<D>::Type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointMappedConfigSelector_impl ( Eigen::MatrixBase< D > &  a) const
inline

Definition at line 801 of file joint-mimic.hpp.

◆ JointMappedVelocitySelector_impl() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NQ>::template SegmentReturn<D>::ConstType pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointMappedVelocitySelector_impl ( const Eigen::MatrixBase< D > &  a) const
inline

Definition at line 809 of file joint-mimic.hpp.

◆ JointMappedVelocitySelector_impl() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NQ>::template SegmentReturn<D>::Type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::JointMappedVelocitySelector_impl ( Eigen::MatrixBase< D > &  a) const
inline

Definition at line 817 of file joint-mimic.hpp.

◆ jointRows_impl() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template RowsReturn<D>::ConstType pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointRows_impl ( const Eigen::MatrixBase< D > &  A) const
inline

Definition at line 843 of file joint-mimic.hpp.

◆ jointRows_impl() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
template<typename D >
SizeDepType<NV>::template RowsReturn<D>::Type pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::jointRows_impl ( Eigen::MatrixBase< D > &  A) const
inline

Definition at line 851 of file joint-mimic.hpp.

◆ nq_impl()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
int pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::nq_impl ( ) const
inline

Definition at line 627 of file joint-mimic.hpp.

◆ nv_impl()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
int pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::nv_impl ( ) const
inline

Definition at line 631 of file joint-mimic.hpp.

◆ nvExtended_impl()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
int pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::nvExtended_impl ( ) const
inline

Definition at line 635 of file joint-mimic.hpp.

◆ offset() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
Scalar& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::offset ( )
inline

Definition at line 777 of file joint-mimic.hpp.

◆ offset() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const Scalar& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::offset ( ) const
inline

Definition at line 773 of file joint-mimic.hpp.

◆ PINOCCHIO_JOINT_TYPEDEF_TEMPLATE()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::PINOCCHIO_JOINT_TYPEDEF_TEMPLATE ( JointDerived  )

◆ scaling() [1/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
Scalar& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::scaling ( )
inline

Definition at line 768 of file joint-mimic.hpp.

◆ scaling() [2/2]

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
const Scalar& pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::scaling ( ) const
inline

Definition at line 764 of file joint-mimic.hpp.

◆ setIndexes_impl()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::setIndexes_impl ( JointIndex  id,
int  ,
int  ,
int  vExtended 
)
inline
Note
q and v are ignored in the _impl for mimic joint because most algorithms will pass indexes of their current position in the tree, while in this case idx_q and idx_v should remain pointing to the mimicked joint. (See setMimicIndexes)

Definition at line 645 of file joint-mimic.hpp.

◆ setMimicIndexes()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
void pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::setMimicIndexes ( JointIndex  id,
int  q,
int  v,
int  vExtended 
)
inline

Specific way for mimic joints to set the mimicked q,v indexes. Used for manipulating tree (e.g. appendModel)

Parameters
idSet the mimicking joint id
qSet the mimic joint idx_q (should point to the mimicked joint)
vSet the mimic joint idx_v (should point to the mimicked joint)
vExtendedSet the mimicking idx_vExtended

Definition at line 665 of file joint-mimic.hpp.

◆ shortname()

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
std::string pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::shortname ( ) const
inline

Definition at line 736 of file joint-mimic.hpp.

Member Data Documentation

◆ Base

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef JointModelBase<JointModelMimicTpl> pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::Base

Definition at line 562 of file joint-mimic.hpp.

◆ m_jmodel_mimicking

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
JointModel pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::m_jmodel_mimicking
protected

Definition at line 784 of file joint-mimic.hpp.

◆ m_nqExtended

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
int pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::m_nqExtended
protected

Definition at line 786 of file joint-mimic.hpp.

◆ m_nvExtended

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
int pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::m_nvExtended
protected

Definition at line 786 of file joint-mimic.hpp.

◆ m_offset

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
Scalar pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::m_offset
protected

Definition at line 785 of file joint-mimic.hpp.

◆ m_scaling

template<typename _Scalar , int _Options, template< typename S, int O > class JointCollectionTpl>
Scalar pinocchio::JointModelMimicTpl< _Scalar, _Options, JointCollectionTpl >::m_scaling
protected

Definition at line 785 of file joint-mimic.hpp.


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


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