GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: python/doxygen_autodoc/hpp/fcl/BVH/BVH_model.h Lines: 13 14 92.9 %
Date: 2024-02-09 12:57:42 Branches: 2 4 50.0 %

Line Branch Exec Source
1
#ifndef DOXYGEN_AUTODOC_HPP_FCL_BVH_BVH_MODEL_H
2
#define DOXYGEN_AUTODOC_HPP_FCL_BVH_BVH_MODEL_H
3
4
#include "/root/robotpkg/path/py-hpp-fcl/work/hpp-fcl-2.4.1/doc/python/doxygen.hh"
5
6
#include <hpp/fcl/BVH/BVH_model.h>
7
8
namespace doxygen {
9
10
template <typename BV>
11
struct class_doc_impl< hpp::fcl::BVFitter <BV > >
12
{
13
static inline const char* run ()
14
{
15
  return "The class for the default algorithm fitting a bounding volume to a set of points. ";
16
}
17
static inline const char* attribute (const char* attrib)
18
{
19
  (void)attrib; // turn off unused parameter warning.
20
  return "";
21
}
22
};
23
24
template <typename BV>
25
inline const char* member_func_doc (BV (hpp::fcl::BVFitter <BV >::*function_ptr) (unsigned int *, unsigned int))
26
{
27
  if (function_ptr == static_cast<BV (hpp::fcl::BVFitter <BV >::*) (unsigned int *, unsigned int)>(&hpp::fcl::BVFitter <BV >::fit))
28
    return "Compute a bounding volume that fits a set of primitives (points or triangles). The primitive data was set by set function and primitive_indices is the primitive index relative to the data. ";
29
  return "";
30
}
31
32
template <typename BV>
33
inline boost::python::detail::keywords<3> member_func_args (BV (hpp::fcl::BVFitter <BV >::*function_ptr) (unsigned int *, unsigned int))
34
{
35
  if (function_ptr == static_cast<BV (hpp::fcl::BVFitter <BV >::*) (unsigned int *, unsigned int)>(&hpp::fcl::BVFitter <BV >::fit))
36
    return (boost::python::arg("self"), boost::python::arg("primitive_indices"), boost::python::arg("num_primitives"));
37
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
38
}
39
} // namespace doxygen
40
#include <hpp/fcl/BVH/BVH_model.h>
41
42
namespace doxygen {
43
44
template <typename BV>
45
struct class_doc_impl< hpp::fcl::BVHModel <BV > >
46
{
47
20
static inline const char* run ()
48
{
49
  return "A class describing the bounding hierarchy of a mesh model or a point cloud model (which is viewed as a degraded version of mesh) \n"
50
"\n"
51
"\n"
52
"Templateparam\n"
53
20
"  - BV one of the bounding volume class in Bounding volumes. ";
54
}
55
static inline const char* attribute (const char* attrib)
56
{
57
  if (strcmp(attrib, "bv_splitter") == 0)
58
    return "Split rule to split one BV node into two children. ";
59
  if (strcmp(attrib, "bv_fitter") == 0)
60
    return "Fitting rule to fit a BV node to a set of geometry primitives. ";
61
  (void)attrib; // turn off unused parameter warning.
62
  return "";
63
}
64
};
65
66
template <typename BV>
67
struct constructor_0_impl< hpp::fcl::BVHModel <BV > >
68
{
69
20
static inline const char* doc ()
70
{
71
20
  return "Default constructor to build an empty BVH. ";
72
}
73
10
static inline boost::python::detail::keywords<0+1> args ()
74
{
75
20
  return (boost::python::arg("self"));
76
}
77
};
78
79
template <typename BV>
80
struct constructor_1_impl< hpp::fcl::BVHModel <BV >, const hpp::fcl::BVHModel <BV >  & >
81
{
82
20
static inline const char* doc ()
83
{
84
  return "Copy constructor from another BVH. \n"
85
"\n"
86
"\n"
87
"Param\n"
88
20
"  - other hpp::fcl::BVHModel to copy. ";
89
}
90
10
static inline boost::python::detail::keywords<1+1> args ()
91
{
92

20
  return (boost::python::arg("self"), boost::python::arg("other"));
93
}
94
};
95
96
template <typename BV>
97
struct destructor_doc_impl < hpp::fcl::BVHModel <BV > >
98
{
99
static inline const char* run ()
100
{
101
  return "deconstruction, delete mesh data related. ";
102
}
103
};
104
105
template <typename BV>
106
10
inline const char* member_func_doc ( hpp::fcl::BVHModel < BV > * (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
107
{
108
10
  if (function_ptr == static_cast< hpp::fcl::BVHModel < BV > * (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::clone))
109
10
    return "Clone *this into a new hpp::fcl::BVHModel. ";
110
  return "";
111
}
112
113
template <typename BV>
114
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::BVHModel < BV > * (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
115
{
116
  if (function_ptr == static_cast< hpp::fcl::BVHModel < BV > * (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::clone))
117
    return (boost::python::arg("self"));
118
  return (boost::python::arg("self"));
119
}
120
121
template <typename BV>
122
inline const char* member_func_doc (const hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*function_ptr) (unsigned int) const)
123
{
124
  if (function_ptr == static_cast<const hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*) (unsigned int) const>(&hpp::fcl::BVHModel <BV >::getBV))
125
    return "We provide getBV() and getNumBVs() because BVH may be compressed (in future), so we must provide some flexibility here. \n"
126
"\n"
127
"Access the bv giving the its index ";
128
  return "";
129
}
130
131
template <typename BV>
132
inline boost::python::detail::keywords<2> member_func_args (const hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*function_ptr) (unsigned int) const)
133
{
134
  if (function_ptr == static_cast<const hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*) (unsigned int) const>(&hpp::fcl::BVHModel <BV >::getBV))
135
    return (boost::python::arg("self"), boost::python::arg("i"));
136
  return (boost::python::arg("self"), boost::python::arg("arg0"));
137
}
138
139
template <typename BV>
140
inline const char* member_func_doc ( hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*function_ptr) (unsigned int))
141
{
142
  if (function_ptr == static_cast< hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*) (unsigned int)>(&hpp::fcl::BVHModel <BV >::getBV))
143
    return "Access the bv giving the its index. ";
144
  return "";
145
}
146
147
template <typename BV>
148
inline boost::python::detail::keywords<2> member_func_args ( hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*function_ptr) (unsigned int))
149
{
150
  if (function_ptr == static_cast< hpp::fcl::BVNode < BV > & (hpp::fcl::BVHModel <BV >::*) (unsigned int)>(&hpp::fcl::BVHModel <BV >::getBV))
151
    return (boost::python::arg("self"), boost::python::arg("i"));
152
  return (boost::python::arg("self"), boost::python::arg("arg0"));
153
}
154
155
template <typename BV>
156
inline const char* member_func_doc (unsigned int (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
157
{
158
  if (function_ptr == static_cast<unsigned int (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNumBVs))
159
    return "Get the number of bv in the BVH. ";
160
  return "";
161
}
162
163
template <typename BV>
164
inline boost::python::detail::keywords<1> member_func_args (unsigned int (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
165
{
166
  if (function_ptr == static_cast<unsigned int (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNumBVs))
167
    return (boost::python::arg("self"));
168
  return (boost::python::arg("self"));
169
}
170
171
template <typename BV>
172
inline const char* member_func_doc ( hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
173
{
174
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
175
    return "Get the BV type: default is unknown. ";
176
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
177
    return "Specialization of getNodeType() for hpp::fcl::BVHModel with different BV types. ";
178
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
179
    return "get the node type ";
180
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
181
    return "get the node type ";
182
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
183
    return "get the node type ";
184
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
185
    return "get the node type ";
186
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
187
    return "get the node type ";
188
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
189
    return "get the node type ";
190
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
191
    return "get the node type ";
192
  return "";
193
}
194
195
template <typename BV>
196
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*function_ptr) () const)
197
{
198
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
199
    return (boost::python::arg("self"));
200
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
201
    return (boost::python::arg("self"));
202
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
203
    return (boost::python::arg("self"));
204
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
205
    return (boost::python::arg("self"));
206
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
207
    return (boost::python::arg("self"));
208
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
209
    return (boost::python::arg("self"));
210
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
211
    return (boost::python::arg("self"));
212
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
213
    return (boost::python::arg("self"));
214
  if (function_ptr == static_cast< hpp::fcl::NODE_TYPE (hpp::fcl::BVHModel <BV >::*) () const>(&hpp::fcl::BVHModel <BV >::getNodeType))
215
    return (boost::python::arg("self"));
216
  return (boost::python::arg("self"));
217
}
218
219
template <typename BV>
220
inline const char* member_func_doc (int (hpp::fcl::BVHModel <BV >::*function_ptr) (const bool) const)
221
{
222
  if (function_ptr == static_cast<int (hpp::fcl::BVHModel <BV >::*) (const bool) const>(&hpp::fcl::BVHModel <BV >::memUsage))
223
    return "Check the number of memory used. ";
224
  return "";
225
}
226
227
template <typename BV>
228
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModel <BV >::*function_ptr) (const bool) const)
229
{
230
  if (function_ptr == static_cast<int (hpp::fcl::BVHModel <BV >::*) (const bool) const>(&hpp::fcl::BVHModel <BV >::memUsage))
231
    return (boost::python::arg("self"), boost::python::arg("msg"));
232
  return (boost::python::arg("self"), boost::python::arg("arg0"));
233
}
234
235
template <typename BV>
236
inline const char* member_func_doc (void (hpp::fcl::BVHModel <BV >::*function_ptr) ())
237
{
238
  if (function_ptr == static_cast<void (hpp::fcl::BVHModel <BV >::*) ()>(&hpp::fcl::BVHModel <BV >::makeParentRelative))
239
    return "This is a special acceleration: BVH_model default stores the BV's transform in world coordinate. However, we can also store each BV's transform related to its parent BV node. When traversing the BVH, this can save one matrix transformation. ";
240
  return "";
241
}
242
243
template <typename BV>
244
inline boost::python::detail::keywords<1> member_func_args (void (hpp::fcl::BVHModel <BV >::*function_ptr) ())
245
{
246
  if (function_ptr == static_cast<void (hpp::fcl::BVHModel <BV >::*) ()>(&hpp::fcl::BVHModel <BV >::makeParentRelative))
247
    return (boost::python::arg("self"));
248
  return (boost::python::arg("self"));
249
}
250
} // namespace doxygen
251
#include <hpp/fcl/BVH/BVH_model.h>
252
253
namespace doxygen {
254
255
template <>
256
struct class_doc_impl< hpp::fcl::BVHModelBase >
257
{
258
static inline const char* run ()
259
{
260
  return "A base class describing the bounding hierarchy of a mesh model or a point cloud model (which is viewed as a degraded version of mesh) ";
261
}
262
static inline const char* attribute (const char* attrib)
263
{
264
  if (strcmp(attrib, "vertices") == 0)
265
    return "Geometry point data. ";
266
  if (strcmp(attrib, "tri_indices") == 0)
267
    return "Geometry triangle index data, will be NULL for point clouds. ";
268
  if (strcmp(attrib, "prev_vertices") == 0)
269
    return "Geometry point data in previous frame. ";
270
  if (strcmp(attrib, "num_tris") == 0)
271
    return "Number of triangles. ";
272
  if (strcmp(attrib, "num_vertices") == 0)
273
    return "Number of points. ";
274
  if (strcmp(attrib, "build_state") == 0)
275
    return "The state of BVH building process. ";
276
  if (strcmp(attrib, "convex") == 0)
277
    return "Convex<Triangle> representation of this object. ";
278
  (void)attrib; // turn off unused parameter warning.
279
  return "";
280
}
281
};
282
283
template <>
284
struct constructor_0_impl< hpp::fcl::BVHModelBase >
285
{
286
static inline const char* doc ()
287
{
288
  return "Constructing an empty BVH. ";
289
}
290
static inline boost::python::detail::keywords<0+1> args ()
291
{
292
  return (boost::python::arg("self"));
293
}
294
};
295
296
template <>
297
struct constructor_1_impl< hpp::fcl::BVHModelBase, const hpp::fcl::BVHModelBase & >
298
{
299
static inline const char* doc ()
300
{
301
  return "copy from another BVH ";
302
}
303
static inline boost::python::detail::keywords<1+1> args ()
304
{
305
  return (boost::python::arg("self"), boost::python::arg("other"));
306
}
307
};
308
309
template <>
310
struct destructor_doc_impl < hpp::fcl::BVHModelBase >
311
{
312
static inline const char* run ()
313
{
314
  return "deconstruction, delete mesh data related. ";
315
}
316
};
317
318
inline const char* member_func_doc ( hpp::fcl::BVHModelType (hpp::fcl::BVHModelBase::*function_ptr) () const)
319
{
320
  if (function_ptr == static_cast< hpp::fcl::BVHModelType (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::getModelType))
321
    return "Model type described by the instance. ";
322
  return "";
323
}
324
325
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::BVHModelType (hpp::fcl::BVHModelBase::*function_ptr) () const)
326
{
327
  if (function_ptr == static_cast< hpp::fcl::BVHModelType (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::getModelType))
328
    return (boost::python::arg("self"));
329
  return (boost::python::arg("self"));
330
}
331
332
inline const char* member_func_doc ( hpp::fcl::OBJECT_TYPE (hpp::fcl::BVHModelBase::*function_ptr) () const)
333
{
334
  if (function_ptr == static_cast< hpp::fcl::OBJECT_TYPE (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::getObjectType))
335
    return "Get the object type: it is a BVH. ";
336
  return "";
337
}
338
339
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::OBJECT_TYPE (hpp::fcl::BVHModelBase::*function_ptr) () const)
340
{
341
  if (function_ptr == static_cast< hpp::fcl::OBJECT_TYPE (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::getObjectType))
342
    return (boost::python::arg("self"));
343
  return (boost::python::arg("self"));
344
}
345
346
inline const char* member_func_doc (void (hpp::fcl::BVHModelBase::*function_ptr) ())
347
{
348
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::computeLocalAABB))
349
    return "Compute the hpp::fcl::AABB for the BVH, used for broad-phase collision. ";
350
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::makeParentRelative))
351
    return "This is a special acceleration: BVH_model default stores the BV's transform in world coordinate. However, we can also store each BV's transform related to its parent BV node. When traversing the BVH, this can save one matrix transformation. ";
352
  return "";
353
}
354
355
inline boost::python::detail::keywords<1> member_func_args (void (hpp::fcl::BVHModelBase::*function_ptr) ())
356
{
357
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::computeLocalAABB))
358
    return (boost::python::arg("self"));
359
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::makeParentRelative))
360
    return (boost::python::arg("self"));
361
  return (boost::python::arg("self"));
362
}
363
364
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (unsigned int, unsigned int))
365
{
366
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (unsigned int, unsigned int)>(&hpp::fcl::BVHModelBase::beginModel))
367
    return "Begin a new BVH model. ";
368
  return "";
369
}
370
371
inline boost::python::detail::keywords<3> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (unsigned int, unsigned int))
372
{
373
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (unsigned int, unsigned int)>(&hpp::fcl::BVHModelBase::beginModel))
374
    return (boost::python::arg("self"), boost::python::arg("num_tris"), boost::python::arg("num_vertices"));
375
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
376
}
377
378
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Vec3f &))
379
{
380
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::addVertex))
381
    return "Add one point in the new BVH model. ";
382
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::replaceVertex))
383
    return "Replace one point in the old BVH model. ";
384
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::updateVertex))
385
    return "Update one point in the old BVH model. ";
386
  return "";
387
}
388
389
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Vec3f &))
390
{
391
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::addVertex))
392
    return (boost::python::arg("self"), boost::python::arg("p"));
393
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::replaceVertex))
394
    return (boost::python::arg("self"), boost::python::arg("p"));
395
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::updateVertex))
396
    return (boost::python::arg("self"), boost::python::arg("p"));
397
  return (boost::python::arg("self"), boost::python::arg("arg0"));
398
}
399
400
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Matrixx3f &))
401
{
402
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Matrixx3f &)>(&hpp::fcl::BVHModelBase::addVertices))
403
    return "Add points in the new BVH model. ";
404
  return "";
405
}
406
407
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Matrixx3f &))
408
{
409
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Matrixx3f &)>(&hpp::fcl::BVHModelBase::addVertices))
410
    return (boost::python::arg("self"), boost::python::arg("points"));
411
  return (boost::python::arg("self"), boost::python::arg("arg0"));
412
}
413
414
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Matrixx3i &))
415
{
416
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Matrixx3i &)>(&hpp::fcl::BVHModelBase::addTriangles))
417
    return "Add triangles in the new BVH model. ";
418
  return "";
419
}
420
421
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Matrixx3i &))
422
{
423
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Matrixx3i &)>(&hpp::fcl::BVHModelBase::addTriangles))
424
    return (boost::python::arg("self"), boost::python::arg("triangles"));
425
  return (boost::python::arg("self"), boost::python::arg("arg0"));
426
}
427
428
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &))
429
{
430
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::addTriangle))
431
    return "Add one triangle in the new BVH model. ";
432
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::replaceTriangle))
433
    return "Replace one triangle in the old BVH model. ";
434
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::updateTriangle))
435
    return "Update one triangle in the old BVH model. ";
436
  return "";
437
}
438
439
inline boost::python::detail::keywords<4> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &))
440
{
441
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::addTriangle))
442
    return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
443
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::replaceTriangle))
444
    return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
445
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &, const hpp::fcl::Vec3f &)>(&hpp::fcl::BVHModelBase::updateTriangle))
446
    return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
447
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
448
}
449
450
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const std::vector< hpp::fcl::Vec3f > &, const std::vector< hpp::fcl::Triangle > &))
451
{
452
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &, const std::vector< hpp::fcl::Triangle > &)>(&hpp::fcl::BVHModelBase::addSubModel))
453
    return "Add a set of triangles in the new BVH model. ";
454
  return "";
455
}
456
457
inline boost::python::detail::keywords<3> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const std::vector< hpp::fcl::Vec3f > &, const std::vector< hpp::fcl::Triangle > &))
458
{
459
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &, const std::vector< hpp::fcl::Triangle > &)>(&hpp::fcl::BVHModelBase::addSubModel))
460
    return (boost::python::arg("self"), boost::python::arg("ps"), boost::python::arg("ts"));
461
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
462
}
463
464
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const std::vector< hpp::fcl::Vec3f > &))
465
{
466
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::addSubModel))
467
    return "Add a set of points in the new BVH model. ";
468
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::replaceSubModel))
469
    return "Replace a set of points in the old BVH model. ";
470
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::updateSubModel))
471
    return "Update a set of points in the old BVH model. ";
472
  return "";
473
}
474
475
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const std::vector< hpp::fcl::Vec3f > &))
476
{
477
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::addSubModel))
478
    return (boost::python::arg("self"), boost::python::arg("ps"));
479
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::replaceSubModel))
480
    return (boost::python::arg("self"), boost::python::arg("ps"));
481
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const std::vector< hpp::fcl::Vec3f > &)>(&hpp::fcl::BVHModelBase::updateSubModel))
482
    return (boost::python::arg("self"), boost::python::arg("ps"));
483
  return (boost::python::arg("self"), boost::python::arg("arg0"));
484
}
485
486
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) ())
487
{
488
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::endModel))
489
    return "End BVH model construction, will build the bounding volume hierarchy. ";
490
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::beginReplaceModel))
491
    return "Replace the geometry information of current frame (i.e. should have the same mesh topology with the previous frame) ";
492
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::beginUpdateModel))
493
    return "Replace the geometry information of current frame (i.e. should have the same mesh topology with the previous frame). The current frame will be saved as the previous frame in prev_vertices. ";
494
  return "";
495
}
496
497
inline boost::python::detail::keywords<1> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) ())
498
{
499
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::endModel))
500
    return (boost::python::arg("self"));
501
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::beginReplaceModel))
502
    return (boost::python::arg("self"));
503
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) ()>(&hpp::fcl::BVHModelBase::beginUpdateModel))
504
    return (boost::python::arg("self"));
505
  return (boost::python::arg("self"));
506
}
507
508
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (bool, bool))
509
{
510
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (bool, bool)>(&hpp::fcl::BVHModelBase::endReplaceModel))
511
    return "End BVH model replacement, will also refit or rebuild the bounding volume hierarchy. ";
512
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (bool, bool)>(&hpp::fcl::BVHModelBase::endUpdateModel))
513
    return "End BVH model update, will also refit or rebuild the bounding volume hierarchy. ";
514
  return "";
515
}
516
517
inline boost::python::detail::keywords<3> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (bool, bool))
518
{
519
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (bool, bool)>(&hpp::fcl::BVHModelBase::endReplaceModel))
520
    return (boost::python::arg("self"), boost::python::arg("refit"), boost::python::arg("bottomup"));
521
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (bool, bool)>(&hpp::fcl::BVHModelBase::endUpdateModel))
522
    return (boost::python::arg("self"), boost::python::arg("refit"), boost::python::arg("bottomup"));
523
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
524
}
525
526
inline const char* member_func_doc (void (hpp::fcl::BVHModelBase::*function_ptr) (bool))
527
{
528
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) (bool)>(&hpp::fcl::BVHModelBase::buildConvexRepresentation))
529
    return "Build this hpp::fcl::Convex representation of this model. The result is stored in attribute convex. \n"
530
"\n"
531
"Note: this only takes the points of this model. It does not check that the object is convex. It does not compute a convex hull. ";
532
  return "";
533
}
534
535
inline boost::python::detail::keywords<2> member_func_args (void (hpp::fcl::BVHModelBase::*function_ptr) (bool))
536
{
537
  if (function_ptr == static_cast<void (hpp::fcl::BVHModelBase::*) (bool)>(&hpp::fcl::BVHModelBase::buildConvexRepresentation))
538
    return (boost::python::arg("self"), boost::python::arg("share_memory"));
539
  return (boost::python::arg("self"), boost::python::arg("arg0"));
540
}
541
542
inline const char* member_func_doc (bool (hpp::fcl::BVHModelBase::*function_ptr) (bool, const char *))
543
{
544
  if (function_ptr == static_cast<bool (hpp::fcl::BVHModelBase::*) (bool, const char *)>(&hpp::fcl::BVHModelBase::buildConvexHull))
545
    return "Build a convex hull and store it in attribute convex. \n"
546
"\n"
547
"\n"
548
"Param\n"
549
"  - keepTriangle whether the convex should be triangulated. \n"
550
"  - qhullCommand see ConvexBase::convexHull. \n"
551
"\n"
552
"Return: true if this object is convex, hence the convex hull represents the same object. \n"
553
"\n"
554
"See: ConvexBase::convexHull \n"
555
"\n"
556
"Warning: At the moment, the return value only checks whether there are as many points in the convex hull as in the original object. This is neither necessary (duplicated vertices get merged) nor sufficient (think of a U with 4 vertices and 3 edges). ";
557
  return "";
558
}
559
560
inline boost::python::detail::keywords<3> member_func_args (bool (hpp::fcl::BVHModelBase::*function_ptr) (bool, const char *))
561
{
562
  if (function_ptr == static_cast<bool (hpp::fcl::BVHModelBase::*) (bool, const char *)>(&hpp::fcl::BVHModelBase::buildConvexHull))
563
    return (boost::python::arg("self"), boost::python::arg("keepTriangle"), boost::python::arg("qhullCommand"));
564
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
565
}
566
567
inline const char* member_func_doc (int (hpp::fcl::BVHModelBase::*function_ptr) (const bool) const)
568
{
569
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const bool) const>(&hpp::fcl::BVHModelBase::memUsage))
570
    return "";
571
  return "";
572
}
573
574
inline boost::python::detail::keywords<2> member_func_args (int (hpp::fcl::BVHModelBase::*function_ptr) (const bool) const)
575
{
576
  if (function_ptr == static_cast<int (hpp::fcl::BVHModelBase::*) (const bool) const>(&hpp::fcl::BVHModelBase::memUsage))
577
    return (boost::python::arg("self"), boost::python::arg("msg"));
578
  return (boost::python::arg("self"), boost::python::arg("arg0"));
579
}
580
581
inline const char* member_func_doc ( hpp::fcl::Vec3f (hpp::fcl::BVHModelBase::*function_ptr) () const)
582
{
583
  if (function_ptr == static_cast< hpp::fcl::Vec3f (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeCOM))
584
    return "compute center of mass ";
585
  return "";
586
}
587
588
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::Vec3f (hpp::fcl::BVHModelBase::*function_ptr) () const)
589
{
590
  if (function_ptr == static_cast< hpp::fcl::Vec3f (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeCOM))
591
    return (boost::python::arg("self"));
592
  return (boost::python::arg("self"));
593
}
594
595
inline const char* member_func_doc ( hpp::fcl::FCL_REAL (hpp::fcl::BVHModelBase::*function_ptr) () const)
596
{
597
  if (function_ptr == static_cast< hpp::fcl::FCL_REAL (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeVolume))
598
    return "compute the volume ";
599
  return "";
600
}
601
602
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::FCL_REAL (hpp::fcl::BVHModelBase::*function_ptr) () const)
603
{
604
  if (function_ptr == static_cast< hpp::fcl::FCL_REAL (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeVolume))
605
    return (boost::python::arg("self"));
606
  return (boost::python::arg("self"));
607
}
608
609
inline const char* member_func_doc ( hpp::fcl::Matrix3f (hpp::fcl::BVHModelBase::*function_ptr) () const)
610
{
611
  if (function_ptr == static_cast< hpp::fcl::Matrix3f (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeMomentofInertia))
612
    return "compute the inertia matrix, related to the origin ";
613
  return "";
614
}
615
616
inline boost::python::detail::keywords<1> member_func_args ( hpp::fcl::Matrix3f (hpp::fcl::BVHModelBase::*function_ptr) () const)
617
{
618
  if (function_ptr == static_cast< hpp::fcl::Matrix3f (hpp::fcl::BVHModelBase::*) () const>(&hpp::fcl::BVHModelBase::computeMomentofInertia))
619
    return (boost::python::arg("self"));
620
  return (boost::python::arg("self"));
621
}
622
} // namespace doxygen
623
#include <hpp/fcl/BVH/BVH_model.h>
624
625
namespace doxygen {
626
627
template <typename BV>
628
struct class_doc_impl< hpp::fcl::BVSplitter <BV > >
629
{
630
static inline const char* run ()
631
{
632
  return "A class describing the split rule that splits each BV node. ";
633
}
634
static inline const char* attribute (const char* attrib)
635
{
636
  (void)attrib; // turn off unused parameter warning.
637
  return "";
638
}
639
};
640
641
template <typename BV>
642
struct constructor_1_impl< hpp::fcl::BVSplitter <BV >,  hpp::fcl::SplitMethodType >
643
{
644
static inline const char* doc ()
645
{
646
  return "";
647
}
648
static inline boost::python::detail::keywords<1+1> args ()
649
{
650
  return (boost::python::arg("self"), boost::python::arg("method"));
651
}
652
};
653
654
template <typename BV>
655
struct destructor_doc_impl < hpp::fcl::BVSplitter <BV > >
656
{
657
static inline const char* run ()
658
{
659
  return "Default deconstructor. ";
660
}
661
};
662
663
template <typename BV>
664
inline const char* member_func_doc (void (hpp::fcl::BVSplitter <BV >::*function_ptr) ( hpp::fcl::Vec3f *,  hpp::fcl::Triangle *,  hpp::fcl::BVHModelType))
665
{
666
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) ( hpp::fcl::Vec3f *,  hpp::fcl::Triangle *,  hpp::fcl::BVHModelType)>(&hpp::fcl::BVSplitter <BV >::set))
667
    return "Set the geometry data needed by the split rule. ";
668
  return "";
669
}
670
671
template <typename BV>
672
inline boost::python::detail::keywords<4> member_func_args (void (hpp::fcl::BVSplitter <BV >::*function_ptr) ( hpp::fcl::Vec3f *,  hpp::fcl::Triangle *,  hpp::fcl::BVHModelType))
673
{
674
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) ( hpp::fcl::Vec3f *,  hpp::fcl::Triangle *,  hpp::fcl::BVHModelType)>(&hpp::fcl::BVSplitter <BV >::set))
675
    return (boost::python::arg("self"), boost::python::arg("vertices_"), boost::python::arg("tri_indices_"), boost::python::arg("type_"));
676
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
677
}
678
679
template <typename BV>
680
inline const char* member_func_doc (void (hpp::fcl::BVSplitter <BV >::*function_ptr) (const BV &, unsigned int *, unsigned int))
681
{
682
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) (const BV &, unsigned int *, unsigned int)>(&hpp::fcl::BVSplitter <BV >::computeRule))
683
    return "Compute the split rule according to a subset of geometry and the corresponding BV node. ";
684
  return "";
685
}
686
687
template <typename BV>
688
inline boost::python::detail::keywords<4> member_func_args (void (hpp::fcl::BVSplitter <BV >::*function_ptr) (const BV &, unsigned int *, unsigned int))
689
{
690
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) (const BV &, unsigned int *, unsigned int)>(&hpp::fcl::BVSplitter <BV >::computeRule))
691
    return (boost::python::arg("self"), boost::python::arg("bv"), boost::python::arg("primitive_indices"), boost::python::arg("num_primitives"));
692
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
693
}
694
695
template <typename BV>
696
inline const char* member_func_doc (bool (hpp::fcl::BVSplitter <BV >::*function_ptr) (const hpp::fcl::Vec3f &) const)
697
{
698
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
699
    return "Apply the split rule on a given point. ";
700
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
701
    return "";
702
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
703
    return "";
704
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
705
    return "";
706
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
707
    return "";
708
  return "";
709
}
710
711
template <typename BV>
712
inline boost::python::detail::keywords<2> member_func_args (bool (hpp::fcl::BVSplitter <BV >::*function_ptr) (const hpp::fcl::Vec3f &) const)
713
{
714
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
715
    return (boost::python::arg("self"), boost::python::arg("q"));
716
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
717
    return (boost::python::arg("self"), boost::python::arg("q"));
718
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
719
    return (boost::python::arg("self"), boost::python::arg("q"));
720
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
721
    return (boost::python::arg("self"), boost::python::arg("q"));
722
  if (function_ptr == static_cast<bool (hpp::fcl::BVSplitter <BV >::*) (const hpp::fcl::Vec3f &) const>(&hpp::fcl::BVSplitter <BV >::apply))
723
    return (boost::python::arg("self"), boost::python::arg("q"));
724
  return (boost::python::arg("self"), boost::python::arg("arg0"));
725
}
726
727
template <typename BV>
728
inline const char* member_func_doc (void (hpp::fcl::BVSplitter <BV >::*function_ptr) ())
729
{
730
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) ()>(&hpp::fcl::BVSplitter <BV >::clear))
731
    return "Clear the geometry data set before. ";
732
  return "";
733
}
734
735
template <typename BV>
736
inline boost::python::detail::keywords<1> member_func_args (void (hpp::fcl::BVSplitter <BV >::*function_ptr) ())
737
{
738
  if (function_ptr == static_cast<void (hpp::fcl::BVSplitter <BV >::*) ()>(&hpp::fcl::BVSplitter <BV >::clear))
739
    return (boost::python::arg("self"));
740
  return (boost::python::arg("self"));
741
}
742
} // namespace doxygen
743
744
#endif // DOXYGEN_AUTODOC_HPP_FCL_BVH_BVH_MODEL_H
745