GCC Code Coverage Report

Directory: ./
File: python/doxygen_autodoc/coal/broadphase/default_broadphase_callbacks.h
Date: 2025-04-01 09:23:31
Exec Total Coverage
Lines: 33 36 91.7%
Branches: 14 22 63.6%
Line Branch Exec Source
1 #ifndef DOXYGEN_AUTODOC_COAL_BROADPHASE_DEFAULT_BROADPHASE_CALLBACKS_H
2 #define DOXYGEN_AUTODOC_COAL_BROADPHASE_DEFAULT_BROADPHASE_CALLBACKS_H
3
4 #include "/root/robotpkg/path/py-coal/work/coal-3.0.1/doc/python/doxygen.hh"
5
6 #include <coal/broadphase/default_broadphase_callbacks.h>
7
8 namespace doxygen {
9
10 template <>
11 struct class_doc_impl< coal::CollisionCallBackCollect >
12 {
13 static inline const char* run ()
14 {
15 return "Collision callback to collect collision pairs potentially in contacts. ";
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 <>
25 struct constructor_1_impl< coal::CollisionCallBackCollect, const size_t >
26 {
27 5 static inline const char* doc ()
28 {
29 5 return "Default constructor. ";
30 }
31 5 static inline boost::python::detail::keywords<1+1> args ()
32 {
33
2/4
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5 times.
✗ Branch 6 not taken.
 10 return (boost::python::arg("self"), boost::python::arg("max_size"));
34 }
35 };
36
37 template <>
38 struct destructor_doc_impl < coal::CollisionCallBackCollect >
39 {
40 static inline const char* run ()
41 {
42 return "";
43 }
44 };
45
46 inline const char* member_func_doc (bool (coal::CollisionCallBackCollect::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *))
47 {
48 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) ( coal::CollisionObject *, coal::CollisionObject *)>(&coal::CollisionCallBackCollect::collide))
49 return "Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. \n"
50 "\n"
51 "\n"
52 "Param\n"
53 " - o1 Collision object #1. \n"
54 " - o2 Collision object #2. ";
55 return "";
56 }
57
58 inline boost::python::detail::keywords<3> member_func_args (bool (coal::CollisionCallBackCollect::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *))
59 {
60 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) ( coal::CollisionObject *, coal::CollisionObject *)>(&coal::CollisionCallBackCollect::collide))
61 return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"));
62 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
63 }
64
65 inline const char* member_func_doc (size_t (coal::CollisionCallBackCollect::*function_ptr) () const)
66 {
67 if (function_ptr == static_cast<size_t (coal::CollisionCallBackCollect::*) () const>(&coal::CollisionCallBackCollect::numCollisionPairs))
68 return "Returns the number of registered collision pairs. ";
69 return "";
70 }
71
72 inline boost::python::detail::keywords<1> member_func_args (size_t (coal::CollisionCallBackCollect::*function_ptr) () const)
73 {
74 if (function_ptr == static_cast<size_t (coal::CollisionCallBackCollect::*) () const>(&coal::CollisionCallBackCollect::numCollisionPairs))
75 return (boost::python::arg("self"));
76 return (boost::python::arg("self"));
77 }
78
79 5 inline const char* member_func_doc (const std::vector< coal::CollisionCallBackCollect::CollisionPair > & (coal::CollisionCallBackCollect::*function_ptr) () const)
80 {
81
2/6
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 5 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 5 if (function_ptr == static_cast<const std::vector< coal::CollisionCallBackCollect::CollisionPair > & (coal::CollisionCallBackCollect::*) () const>(&coal::CollisionCallBackCollect::getCollisionPairs))
82 5 return "Returns a const reference to the active collision_pairs to check. ";
83 ✗ return "";
84 }
85
86 inline boost::python::detail::keywords<1> member_func_args (const std::vector< coal::CollisionCallBackCollect::CollisionPair > & (coal::CollisionCallBackCollect::*function_ptr) () const)
87 {
88 if (function_ptr == static_cast<const std::vector< coal::CollisionCallBackCollect::CollisionPair > & (coal::CollisionCallBackCollect::*) () const>(&coal::CollisionCallBackCollect::getCollisionPairs))
89 return (boost::python::arg("self"));
90 return (boost::python::arg("self"));
91 }
92
93 inline const char* member_func_doc (void (coal::CollisionCallBackCollect::*function_ptr) ())
94 {
95 if (function_ptr == static_cast<void (coal::CollisionCallBackCollect::*) ()>(&coal::CollisionCallBackCollect::init))
96 return "Reset the callback. ";
97 return "";
98 }
99
100 inline boost::python::detail::keywords<1> member_func_args (void (coal::CollisionCallBackCollect::*function_ptr) ())
101 {
102 if (function_ptr == static_cast<void (coal::CollisionCallBackCollect::*) ()>(&coal::CollisionCallBackCollect::init))
103 return (boost::python::arg("self"));
104 return (boost::python::arg("self"));
105 }
106
107 inline const char* member_func_doc (bool (coal::CollisionCallBackCollect::*function_ptr) (const coal::CollisionCallBackCollect::CollisionPair &) const)
108 {
109 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) (const coal::CollisionCallBackCollect::CollisionPair &) const>(&coal::CollisionCallBackCollect::exist))
110 return "Check whether a collision pair exists. ";
111 return "";
112 }
113
114 inline boost::python::detail::keywords<2> member_func_args (bool (coal::CollisionCallBackCollect::*function_ptr) (const coal::CollisionCallBackCollect::CollisionPair &) const)
115 {
116 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) (const coal::CollisionCallBackCollect::CollisionPair &) const>(&coal::CollisionCallBackCollect::exist))
117 return (boost::python::arg("self"), boost::python::arg("pair"));
118 return (boost::python::arg("self"), boost::python::arg("arg0"));
119 }
120
121 inline const char* member_func_doc (bool (coal::CollisionCallBackCollect::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *) const)
122 {
123 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) ( coal::CollisionObject *, coal::CollisionObject *) const>(&coal::CollisionCallBackCollect::exist))
124 return "Check whether a collision pair exists. ";
125 return "";
126 }
127
128 inline boost::python::detail::keywords<3> member_func_args (bool (coal::CollisionCallBackCollect::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *) const)
129 {
130 if (function_ptr == static_cast<bool (coal::CollisionCallBackCollect::*) ( coal::CollisionObject *, coal::CollisionObject *) const>(&coal::CollisionCallBackCollect::exist))
131 return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"));
132 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
133 }
134 } // namespace doxygen
135 #include <coal/broadphase/default_broadphase_callbacks.h>
136
137 namespace doxygen {
138
139 template <>
140 struct class_doc_impl< coal::CollisionCallBackDefault >
141 {
142 static inline const char* run ()
143 {
144 return "Default collision callback to check collision between collision objects. ";
145 }
146 5 static inline const char* attribute (const char* attrib)
147 {
148 (void)attrib; // turn off unused parameter warning.
149 5 return "";
150 }
151 };
152
153 template <>
154 struct destructor_doc_impl < coal::CollisionCallBackDefault >
155 {
156 static inline const char* run ()
157 {
158 return "";
159 }
160 };
161
162 inline const char* member_func_doc (void (coal::CollisionCallBackDefault::*function_ptr) ())
163 {
164 if (function_ptr == static_cast<void (coal::CollisionCallBackDefault::*) ()>(&coal::CollisionCallBackDefault::init))
165 return "Initialize the callback. Clears the collision result and sets the done boolean to false. ";
166 return "";
167 }
168
169 inline boost::python::detail::keywords<1> member_func_args (void (coal::CollisionCallBackDefault::*function_ptr) ())
170 {
171 if (function_ptr == static_cast<void (coal::CollisionCallBackDefault::*) ()>(&coal::CollisionCallBackDefault::init))
172 return (boost::python::arg("self"));
173 return (boost::python::arg("self"));
174 }
175
176 inline const char* member_func_doc (bool (coal::CollisionCallBackDefault::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *))
177 {
178 if (function_ptr == static_cast<bool (coal::CollisionCallBackDefault::*) ( coal::CollisionObject *, coal::CollisionObject *)>(&coal::CollisionCallBackDefault::collide))
179 return "Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. \n"
180 "\n"
181 "\n"
182 "Param\n"
183 " - o1 Collision object #1. \n"
184 " - o2 Collision object #2. ";
185 return "";
186 }
187
188 inline boost::python::detail::keywords<3> member_func_args (bool (coal::CollisionCallBackDefault::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *))
189 {
190 if (function_ptr == static_cast<bool (coal::CollisionCallBackDefault::*) ( coal::CollisionObject *, coal::CollisionObject *)>(&coal::CollisionCallBackDefault::collide))
191 return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"));
192 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
193 }
194 } // namespace doxygen
195 #include <coal/broadphase/default_broadphase_callbacks.h>
196
197 namespace doxygen {
198
199 template <>
200 struct class_doc_impl< coal::CollisionData >
201 {
202 static inline const char* run ()
203 {
204 return "Collision data stores the collision request and the result given by collision algorithm. ";
205 }
206 15 static inline const char* attribute (const char* attrib)
207 {
208
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 10 times.
 15 if (strcmp(attrib, "request") == 0)
209 5 return "Collision request. ";
210
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
 10 if (strcmp(attrib, "result") == 0)
211 5 return "Collision result. ";
212
1/2
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
 5 if (strcmp(attrib, "done") == 0)
213 5 return "Whether the collision iteration can stop. ";
214 (void)attrib; // turn off unused parameter warning.
215 ✗ return "";
216 }
217 };
218
219 template <>
220 struct constructor_0_impl< coal::CollisionData >
221 {
222 5 static inline const char* doc ()
223 {
224 5 return "";
225 }
226 5 static inline boost::python::detail::keywords<0+1> args ()
227 {
228 5 return (boost::python::arg("self"));
229 }
230 };
231
232 inline const char* member_func_doc (void (coal::CollisionData::*function_ptr) ())
233 {
234 if (function_ptr == static_cast<void (coal::CollisionData::*) ()>(&coal::CollisionData::clear))
235 return "Clears the coal::CollisionData. ";
236 return "";
237 }
238
239 inline boost::python::detail::keywords<1> member_func_args (void (coal::CollisionData::*function_ptr) ())
240 {
241 if (function_ptr == static_cast<void (coal::CollisionData::*) ()>(&coal::CollisionData::clear))
242 return (boost::python::arg("self"));
243 return (boost::python::arg("self"));
244 }
245 } // namespace doxygen
246 #include <coal/broadphase/default_broadphase_callbacks.h>
247
248 namespace doxygen {
249
250 template <>
251 struct class_doc_impl< coal::DistanceCallBackDefault >
252 {
253 static inline const char* run ()
254 {
255 return "Default distance callback to check collision between collision objects. ";
256 }
257 5 static inline const char* attribute (const char* attrib)
258 {
259 (void)attrib; // turn off unused parameter warning.
260 5 return "";
261 }
262 };
263
264 template <>
265 struct destructor_doc_impl < coal::DistanceCallBackDefault >
266 {
267 static inline const char* run ()
268 {
269 return "";
270 }
271 };
272
273 inline const char* member_func_doc (void (coal::DistanceCallBackDefault::*function_ptr) ())
274 {
275 if (function_ptr == static_cast<void (coal::DistanceCallBackDefault::*) ()>(&coal::DistanceCallBackDefault::init))
276 return "Initialize the callback. Clears the distance result and sets the done boolean to false. ";
277 return "";
278 }
279
280 inline boost::python::detail::keywords<1> member_func_args (void (coal::DistanceCallBackDefault::*function_ptr) ())
281 {
282 if (function_ptr == static_cast<void (coal::DistanceCallBackDefault::*) ()>(&coal::DistanceCallBackDefault::init))
283 return (boost::python::arg("self"));
284 return (boost::python::arg("self"));
285 }
286
287 inline const char* member_func_doc (bool (coal::DistanceCallBackDefault::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *, coal::Scalar &))
288 {
289 if (function_ptr == static_cast<bool (coal::DistanceCallBackDefault::*) ( coal::CollisionObject *, coal::CollisionObject *, coal::Scalar &)>(&coal::DistanceCallBackDefault::distance))
290 return "Distance evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. \n"
291 "\n"
292 "\n"
293 "Param\n"
294 " - o1 Collision object #1. \n"
295 " - o2 Collision object #2. \n"
296 " - dist Distance between the two collision geometries. ";
297 return "";
298 }
299
300 inline boost::python::detail::keywords<4> member_func_args (bool (coal::DistanceCallBackDefault::*function_ptr) ( coal::CollisionObject *, coal::CollisionObject *, coal::Scalar &))
301 {
302 if (function_ptr == static_cast<bool (coal::DistanceCallBackDefault::*) ( coal::CollisionObject *, coal::CollisionObject *, coal::Scalar &)>(&coal::DistanceCallBackDefault::distance))
303 return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"), boost::python::arg("dist"));
304 return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
305 }
306 } // namespace doxygen
307 #include <coal/broadphase/default_broadphase_callbacks.h>
308
309 namespace doxygen {
310
311 template <>
312 struct class_doc_impl< coal::DistanceData >
313 {
314 static inline const char* run ()
315 {
316 return "Distance data stores the distance request and the result given by distance algorithm. ";
317 }
318 15 static inline const char* attribute (const char* attrib)
319 {
320
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 10 times.
 15 if (strcmp(attrib, "request") == 0)
321 5 return "Distance request. ";
322
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
 10 if (strcmp(attrib, "result") == 0)
323 5 return "Distance result. ";
324
1/2
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
 5 if (strcmp(attrib, "done") == 0)
325 5 return "Whether the distance iteration can stop. ";
326 (void)attrib; // turn off unused parameter warning.
327 ✗ return "";
328 }
329 };
330
331 template <>
332 struct constructor_0_impl< coal::DistanceData >
333 {
334 5 static inline const char* doc ()
335 {
336 5 return "";
337 }
338 5 static inline boost::python::detail::keywords<0+1> args ()
339 {
340 5 return (boost::python::arg("self"));
341 }
342 };
343
344 inline const char* member_func_doc (void (coal::DistanceData::*function_ptr) ())
345 {
346 if (function_ptr == static_cast<void (coal::DistanceData::*) ()>(&coal::DistanceData::clear))
347 return "Clears the coal::DistanceData. ";
348 return "";
349 }
350
351 inline boost::python::detail::keywords<1> member_func_args (void (coal::DistanceData::*function_ptr) ())
352 {
353 if (function_ptr == static_cast<void (coal::DistanceData::*) ()>(&coal::DistanceData::clear))
354 return (boost::python::arg("self"));
355 return (boost::python::arg("self"));
356 }
357 } // namespace doxygen
358
359 #endif // DOXYGEN_AUTODOC_COAL_BROADPHASE_DEFAULT_BROADPHASE_CALLBACKS_H
360
361