model.hxx 11.6 KB
Newer Older
1
//
2
// Copyright (c) 2015-2020 CNRS INRIA
3
4
5
// Copyright (c) 2015 Wandercraft, 86 rue de Paris 91400 Orsay, France.
//

Justin Carpentier's avatar
Justin Carpentier committed
6
7
#ifndef __pinocchio_multibody_model_hxx__
#define __pinocchio_multibody_model_hxx__
8
9

#include "pinocchio/spatial/fwd.hpp"
jcarpent's avatar
jcarpent committed
10
#include "pinocchio/utils/string-generator.hpp"
11
#include "pinocchio/multibody/liegroup/liegroup-algo.hpp"
12

13
#include <boost/bind.hpp>
14
#include <boost/utility.hpp>
15

jcarpent's avatar
jcarpent committed
16
17
/// @cond DEV

18
namespace pinocchio
19
{
20
21
  namespace details
  {
22
23
24
    struct FilterFrame
    {
      const std::string & name;
25
      const FrameType & typeMask;
26
27
28
29
30
31
32
      
      FilterFrame(const std::string& name, const FrameType & typeMask)
      : name(name), typeMask(typeMask)
      {}
      
      template<typename Scalar, int Options>
      bool operator()(const FrameTpl<Scalar,Options> & frame) const
33
      { return (typeMask & frame.type) && (name == frame.name); }
34
      
35
36
    };
  }
37
38
39
  
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  const typename ModelTpl<Scalar,Options,JointCollectionTpl>::
40
  Vector3 ModelTpl<Scalar,Options,JointCollectionTpl>::gravity981((Scalar)0,(Scalar)0,(Scalar)-9.81);
41

42
43
44
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline std::ostream& operator<<(std::ostream & os,
                                  const ModelTpl<Scalar,Options,JointCollectionTpl> & model)
45
  {
46
    typedef typename ModelTpl<Scalar,Options,JointCollectionTpl>::Index Index;
47
    
48
    os << "Nb joints = " << model.njoints << " (nq="<< model.nq<<",nv="<<model.nv<<")" << std::endl;
49
    for(Index i=0;i<(Index)(model.njoints);++i)
jcarpent's avatar
jcarpent committed
50
    {
51
      os << "  Joint " << i << " " << model.names[i] << ": parent=" << model.parents[i]  << std::endl;
jcarpent's avatar
jcarpent committed
52
53
    }
    
54
55
    return os;
  }
56
  
57
58
59
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  typename ModelTpl<Scalar,Options,JointCollectionTpl>::JointIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::addJoint(const JointIndex parent,
60
                                                        const JointModel & joint_model,
61
62
63
64
65
66
67
                                                        const SE3 & joint_placement,
                                                        const std::string & joint_name,
                                                        const VectorXs & max_effort,
                                                        const VectorXs & max_velocity,
                                                        const VectorXs & min_config,
                                                        const VectorXs & max_config
                                                        )
68
  {
69
70
    assert( (njoints==(int)joints.size())&&(njoints==(int)inertias.size())
           &&(njoints==(int)parents.size())&&(njoints==(int)jointPlacements.size()) );
jcarpent's avatar
jcarpent committed
71
    assert((joint_model.nq()>=0) && (joint_model.nv()>=0));
72
    assert(joint_model.nq() >= joint_model.nv());
73

jcarpent's avatar
jcarpent committed
74
75
76
77
    assert(max_effort.size() == joint_model.nv()
           && max_velocity.size() == joint_model.nv()
           && min_config.size() == joint_model.nq()
           && max_config.size() == joint_model.nq());
78
    
79
    JointIndex idx = (JointIndex)(njoints++);
80
    
jcarpent's avatar
jcarpent committed
81
    joints         .push_back(JointModel(joint_model.derived()));
82
83
//    JointModelDerived & jmodel = boost::get<JointModelDerived>(joints.back());
    JointModel & jmodel = joints.back();
84
    jmodel.setIndexes(idx,nq,nv);
jcarpent's avatar
jcarpent committed
85
    
86
87
88
89
90
91
92
    const int joint_nq = jmodel.nq();
    const int joint_idx_q = jmodel.idx_q();
    const int joint_nv = jmodel.nv();
    const int joint_idx_v = jmodel.idx_v();
    
    assert(joint_idx_q >= 0);
    assert(joint_idx_v >= 0);
Justin Carpentier's avatar
Justin Carpentier committed
93

94
    inertias       .push_back(Inertia::Zero());
95
    parents        .push_back(parent);
jcarpent's avatar
jcarpent committed
96
    jointPlacements.push_back(joint_placement);
97
    names          .push_back(joint_name);
98
99
100
    
    nq += joint_nq; nqs.push_back(joint_nq); idx_qs.push_back(joint_idx_q);
    nv += joint_nv; nvs.push_back(joint_nv); idx_vs.push_back(joint_idx_v);
101

102
    if(joint_nq > 0 && joint_nv > 0)
103
104
105
106
107
108
109
110
111
112
113
114
115
    {
      effortLimit.conservativeResize(nv);
      jmodel.jointVelocitySelector(effortLimit) = max_effort;
      velocityLimit.conservativeResize(nv);
      jmodel.jointVelocitySelector(velocityLimit) = max_velocity;
      lowerPositionLimit.conservativeResize(nq);
      jmodel.jointConfigSelector(lowerPositionLimit) = min_config;
      upperPositionLimit.conservativeResize(nq);
      jmodel.jointConfigSelector(upperPositionLimit) = max_config;
      
      rotorInertia.conservativeResize(nv);
      jmodel.jointVelocitySelector(rotorInertia).setZero();
      rotorGearRatio.conservativeResize(nv);
116
      jmodel.jointVelocitySelector(rotorGearRatio).setOnes();
117
    }
jcarpent's avatar
jcarpent committed
118
    
jcarpent's avatar
jcarpent committed
119
120
121
122
    // Init and add joint index to its parent subtrees.
    subtrees.push_back(IndexVector(1));
    subtrees[idx][0] = idx;
    addJointIndexToParentSubtrees(idx);
123
124
125
126
127
    
    // Init and add joint index to the supports
    supports.push_back(supports[parent]);
    supports[idx].push_back(idx);
    
128
129
130
    return idx;
  }

131
132
133
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  typename ModelTpl<Scalar,Options,JointCollectionTpl>::JointIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::addJoint(const JointIndex parent,
134
                                                        const JointModel & joint_model,
135
136
                                                        const SE3 & joint_placement,
                                                        const std::string & joint_name)
137
  {
138
    VectorXs max_effort, max_velocity, min_config, max_config;
139

140
141
142
143
    max_effort = VectorXs::Constant(joint_model.nv(), std::numeric_limits<Scalar>::max());
    max_velocity = VectorXs::Constant(joint_model.nv(), std::numeric_limits<Scalar>::max());
    min_config = VectorXs::Constant(joint_model.nq(), -std::numeric_limits<Scalar>::max());
    max_config = VectorXs::Constant(joint_model.nq(), std::numeric_limits<Scalar>::max());
144

145
    return addJoint(parent, joint_model, joint_placement, joint_name, max_effort, max_velocity, min_config, max_config);
146
147
  }
  
148
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
149
150
  inline typename ModelTpl<Scalar,Options,JointCollectionTpl>::FrameIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::
151
152
  addJointFrame(const JointIndex & joint_index,
                int previous_frame_index)
153
  {
154
155
156
157
    PINOCCHIO_CHECK_INPUT_ARGUMENT(joint_index >= 0 && joint_index < joints.size(),
                                   "The joint index is larger than the number of joints in the model.");
    if(previous_frame_index < 0)
    {
158
159
      // FIXED_JOINT is required because the parent can be the universe and its
      // type is FIXED_JOINT
160
      previous_frame_index = (int)getFrameId(names[parents[joint_index]], (FrameType)(JOINT | FIXED_JOINT));
161
    }
162
163
    assert((size_t)previous_frame_index < frames.size() && "Frame index out of bound");
    
164
    // Add a the joint frame attached to itself to the frame vector - redundant information but useful.
165
    return addFrame(Frame(names[joint_index],joint_index,(FrameIndex)previous_frame_index,SE3::Identity(),JOINT));
166
167
  }

168
169
170
171
172
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline void ModelTpl<Scalar,Options,JointCollectionTpl>::
  appendBodyToJoint(const ModelTpl::JointIndex joint_index,
                    const Inertia & Y,
                    const SE3 & body_placement)
173
  {
jcarpent's avatar
jcarpent committed
174
175
    const Inertia & iYf = Y.se3Action(body_placement);
    inertias[joint_index] += iYf;
176
    nbodies++;
177
  }
178

179
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
180
181
  inline typename ModelTpl<Scalar,Options,JointCollectionTpl>::FrameIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::
182
183
184
185
  addBodyFrame(const std::string & body_name,
               const JointIndex  & parentJoint,
               const SE3         & body_placement,
               int           previousFrame)
186
  {
jcarpent's avatar
jcarpent committed
187
    if(previousFrame < 0) {
188
189
      // FIXED_JOINT is required because the parent can be the universe and its
      // type is FIXED_JOINT
190
      previousFrame = (int)getFrameId(names[parentJoint], (FrameType)(JOINT | FIXED_JOINT));
191
    }
192
193
    assert((size_t)previousFrame < frames.size() && "Frame index out of bound");
    return addFrame(Frame(body_name, parentJoint, (FrameIndex)previousFrame, body_placement, BODY));
194
  }
jcarpent's avatar
jcarpent committed
195
  
196
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
197
  inline typename ModelTpl<Scalar,Options,JointCollectionTpl>::FrameIndex
198
199
  ModelTpl<Scalar,Options,JointCollectionTpl>::
  getBodyId(const std::string & name) const
200
  {
201
    return getFrameId(name, BODY);
202
203
  }
  
204
205
206
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline bool ModelTpl<Scalar,Options,JointCollectionTpl>::
  existBodyName(const std::string & name) const
207
  {
208
    return existFrame(name, BODY);
209
210
  }

211
212
213
214
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline typename  ModelTpl<Scalar,Options,JointCollectionTpl>::JointIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::
  getJointId(const std::string & name) const
215
  {
jcarpent's avatar
jcarpent committed
216
217
    typedef std::vector<std::string>::iterator::difference_type it_diff_t;
    it_diff_t res = std::find(names.begin(),names.end(),name) - names.begin();
jcarpent's avatar
jcarpent committed
218
    assert((res<INT_MAX) && "Id superior to int range. Should never happen.");
219
    return ModelTpl::JointIndex(res);
220
221
  }
  
222
223
224
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline bool ModelTpl<Scalar,Options,JointCollectionTpl>::
  existJointName(const std::string & name) const
225
226
227
228
  {
    return (names.end() != std::find(names.begin(),names.end(),name));
  }

229
230
231
232
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline typename ModelTpl<Scalar,Options,JointCollectionTpl>::FrameIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::
  getFrameId(const std::string & name, const FrameType & type) const
233
  {
234
    typename PINOCCHIO_ALIGNED_STD_VECTOR(Frame)::const_iterator it
235
236
237
    = std::find_if(frames.begin()
                   ,frames.end()
                   ,details::FilterFrame(name, type));
238
239
    assert(((it == frames.end()) ||
            (std::find_if( boost::next(it), frames.end(), details::FilterFrame(name, type)) == frames.end()))
240
        && "Several frames match the filter");
241
    return FrameIndex(it - frames.begin());
242
  }
243
  
244
245
246
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline bool ModelTpl<Scalar,Options,JointCollectionTpl>::
  existFrame(const std::string & name, const FrameType & type) const
247
  {
248
249
    return std::find_if(frames.begin(), frames.end(),
                        details::FilterFrame(name, type)) != frames.end();
250
251
  }

252
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
253
254
  inline typename ModelTpl<Scalar,Options,JointCollectionTpl>::FrameIndex
  ModelTpl<Scalar,Options,JointCollectionTpl>::
255
  addFrame(const Frame & frame)
256
  {
257
258
    // Check if the frame.name exists with the same type
    if(existFrame(frame.name,frame.type))
259
    {
260
      return getFrameId(frame.name,frame.type);
261
    }
262
263
264
    // else: we must add a new frames to the current stack
    frames.push_back(frame);
    nframes++;
265
    return FrameIndex(nframes - 1);
266
  }
jcarpent's avatar
jcarpent committed
267
  
268
269
270
  template<typename Scalar, int Options, template<typename,int> class JointCollectionTpl>
  inline void ModelTpl<Scalar,Options,JointCollectionTpl>::
  addJointIndexToParentSubtrees(const JointIndex joint_id)
jcarpent's avatar
jcarpent committed
271
272
273
  {
    for(JointIndex parent = parents[joint_id]; parent>0; parent = parents[parent])
      subtrees[parent].push_back(joint_id);
274
275
276
    
    // Also add joint_id to the universe
    subtrees[0].push_back(joint_id);
jcarpent's avatar
jcarpent committed
277
  }
278

279
} // namespace pinocchio
280

jcarpent's avatar
jcarpent committed
281
282
/// @endcond

Justin Carpentier's avatar
Justin Carpentier committed
283
#endif // ifndef __pinocchio_multibody_model_hxx__