Directory: | ./ |
---|---|
File: | python/doxygen_autodoc/coal/octree.h |
Date: | 2025-04-01 09:23:31 |
Exec | Total | Coverage | |
---|---|---|---|
Lines: | 12 | 14 | 85.7% |
Branches: | 6 | 16 | 37.5% |
Line | Branch | Exec | Source |
---|---|---|---|
1 | #ifndef DOXYGEN_AUTODOC_COAL_OCTREE_H | ||
2 | #define DOXYGEN_AUTODOC_COAL_OCTREE_H | ||
3 | |||
4 | #include "/root/robotpkg/path/py-coal/work/coal-3.0.1/doc/python/doxygen.hh" | ||
5 | |||
6 | #include <coal/octree.h> | ||
7 | |||
8 | namespace doxygen { | ||
9 | |||
10 | template <> | ||
11 | struct class_doc_impl< coal::OcTree > | ||
12 | { | ||
13 | 5 | static inline const char* run () | |
14 | { | ||
15 | 5 | return "Octree is one type of collision geometry which can encode uncertainty information in the sensor data. "; | |
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::OcTree, coal::Scalar > | ||
26 | { | ||
27 | 5 | static inline const char* doc () | |
28 | { | ||
29 | 5 | return "construct octree with a given resolution "; | |
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("resolution")); |
34 | } | ||
35 | }; | ||
36 | |||
37 | template <> | ||
38 | struct constructor_1_impl< coal::OcTree, const shared_ptr< const octomap::OcTree > & > | ||
39 | { | ||
40 | static inline const char* doc () | ||
41 | { | ||
42 | return "construct octree from octomap "; | ||
43 | } | ||
44 | static inline boost::python::detail::keywords<1+1> args () | ||
45 | { | ||
46 | return (boost::python::arg("self"), boost::python::arg("tree_")); | ||
47 | } | ||
48 | }; | ||
49 | |||
50 | template <> | ||
51 | struct constructor_1_impl< coal::OcTree, const coal::OcTree & > | ||
52 | { | ||
53 | static inline const char* doc () | ||
54 | { | ||
55 | return "Copy constructor "; | ||
56 | } | ||
57 | static inline boost::python::detail::keywords<1+1> args () | ||
58 | { | ||
59 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
60 | } | ||
61 | }; | ||
62 | |||
63 | 5 | inline const char* member_func_doc ( coal::OcTree * (coal::OcTree::*function_ptr) () const) | |
64 | { | ||
65 |
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< coal::OcTree * (coal::OcTree::*) () const>(&coal::OcTree::clone)) |
66 | 5 | return "Clone *this into a new Octree. "; | |
67 | ✗ | return ""; | |
68 | } | ||
69 | |||
70 | inline boost::python::detail::keywords<1> member_func_args ( coal::OcTree * (coal::OcTree::*function_ptr) () const) | ||
71 | { | ||
72 | if (function_ptr == static_cast< coal::OcTree * (coal::OcTree::*) () const>(&coal::OcTree::clone)) | ||
73 | return (boost::python::arg("self")); | ||
74 | return (boost::python::arg("self")); | ||
75 | } | ||
76 | |||
77 | inline const char* member_func_doc (shared_ptr< const octomap::OcTree > (coal::OcTree::*function_ptr) () const) | ||
78 | { | ||
79 | if (function_ptr == static_cast<shared_ptr< const octomap::OcTree > (coal::OcTree::*) () const>(&coal::OcTree::getTree)) | ||
80 | return "Returns the tree associated to the underlying octomap coal::OcTree. "; | ||
81 | return ""; | ||
82 | } | ||
83 | |||
84 | inline boost::python::detail::keywords<1> member_func_args (shared_ptr< const octomap::OcTree > (coal::OcTree::*function_ptr) () const) | ||
85 | { | ||
86 | if (function_ptr == static_cast<shared_ptr< const octomap::OcTree > (coal::OcTree::*) () const>(&coal::OcTree::getTree)) | ||
87 | return (boost::python::arg("self")); | ||
88 | return (boost::python::arg("self")); | ||
89 | } | ||
90 | |||
91 | inline const char* member_func_doc (void (coal::OcTree::*function_ptr) (const std::string &) const) | ||
92 | { | ||
93 | if (function_ptr == static_cast<void (coal::OcTree::*) (const std::string &) const>(&coal::OcTree::exportAsObjFile)) | ||
94 | return ""; | ||
95 | return ""; | ||
96 | } | ||
97 | |||
98 | inline boost::python::detail::keywords<2> member_func_args (void (coal::OcTree::*function_ptr) (const std::string &) const) | ||
99 | { | ||
100 | if (function_ptr == static_cast<void (coal::OcTree::*) (const std::string &) const>(&coal::OcTree::exportAsObjFile)) | ||
101 | return (boost::python::arg("self"), boost::python::arg("filename")); | ||
102 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
103 | } | ||
104 | |||
105 | inline const char* member_func_doc (void (coal::OcTree::*function_ptr) ()) | ||
106 | { | ||
107 | if (function_ptr == static_cast<void (coal::OcTree::*) ()>(&coal::OcTree::computeLocalAABB)) | ||
108 | return "compute the coal::AABB for the octree in its local coordinate system "; | ||
109 | return ""; | ||
110 | } | ||
111 | |||
112 | inline boost::python::detail::keywords<1> member_func_args (void (coal::OcTree::*function_ptr) ()) | ||
113 | { | ||
114 | if (function_ptr == static_cast<void (coal::OcTree::*) ()>(&coal::OcTree::computeLocalAABB)) | ||
115 | return (boost::python::arg("self")); | ||
116 | return (boost::python::arg("self")); | ||
117 | } | ||
118 | |||
119 | inline const char* member_func_doc ( coal::AABB (coal::OcTree::*function_ptr) () const) | ||
120 | { | ||
121 | if (function_ptr == static_cast< coal::AABB (coal::OcTree::*) () const>(&coal::OcTree::getRootBV)) | ||
122 | return "get the bounding volume for the root "; | ||
123 | return ""; | ||
124 | } | ||
125 | |||
126 | inline boost::python::detail::keywords<1> member_func_args ( coal::AABB (coal::OcTree::*function_ptr) () const) | ||
127 | { | ||
128 | if (function_ptr == static_cast< coal::AABB (coal::OcTree::*) () const>(&coal::OcTree::getRootBV)) | ||
129 | return (boost::python::arg("self")); | ||
130 | return (boost::python::arg("self")); | ||
131 | } | ||
132 | |||
133 | inline const char* member_func_doc (unsigned int (coal::OcTree::*function_ptr) () const) | ||
134 | { | ||
135 | if (function_ptr == static_cast<unsigned int (coal::OcTree::*) () const>(&coal::OcTree::getTreeDepth)) | ||
136 | return "Returns the depth of the octree. "; | ||
137 | return ""; | ||
138 | } | ||
139 | |||
140 | inline boost::python::detail::keywords<1> member_func_args (unsigned int (coal::OcTree::*function_ptr) () const) | ||
141 | { | ||
142 | if (function_ptr == static_cast<unsigned int (coal::OcTree::*) () const>(&coal::OcTree::getTreeDepth)) | ||
143 | return (boost::python::arg("self")); | ||
144 | return (boost::python::arg("self")); | ||
145 | } | ||
146 | |||
147 | inline const char* member_func_doc (unsigned long (coal::OcTree::*function_ptr) () const) | ||
148 | { | ||
149 | if (function_ptr == static_cast<unsigned long (coal::OcTree::*) () const>(&coal::OcTree::size)) | ||
150 | return "Returns the size of the octree. "; | ||
151 | return ""; | ||
152 | } | ||
153 | |||
154 | inline boost::python::detail::keywords<1> member_func_args (unsigned long (coal::OcTree::*function_ptr) () const) | ||
155 | { | ||
156 | if (function_ptr == static_cast<unsigned long (coal::OcTree::*) () const>(&coal::OcTree::size)) | ||
157 | return (boost::python::arg("self")); | ||
158 | return (boost::python::arg("self")); | ||
159 | } | ||
160 | |||
161 | inline const char* member_func_doc ( coal::Scalar (coal::OcTree::*function_ptr) () const) | ||
162 | { | ||
163 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getResolution)) | ||
164 | return "Returns the resolution of the octree. "; | ||
165 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getOccupancyThres)) | ||
166 | return "the threshold used to decide whether one node is occupied, this is NOT the octree occupied_thresold "; | ||
167 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getFreeThres)) | ||
168 | return "the threshold used to decide whether one node is free, this is NOT the octree free_threshold "; | ||
169 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getDefaultOccupancy)) | ||
170 | return ""; | ||
171 | return ""; | ||
172 | } | ||
173 | |||
174 | inline boost::python::detail::keywords<1> member_func_args ( coal::Scalar (coal::OcTree::*function_ptr) () const) | ||
175 | { | ||
176 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getResolution)) | ||
177 | return (boost::python::arg("self")); | ||
178 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getOccupancyThres)) | ||
179 | return (boost::python::arg("self")); | ||
180 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getFreeThres)) | ||
181 | return (boost::python::arg("self")); | ||
182 | if (function_ptr == static_cast< coal::Scalar (coal::OcTree::*) () const>(&coal::OcTree::getDefaultOccupancy)) | ||
183 | return (boost::python::arg("self")); | ||
184 | return (boost::python::arg("self")); | ||
185 | } | ||
186 | |||
187 | inline const char* member_func_doc ( coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) () const) | ||
188 | { | ||
189 | if (function_ptr == static_cast< coal::OcTree::OcTreeNode * (coal::OcTree::*) () const>(&coal::OcTree::getRoot)) | ||
190 | return "get the root node of the octree "; | ||
191 | return ""; | ||
192 | } | ||
193 | |||
194 | inline boost::python::detail::keywords<1> member_func_args ( coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) () const) | ||
195 | { | ||
196 | if (function_ptr == static_cast< coal::OcTree::OcTreeNode * (coal::OcTree::*) () const>(&coal::OcTree::getRoot)) | ||
197 | return (boost::python::arg("self")); | ||
198 | return (boost::python::arg("self")); | ||
199 | } | ||
200 | |||
201 | inline const char* member_func_doc (bool (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *) const) | ||
202 | { | ||
203 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeOccupied)) | ||
204 | return "whether one node is completely occupied "; | ||
205 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeFree)) | ||
206 | return "whether one node is completely free "; | ||
207 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeUncertain)) | ||
208 | return "whether one node is uncertain "; | ||
209 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::nodeHasChildren)) | ||
210 | return "return true if node has at least one child "; | ||
211 | return ""; | ||
212 | } | ||
213 | |||
214 | inline boost::python::detail::keywords<2> member_func_args (bool (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *) const) | ||
215 | { | ||
216 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeOccupied)) | ||
217 | return (boost::python::arg("self"), boost::python::arg("node")); | ||
218 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeFree)) | ||
219 | return (boost::python::arg("self"), boost::python::arg("node")); | ||
220 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::isNodeUncertain)) | ||
221 | return (boost::python::arg("self"), boost::python::arg("node")); | ||
222 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *) const>(&coal::OcTree::nodeHasChildren)) | ||
223 | return (boost::python::arg("self"), boost::python::arg("node")); | ||
224 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
225 | } | ||
226 | |||
227 | inline const char* member_func_doc (std::vector< coal::Vec6s > (coal::OcTree::*function_ptr) () const) | ||
228 | { | ||
229 | if (function_ptr == static_cast<std::vector< coal::Vec6s > (coal::OcTree::*) () const>(&coal::OcTree::toBoxes)) | ||
230 | return "transform the octree into a bunch of boxes; uncertainty information is kept in the boxes. However, we only keep the occupied boxes (i.e., the boxes whose occupied probability is higher enough). "; | ||
231 | return ""; | ||
232 | } | ||
233 | |||
234 | inline boost::python::detail::keywords<1> member_func_args (std::vector< coal::Vec6s > (coal::OcTree::*function_ptr) () const) | ||
235 | { | ||
236 | if (function_ptr == static_cast<std::vector< coal::Vec6s > (coal::OcTree::*) () const>(&coal::OcTree::toBoxes)) | ||
237 | return (boost::python::arg("self")); | ||
238 | return (boost::python::arg("self")); | ||
239 | } | ||
240 | |||
241 | 5 | inline const char* member_func_doc (std::vector< uint8_t > (coal::OcTree::*function_ptr) () const) | |
242 | { | ||
243 |
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<std::vector< uint8_t > (coal::OcTree::*) () const>(&coal::OcTree::tobytes)) |
244 | 5 | return "Returns a byte description of *this. "; | |
245 | ✗ | return ""; | |
246 | } | ||
247 | |||
248 | inline boost::python::detail::keywords<1> member_func_args (std::vector< uint8_t > (coal::OcTree::*function_ptr) () const) | ||
249 | { | ||
250 | if (function_ptr == static_cast<std::vector< uint8_t > (coal::OcTree::*) () const>(&coal::OcTree::tobytes)) | ||
251 | return (boost::python::arg("self")); | ||
252 | return (boost::python::arg("self")); | ||
253 | } | ||
254 | |||
255 | inline const char* member_func_doc (void (coal::OcTree::*function_ptr) ( coal::Scalar)) | ||
256 | { | ||
257 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setCellDefaultOccupancy)) | ||
258 | return ""; | ||
259 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setOccupancyThres)) | ||
260 | return ""; | ||
261 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setFreeThres)) | ||
262 | return ""; | ||
263 | return ""; | ||
264 | } | ||
265 | |||
266 | inline boost::python::detail::keywords<2> member_func_args (void (coal::OcTree::*function_ptr) ( coal::Scalar)) | ||
267 | { | ||
268 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setCellDefaultOccupancy)) | ||
269 | return (boost::python::arg("self"), boost::python::arg("d")); | ||
270 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setOccupancyThres)) | ||
271 | return (boost::python::arg("self"), boost::python::arg("d")); | ||
272 | if (function_ptr == static_cast<void (coal::OcTree::*) ( coal::Scalar)>(&coal::OcTree::setFreeThres)) | ||
273 | return (boost::python::arg("self"), boost::python::arg("d")); | ||
274 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
275 | } | ||
276 | |||
277 | inline const char* member_func_doc ( coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) ( coal::OcTree::OcTreeNode *, unsigned int)) | ||
278 | { | ||
279 | if (function_ptr == static_cast< coal::OcTree::OcTreeNode * (coal::OcTree::*) ( coal::OcTree::OcTreeNode *, unsigned int)>(&coal::OcTree::getNodeChild)) | ||
280 | return "Return: ptr to child number childIdx of node "; | ||
281 | return ""; | ||
282 | } | ||
283 | |||
284 | inline boost::python::detail::keywords<3> member_func_args ( coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) ( coal::OcTree::OcTreeNode *, unsigned int)) | ||
285 | { | ||
286 | if (function_ptr == static_cast< coal::OcTree::OcTreeNode * (coal::OcTree::*) ( coal::OcTree::OcTreeNode *, unsigned int)>(&coal::OcTree::getNodeChild)) | ||
287 | return (boost::python::arg("self"), boost::python::arg("node"), boost::python::arg("childIdx")); | ||
288 | return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1")); | ||
289 | } | ||
290 | |||
291 | inline const char* member_func_doc (const coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *, unsigned int) const) | ||
292 | { | ||
293 | if (function_ptr == static_cast<const coal::OcTree::OcTreeNode * (coal::OcTree::*) (const coal::OcTree::OcTreeNode *, unsigned int) const>(&coal::OcTree::getNodeChild)) | ||
294 | return "Return: const ptr to child number childIdx of node "; | ||
295 | return ""; | ||
296 | } | ||
297 | |||
298 | inline boost::python::detail::keywords<3> member_func_args (const coal::OcTree::OcTreeNode * (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *, unsigned int) const) | ||
299 | { | ||
300 | if (function_ptr == static_cast<const coal::OcTree::OcTreeNode * (coal::OcTree::*) (const coal::OcTree::OcTreeNode *, unsigned int) const>(&coal::OcTree::getNodeChild)) | ||
301 | return (boost::python::arg("self"), boost::python::arg("node"), boost::python::arg("childIdx")); | ||
302 | return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1")); | ||
303 | } | ||
304 | |||
305 | inline const char* member_func_doc (bool (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *, unsigned int) const) | ||
306 | { | ||
307 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *, unsigned int) const>(&coal::OcTree::nodeChildExists)) | ||
308 | return "return true if the child at childIdx exists "; | ||
309 | return ""; | ||
310 | } | ||
311 | |||
312 | inline boost::python::detail::keywords<3> member_func_args (bool (coal::OcTree::*function_ptr) (const coal::OcTree::OcTreeNode *, unsigned int) const) | ||
313 | { | ||
314 | if (function_ptr == static_cast<bool (coal::OcTree::*) (const coal::OcTree::OcTreeNode *, unsigned int) const>(&coal::OcTree::nodeChildExists)) | ||
315 | return (boost::python::arg("self"), boost::python::arg("node"), boost::python::arg("childIdx")); | ||
316 | return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1")); | ||
317 | } | ||
318 | |||
319 | inline const char* member_func_doc ( coal::OBJECT_TYPE (coal::OcTree::*function_ptr) () const) | ||
320 | { | ||
321 | if (function_ptr == static_cast< coal::OBJECT_TYPE (coal::OcTree::*) () const>(&coal::OcTree::getObjectType)) | ||
322 | return "return object type, it is an octree "; | ||
323 | return ""; | ||
324 | } | ||
325 | |||
326 | inline boost::python::detail::keywords<1> member_func_args ( coal::OBJECT_TYPE (coal::OcTree::*function_ptr) () const) | ||
327 | { | ||
328 | if (function_ptr == static_cast< coal::OBJECT_TYPE (coal::OcTree::*) () const>(&coal::OcTree::getObjectType)) | ||
329 | return (boost::python::arg("self")); | ||
330 | return (boost::python::arg("self")); | ||
331 | } | ||
332 | |||
333 | inline const char* member_func_doc ( coal::NODE_TYPE (coal::OcTree::*function_ptr) () const) | ||
334 | { | ||
335 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::OcTree::*) () const>(&coal::OcTree::getNodeType)) | ||
336 | return "return node type, it is an octree "; | ||
337 | return ""; | ||
338 | } | ||
339 | |||
340 | inline boost::python::detail::keywords<1> member_func_args ( coal::NODE_TYPE (coal::OcTree::*function_ptr) () const) | ||
341 | { | ||
342 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::OcTree::*) () const>(&coal::OcTree::getNodeType)) | ||
343 | return (boost::python::arg("self")); | ||
344 | return (boost::python::arg("self")); | ||
345 | } | ||
346 | } // namespace doxygen | ||
347 | |||
348 | #endif // DOXYGEN_AUTODOC_COAL_OCTREE_H | ||
349 | |||
350 |