GCC Code Coverage Report

Directory: ./
File: python/doxygen_autodoc/coal/BVH/BVH_model.h
Date: 2025-04-13 14:25:19
Exec Total Coverage
Lines: 13 14 92.9%
Branches: 2 4 50.0%
Line Branch Exec Source
1 #ifndef DOXYGEN_AUTODOC_COAL_BVH_BVH_MODEL_H
2 #define DOXYGEN_AUTODOC_COAL_BVH_BVH_MODEL_H
3
4 #include "/root/robotpkg/path/py-coal/work/coal-3.0.1/doc/python/doxygen.hh"
5
6 #include <coal/BVH/BVH_model.h>
7
8 namespace doxygen {
9
10 template <typename BV>
11 struct class_doc_impl< coal::BVHModel <BV > >
12 {
13 20 static inline const char* run ()
14 {
15 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"
16 "\n"
17 "\n"
18 "Templateparam\n"
19 20 " - BV one of the bounding volume class in Bounding volumes. ";
20 }
21 static inline const char* attribute (const char* attrib)
22 {
23 if (strcmp(attrib, "bv_splitter") == 0)
24 return "Split rule to split one BV node into two children. ";
25 if (strcmp(attrib, "bv_fitter") == 0)
26 return "Fitting rule to fit a BV node to a set of geometry primitives. ";
27 (void)attrib; // turn off unused parameter warning.
28 return "";
29 }
30 };
31
32 template <typename BV>
33 struct constructor_0_impl< coal::BVHModel <BV > >
34 {
35 20 static inline const char* doc ()
36 {
37 20 return "Default constructor to build an empty BVH. ";
38 }
39 10 static inline boost::python::detail::keywords<0+1> args ()
40 {
41 20 return (boost::python::arg("self"));
42 }
43 };
44
45 template <typename BV>
46 struct constructor_1_impl< coal::BVHModel <BV >, const coal::BVHModel <BV > & >
47 {
48 20 static inline const char* doc ()
49 {
50 return "Copy constructor from another BVH. \n"
51 "\n"
52 "\n"
53 "Param\n"
54 20 " - other coal::BVHModel to copy. ";
55 }
56 10 static inline boost::python::detail::keywords<1+1> args ()
57 {
58
2/4
✓ Branch 2 taken 10 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 10 times.
✗ Branch 6 not taken.
 40 return (boost::python::arg("self"), boost::python::arg("other"));
59 }
60 };
61
62 template <typename BV>
63 struct destructor_doc_impl < coal::BVHModel <BV > >
64 {
65 static inline const char* run ()
66 {
67 return "deconstruction, delete mesh data related. ";
68 }
69 };
70
71 template <typename BV>
72 10 inline const char* member_func_doc ( coal::BVHModel < BV > * (coal::BVHModel <BV >::*function_ptr) () const)
73 {
74 10 if (function_ptr == static_cast< coal::BVHModel < BV > * (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::clone))
75 10 return "Clone *this into a new coal::BVHModel. ";
76 ✗ return "";
77 }
78
79 template <typename BV>
80 inline boost::python::detail::keywords<1> member_func_args ( coal::BVHModel < BV > * (coal::BVHModel <BV >::*function_ptr) () const)
81 {
82 if (function_ptr == static_cast< coal::BVHModel < BV > * (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::clone))
83 return (boost::python::arg("self"));
84 return (boost::python::arg("self"));
85 }
86
87 template <typename BV>
88 inline const char* member_func_doc (const coal::BVNode < BV > & (coal::BVHModel <BV >::*function_ptr) (unsigned int) const)
89 {
90 if (function_ptr == static_cast<const coal::BVNode < BV > & (coal::BVHModel <BV >::*) (unsigned int) const>(&coal::BVHModel <BV >::getBV))
91 return "We provide getBV() and getNumBVs() because BVH may be compressed (in future), so we must provide some flexibility here. \n"
92 "\n"
93 "Access the bv giving the its index ";
94 return "";
95 }
96
97 template <typename BV>
98 inline boost::python::detail::keywords<2> member_func_args (const coal::BVNode < BV > & (coal::BVHModel <BV >::*function_ptr) (unsigned int) const)
99 {
100 if (function_ptr == static_cast<const coal::BVNode < BV > & (coal::BVHModel <BV >::*) (unsigned int) const>(&coal::BVHModel <BV >::getBV))
101 return (boost::python::arg("self"), boost::python::arg("i"));
102 return (boost::python::arg("self"), boost::python::arg("arg0"));
103 }
104
105 template <typename BV>
106 inline const char* member_func_doc ( coal::BVNode < BV > & (coal::BVHModel <BV >::*function_ptr) (unsigned int))
107 {
108 if (function_ptr == static_cast< coal::BVNode < BV > & (coal::BVHModel <BV >::*) (unsigned int)>(&coal::BVHModel <BV >::getBV))
109 return "Access the bv giving the its index. ";
110 return "";
111 }
112
113 template <typename BV>
114 inline boost::python::detail::keywords<2> member_func_args ( coal::BVNode < BV > & (coal::BVHModel <BV >::*function_ptr) (unsigned int))
115 {
116 if (function_ptr == static_cast< coal::BVNode < BV > & (coal::BVHModel <BV >::*) (unsigned int)>(&coal::BVHModel <BV >::getBV))
117 return (boost::python::arg("self"), boost::python::arg("i"));
118 return (boost::python::arg("self"), boost::python::arg("arg0"));
119 }
120
121 template <typename BV>
122 inline const char* member_func_doc (unsigned int (coal::BVHModel <BV >::*function_ptr) () const)
123 {
124 if (function_ptr == static_cast<unsigned int (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNumBVs))
125 return "Get the number of bv in the BVH. ";
126 return "";
127 }
128
129 template <typename BV>
130 inline boost::python::detail::keywords<1> member_func_args (unsigned int (coal::BVHModel <BV >::*function_ptr) () const)
131 {
132 if (function_ptr == static_cast<unsigned int (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNumBVs))
133 return (boost::python::arg("self"));
134 return (boost::python::arg("self"));
135 }
136
137 template <typename BV>
138 inline const char* member_func_doc ( coal::NODE_TYPE (coal::BVHModel <BV >::*function_ptr) () const)
139 {
140 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
141 return "Get the BV type: default is unknown. ";
142 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
143 return "Specialization of getNodeType() for coal::BVHModel with different BV types. ";
144 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
145 return "get the node type ";
146 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
147 return "get the node type ";
148 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
149 return "get the node type ";
150 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
151 return "get the node type ";
152 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
153 return "get the node type ";
154 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
155 return "get the node type ";
156 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
157 return "get the node type ";
158 return "";
159 }
160
161 template <typename BV>
162 inline boost::python::detail::keywords<1> member_func_args ( coal::NODE_TYPE (coal::BVHModel <BV >::*function_ptr) () const)
163 {
164 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
165 return (boost::python::arg("self"));
166 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
167 return (boost::python::arg("self"));
168 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
169 return (boost::python::arg("self"));
170 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
171 return (boost::python::arg("self"));
172 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
173 return (boost::python::arg("self"));
174 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
175 return (boost::python::arg("self"));
176 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
177 return (boost::python::arg("self"));
178 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
179 return (boost::python::arg("self"));
180 if (function_ptr == static_cast< coal::NODE_TYPE (coal::BVHModel <BV >::*) () const>(&coal::BVHModel <BV >::getNodeType))
181 return (boost::python::arg("self"));
182 return (boost::python::arg("self"));
183 }
184
185 template <typename BV>
186 inline const char* member_func_doc (int (coal::BVHModel <BV >::*function_ptr) (const bool) const)
187 {
188 if (function_ptr == static_cast<int (coal::BVHModel <BV >::*) (const bool) const>(&coal::BVHModel <BV >::memUsage))
189 return "Check the number of memory used. ";
190 return "";
191 }
192
193 template <typename BV>
194 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModel <BV >::*function_ptr) (const bool) const)
195 {
196 if (function_ptr == static_cast<int (coal::BVHModel <BV >::*) (const bool) const>(&coal::BVHModel <BV >::memUsage))
197 return (boost::python::arg("self"), boost::python::arg("msg"));
198 return (boost::python::arg("self"), boost::python::arg("arg0"));
199 }
200
201 template <typename BV>
202 inline const char* member_func_doc (void (coal::BVHModel <BV >::*function_ptr) ())
203 {
204 if (function_ptr == static_cast<void (coal::BVHModel <BV >::*) ()>(&coal::BVHModel <BV >::makeParentRelative))
205 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. ";
206 return "";
207 }
208
209 template <typename BV>
210 inline boost::python::detail::keywords<1> member_func_args (void (coal::BVHModel <BV >::*function_ptr) ())
211 {
212 if (function_ptr == static_cast<void (coal::BVHModel <BV >::*) ()>(&coal::BVHModel <BV >::makeParentRelative))
213 return (boost::python::arg("self"));
214 return (boost::python::arg("self"));
215 }
216 } // namespace doxygen
217 #include <coal/BVH/BVH_model.h>
218
219 namespace doxygen {
220
221 template <>
222 struct class_doc_impl< coal::BVHModelBase >
223 {
224 static inline const char* run ()
225 {
226 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) ";
227 }
228 static inline const char* attribute (const char* attrib)
229 {
230 if (strcmp(attrib, "vertices") == 0)
231 return "Geometry point data. ";
232 if (strcmp(attrib, "tri_indices") == 0)
233 return "Geometry triangle index data, will be NULL for point clouds. ";
234 if (strcmp(attrib, "prev_vertices") == 0)
235 return "Geometry point data in previous frame. ";
236 if (strcmp(attrib, "num_tris") == 0)
237 return "Number of triangles. ";
238 if (strcmp(attrib, "num_vertices") == 0)
239 return "Number of points. ";
240 if (strcmp(attrib, "build_state") == 0)
241 return "The state of BVH building process. ";
242 if (strcmp(attrib, "convex") == 0)
243 return "Convex<Triangle> representation of this object. ";
244 (void)attrib; // turn off unused parameter warning.
245 return "";
246 }
247 };
248
249 template <>
250 struct constructor_0_impl< coal::BVHModelBase >
251 {
252 static inline const char* doc ()
253 {
254 return "Constructing an empty BVH. ";
255 }
256 static inline boost::python::detail::keywords<0+1> args ()
257 {
258 return (boost::python::arg("self"));
259 }
260 };
261
262 template <>
263 struct constructor_1_impl< coal::BVHModelBase, const coal::BVHModelBase & >
264 {
265 static inline const char* doc ()
266 {
267 return "copy from another BVH ";
268 }
269 static inline boost::python::detail::keywords<1+1> args ()
270 {
271 return (boost::python::arg("self"), boost::python::arg("other"));
272 }
273 };
274
275 template <>
276 struct destructor_doc_impl < coal::BVHModelBase >
277 {
278 static inline const char* run ()
279 {
280 return "deconstruction, delete mesh data related. ";
281 }
282 };
283
284 inline const char* member_func_doc ( coal::BVHModelType (coal::BVHModelBase::*function_ptr) () const)
285 {
286 if (function_ptr == static_cast< coal::BVHModelType (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::getModelType))
287 return "Model type described by the instance. ";
288 return "";
289 }
290
291 inline boost::python::detail::keywords<1> member_func_args ( coal::BVHModelType (coal::BVHModelBase::*function_ptr) () const)
292 {
293 if (function_ptr == static_cast< coal::BVHModelType (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::getModelType))
294 return (boost::python::arg("self"));
295 return (boost::python::arg("self"));
296 }
297
298 inline const char* member_func_doc ( coal::OBJECT_TYPE (coal::BVHModelBase::*function_ptr) () const)
299 {
300 if (function_ptr == static_cast< coal::OBJECT_TYPE (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::getObjectType))
301 return "Get the object type: it is a BVH. ";
302 return "";
303 }
304
305 inline boost::python::detail::keywords<1> member_func_args ( coal::OBJECT_TYPE (coal::BVHModelBase::*function_ptr) () const)
306 {
307 if (function_ptr == static_cast< coal::OBJECT_TYPE (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::getObjectType))
308 return (boost::python::arg("self"));
309 return (boost::python::arg("self"));
310 }
311
312 inline const char* member_func_doc (void (coal::BVHModelBase::*function_ptr) ())
313 {
314 if (function_ptr == static_cast<void (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::computeLocalAABB))
315 return "Compute the coal::AABB for the BVH, used for broad-phase collision. ";
316 if (function_ptr == static_cast<void (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::makeParentRelative))
317 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. ";
318 return "";
319 }
320
321 inline boost::python::detail::keywords<1> member_func_args (void (coal::BVHModelBase::*function_ptr) ())
322 {
323 if (function_ptr == static_cast<void (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::computeLocalAABB))
324 return (boost::python::arg("self"));
325 if (function_ptr == static_cast<void (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::makeParentRelative))
326 return (boost::python::arg("self"));
327 return (boost::python::arg("self"));
328 }
329
330 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (unsigned int, unsigned int))
331 {
332 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (unsigned int, unsigned int)>(&coal::BVHModelBase::beginModel))
333 return "Begin a new BVH model. ";
334 return "";
335 }
336
337 inline boost::python::detail::keywords<3> member_func_args (int (coal::BVHModelBase::*function_ptr) (unsigned int, unsigned int))
338 {
339 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (unsigned int, unsigned int)>(&coal::BVHModelBase::beginModel))
340 return (boost::python::arg("self"), boost::python::arg("num_tris"), boost::python::arg("num_vertices"));
341 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
342 }
343
344 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const coal::Vec3s &))
345 {
346 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::addVertex))
347 return "Add one point in the new BVH model. ";
348 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::replaceVertex))
349 return "Replace one point in the old BVH model. ";
350 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::updateVertex))
351 return "Update one point in the old BVH model. ";
352 return "";
353 }
354
355 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModelBase::*function_ptr) (const coal::Vec3s &))
356 {
357 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::addVertex))
358 return (boost::python::arg("self"), boost::python::arg("p"));
359 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::replaceVertex))
360 return (boost::python::arg("self"), boost::python::arg("p"));
361 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &)>(&coal::BVHModelBase::updateVertex))
362 return (boost::python::arg("self"), boost::python::arg("p"));
363 return (boost::python::arg("self"), boost::python::arg("arg0"));
364 }
365
366 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const coal::MatrixX3s &))
367 {
368 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::MatrixX3s &)>(&coal::BVHModelBase::addVertices))
369 return "Add points in the new BVH model. ";
370 return "";
371 }
372
373 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModelBase::*function_ptr) (const coal::MatrixX3s &))
374 {
375 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::MatrixX3s &)>(&coal::BVHModelBase::addVertices))
376 return (boost::python::arg("self"), boost::python::arg("points"));
377 return (boost::python::arg("self"), boost::python::arg("arg0"));
378 }
379
380 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const coal::Matrixx3i &))
381 {
382 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Matrixx3i &)>(&coal::BVHModelBase::addTriangles))
383 return "Add triangles in the new BVH model. ";
384 return "";
385 }
386
387 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModelBase::*function_ptr) (const coal::Matrixx3i &))
388 {
389 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Matrixx3i &)>(&coal::BVHModelBase::addTriangles))
390 return (boost::python::arg("self"), boost::python::arg("triangles"));
391 return (boost::python::arg("self"), boost::python::arg("arg0"));
392 }
393
394 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &))
395 {
396 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::addTriangle))
397 return "Add one triangle in the new BVH model. ";
398 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::replaceTriangle))
399 return "Replace one triangle in the old BVH model. ";
400 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::updateTriangle))
401 return "Update one triangle in the old BVH model. ";
402 return "";
403 }
404
405 inline boost::python::detail::keywords<4> member_func_args (int (coal::BVHModelBase::*function_ptr) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &))
406 {
407 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::addTriangle))
408 return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
409 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::replaceTriangle))
410 return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
411 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const coal::Vec3s &, const coal::Vec3s &, const coal::Vec3s &)>(&coal::BVHModelBase::updateTriangle))
412 return (boost::python::arg("self"), boost::python::arg("p1"), boost::python::arg("p2"), boost::python::arg("p3"));
413 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
414 }
415
416 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const std::vector< coal::Vec3s > &, const std::vector< coal::Triangle > &))
417 {
418 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &, const std::vector< coal::Triangle > &)>(&coal::BVHModelBase::addSubModel))
419 return "Add a set of triangles in the new BVH model. ";
420 return "";
421 }
422
423 inline boost::python::detail::keywords<3> member_func_args (int (coal::BVHModelBase::*function_ptr) (const std::vector< coal::Vec3s > &, const std::vector< coal::Triangle > &))
424 {
425 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &, const std::vector< coal::Triangle > &)>(&coal::BVHModelBase::addSubModel))
426 return (boost::python::arg("self"), boost::python::arg("ps"), boost::python::arg("ts"));
427 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
428 }
429
430 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const std::vector< coal::Vec3s > &))
431 {
432 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::addSubModel))
433 return "Add a set of points in the new BVH model. ";
434 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::replaceSubModel))
435 return "Replace a set of points in the old BVH model. ";
436 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::updateSubModel))
437 return "Update a set of points in the old BVH model. ";
438 return "";
439 }
440
441 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModelBase::*function_ptr) (const std::vector< coal::Vec3s > &))
442 {
443 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::addSubModel))
444 return (boost::python::arg("self"), boost::python::arg("ps"));
445 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::replaceSubModel))
446 return (boost::python::arg("self"), boost::python::arg("ps"));
447 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const std::vector< coal::Vec3s > &)>(&coal::BVHModelBase::updateSubModel))
448 return (boost::python::arg("self"), boost::python::arg("ps"));
449 return (boost::python::arg("self"), boost::python::arg("arg0"));
450 }
451
452 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) ())
453 {
454 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::endModel))
455 return "End BVH model construction, will build the bounding volume hierarchy. ";
456 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::beginReplaceModel))
457 return "Replace the geometry information of current frame (i.e. should have the same mesh topology with the previous frame) ";
458 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::beginUpdateModel))
459 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. ";
460 return "";
461 }
462
463 inline boost::python::detail::keywords<1> member_func_args (int (coal::BVHModelBase::*function_ptr) ())
464 {
465 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::endModel))
466 return (boost::python::arg("self"));
467 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::beginReplaceModel))
468 return (boost::python::arg("self"));
469 if (function_ptr == static_cast<int (coal::BVHModelBase::*) ()>(&coal::BVHModelBase::beginUpdateModel))
470 return (boost::python::arg("self"));
471 return (boost::python::arg("self"));
472 }
473
474 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (bool, bool))
475 {
476 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (bool, bool)>(&coal::BVHModelBase::endReplaceModel))
477 return "End BVH model replacement, will also refit or rebuild the bounding volume hierarchy. ";
478 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (bool, bool)>(&coal::BVHModelBase::endUpdateModel))
479 return "End BVH model update, will also refit or rebuild the bounding volume hierarchy. ";
480 return "";
481 }
482
483 inline boost::python::detail::keywords<3> member_func_args (int (coal::BVHModelBase::*function_ptr) (bool, bool))
484 {
485 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (bool, bool)>(&coal::BVHModelBase::endReplaceModel))
486 return (boost::python::arg("self"), boost::python::arg("refit"), boost::python::arg("bottomup"));
487 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (bool, bool)>(&coal::BVHModelBase::endUpdateModel))
488 return (boost::python::arg("self"), boost::python::arg("refit"), boost::python::arg("bottomup"));
489 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
490 }
491
492 inline const char* member_func_doc (void (coal::BVHModelBase::*function_ptr) (bool))
493 {
494 if (function_ptr == static_cast<void (coal::BVHModelBase::*) (bool)>(&coal::BVHModelBase::buildConvexRepresentation))
495 return "Build this coal::Convex representation of this model. The result is stored in attribute convex. \n"
496 "\n"
497 "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. ";
498 return "";
499 }
500
501 inline boost::python::detail::keywords<2> member_func_args (void (coal::BVHModelBase::*function_ptr) (bool))
502 {
503 if (function_ptr == static_cast<void (coal::BVHModelBase::*) (bool)>(&coal::BVHModelBase::buildConvexRepresentation))
504 return (boost::python::arg("self"), boost::python::arg("share_memory"));
505 return (boost::python::arg("self"), boost::python::arg("arg0"));
506 }
507
508 inline const char* member_func_doc (bool (coal::BVHModelBase::*function_ptr) (bool, const char *))
509 {
510 if (function_ptr == static_cast<bool (coal::BVHModelBase::*) (bool, const char *)>(&coal::BVHModelBase::buildConvexHull))
511 return "Build a convex hull and store it in attribute convex. \n"
512 "\n"
513 "\n"
514 "Param\n"
515 " - keepTriangle whether the convex should be triangulated. \n"
516 " - qhullCommand see ConvexBase::convexHull. \n"
517 "\n"
518 "Return: true if this object is convex, hence the convex hull represents the same object. \n"
519 "\n"
520 "See: ConvexBase::convexHull \n"
521 "\n"
522 "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). ";
523 return "";
524 }
525
526 inline boost::python::detail::keywords<3> member_func_args (bool (coal::BVHModelBase::*function_ptr) (bool, const char *))
527 {
528 if (function_ptr == static_cast<bool (coal::BVHModelBase::*) (bool, const char *)>(&coal::BVHModelBase::buildConvexHull))
529 return (boost::python::arg("self"), boost::python::arg("keepTriangle"), boost::python::arg("qhullCommand"));
530 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
531 }
532
533 inline const char* member_func_doc (int (coal::BVHModelBase::*function_ptr) (const bool) const)
534 {
535 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const bool) const>(&coal::BVHModelBase::memUsage))
536 return "";
537 return "";
538 }
539
540 inline boost::python::detail::keywords<2> member_func_args (int (coal::BVHModelBase::*function_ptr) (const bool) const)
541 {
542 if (function_ptr == static_cast<int (coal::BVHModelBase::*) (const bool) const>(&coal::BVHModelBase::memUsage))
543 return (boost::python::arg("self"), boost::python::arg("msg"));
544 return (boost::python::arg("self"), boost::python::arg("arg0"));
545 }
546
547 inline const char* member_func_doc ( coal::Vec3s (coal::BVHModelBase::*function_ptr) () const)
548 {
549 if (function_ptr == static_cast< coal::Vec3s (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeCOM))
550 return "compute center of mass ";
551 return "";
552 }
553
554 inline boost::python::detail::keywords<1> member_func_args ( coal::Vec3s (coal::BVHModelBase::*function_ptr) () const)
555 {
556 if (function_ptr == static_cast< coal::Vec3s (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeCOM))
557 return (boost::python::arg("self"));
558 return (boost::python::arg("self"));
559 }
560
561 inline const char* member_func_doc ( coal::Scalar (coal::BVHModelBase::*function_ptr) () const)
562 {
563 if (function_ptr == static_cast< coal::Scalar (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeVolume))
564 return "compute the volume ";
565 return "";
566 }
567
568 inline boost::python::detail::keywords<1> member_func_args ( coal::Scalar (coal::BVHModelBase::*function_ptr) () const)
569 {
570 if (function_ptr == static_cast< coal::Scalar (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeVolume))
571 return (boost::python::arg("self"));
572 return (boost::python::arg("self"));
573 }
574
575 inline const char* member_func_doc ( coal::Matrix3s (coal::BVHModelBase::*function_ptr) () const)
576 {
577 if (function_ptr == static_cast< coal::Matrix3s (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeMomentofInertia))
578 return "compute the inertia matrix, related to the origin ";
579 return "";
580 }
581
582 inline boost::python::detail::keywords<1> member_func_args ( coal::Matrix3s (coal::BVHModelBase::*function_ptr) () const)
583 {
584 if (function_ptr == static_cast< coal::Matrix3s (coal::BVHModelBase::*) () const>(&coal::BVHModelBase::computeMomentofInertia))
585 return (boost::python::arg("self"));
586 return (boost::python::arg("self"));
587 }
588 } // namespace doxygen
589
590 #endif // DOXYGEN_AUTODOC_COAL_BVH_BVH_MODEL_H
591
592