| Directory: | ./ |
|---|---|
| File: | python/doxygen_autodoc/coal/hfield.h |
| Date: | 2025-04-13 14:25:19 |
| Exec | Total | Coverage | |
|---|---|---|---|
| Lines: | 24 | 28 | 85.7% |
| Branches: | 11 | 28 | 39.3% |
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | #ifndef DOXYGEN_AUTODOC_COAL_HFIELD_H | ||
| 2 | #define DOXYGEN_AUTODOC_COAL_HFIELD_H | ||
| 3 | |||
| 4 | #include "/root/robotpkg/path/py-coal/work/coal-3.0.1/doc/python/doxygen.hh" | ||
| 5 | |||
| 6 | #include <coal/hfield.h> | ||
| 7 | |||
| 8 | namespace doxygen { | ||
| 9 | |||
| 10 | template <typename BV> | ||
| 11 | struct class_doc_impl< coal::HeightField <BV > > | ||
| 12 | { | ||
| 13 | 20 | static inline const char* run () | |
| 14 | { | ||
| 15 | return "Data structure depicting a height field given by the base grid dimensions and the elevation along the grid. \n" | ||
| 16 | "\n" | ||
| 17 | "\n" | ||
| 18 | "Templateparam\n" | ||
| 19 | " - BV one of the bounding volume class in Bounding volumes.\n" | ||
| 20 | "\n" | ||
| 21 | 20 | "An height field is defined by its base dimensions along the X and Y axes and a set ofpoints defined by their altitude, regularly dispatched on the grid. The height field is centered at the origin and the corners of the geometry correspond to the following coordinates [± x_dim/2; ± y_dim/2]. "; | |
| 22 | } | ||
| 23 | static inline const char* attribute (const char* attrib) | ||
| 24 | { | ||
| 25 | (void)attrib; // turn off unused parameter warning. | ||
| 26 | return ""; | ||
| 27 | } | ||
| 28 | }; | ||
| 29 | |||
| 30 | template <typename BV> | ||
| 31 | struct constructor_0_impl< coal::HeightField <BV > > | ||
| 32 | { | ||
| 33 | 20 | static inline const char* doc () | |
| 34 | { | ||
| 35 | 20 | return "Constructing an empty coal::HeightField. "; | |
| 36 | } | ||
| 37 | 10 | static inline boost::python::detail::keywords<0+1> args () | |
| 38 | { | ||
| 39 | 20 | return (boost::python::arg("self")); | |
| 40 | } | ||
| 41 | }; | ||
| 42 | |||
| 43 | template <typename BV> | ||
| 44 | struct constructor_4_impl< coal::HeightField <BV >, const coal::Scalar, const coal::Scalar, const coal::MatrixXs &, const coal::Scalar > | ||
| 45 | { | ||
| 46 | static inline const char* doc () | ||
| 47 | { | ||
| 48 | return "Constructing an coal::HeightField from its base dimensions and the set of heights points. The granularity of the height field along X and Y direction is extraded from the Z grid. \n" | ||
| 49 | "\n" | ||
| 50 | "\n" | ||
| 51 | "Param\n" | ||
| 52 | " - x_dim Dimension along the X axis \n" | ||
| 53 | " - y_dim Dimension along the Y axis \n" | ||
| 54 | " - heights Matrix containing the altitude of each point compositng the height field \n" | ||
| 55 | " - min_height Minimal height of the height field "; | ||
| 56 | } | ||
| 57 | static inline boost::python::detail::keywords<4+1> args () | ||
| 58 | { | ||
| 59 | return (boost::python::arg("self"), boost::python::arg("x_dim"), boost::python::arg("y_dim"), boost::python::arg("heights"), boost::python::arg("min_height")); | ||
| 60 | } | ||
| 61 | }; | ||
| 62 | |||
| 63 | template <typename BV> | ||
| 64 | struct constructor_1_impl< coal::HeightField <BV >, const coal::HeightField <BV > & > | ||
| 65 | { | ||
| 66 | 20 | static inline const char* doc () | |
| 67 | { | ||
| 68 | return "Copy contructor from another coal::HeightField. \n" | ||
| 69 | "\n" | ||
| 70 | "\n" | ||
| 71 | "Param\n" | ||
| 72 | 20 | " - other to copy. "; | |
| 73 | } | ||
| 74 | 10 | static inline boost::python::detail::keywords<1+1> args () | |
| 75 | { | ||
| 76 |
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")); |
| 77 | } | ||
| 78 | }; | ||
| 79 | |||
| 80 | template <typename BV> | ||
| 81 | struct destructor_doc_impl < coal::HeightField <BV > > | ||
| 82 | { | ||
| 83 | static inline const char* run () | ||
| 84 | { | ||
| 85 | return "deconstruction, delete mesh data related. "; | ||
| 86 | } | ||
| 87 | }; | ||
| 88 | |||
| 89 | template <typename BV> | ||
| 90 | 40 | inline const char* member_func_doc (const coal::VecXs & (coal::HeightField <BV >::*function_ptr) () const) | |
| 91 | { | ||
| 92 |
3/6✓ Branch 0 taken 10 times.
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
|
40 | if (function_ptr == static_cast<const coal::VecXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getXGrid)) |
| 93 | 20 | return "Returns a const reference of the grid along the X direction. "; | |
| 94 |
2/6✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
|
20 | if (function_ptr == static_cast<const coal::VecXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getYGrid)) |
| 95 | 20 | return "Returns a const reference of the grid along the Y direction. "; | |
| 96 | ✗ | return ""; | |
| 97 | } | ||
| 98 | |||
| 99 | template <typename BV> | ||
| 100 | inline boost::python::detail::keywords<1> member_func_args (const coal::VecXs & (coal::HeightField <BV >::*function_ptr) () const) | ||
| 101 | { | ||
| 102 | if (function_ptr == static_cast<const coal::VecXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getXGrid)) | ||
| 103 | return (boost::python::arg("self")); | ||
| 104 | if (function_ptr == static_cast<const coal::VecXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getYGrid)) | ||
| 105 | return (boost::python::arg("self")); | ||
| 106 | return (boost::python::arg("self")); | ||
| 107 | } | ||
| 108 | |||
| 109 | template <typename BV> | ||
| 110 | 20 | inline const char* member_func_doc (const coal::MatrixXs & (coal::HeightField <BV >::*function_ptr) () const) | |
| 111 | { | ||
| 112 |
2/6✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
|
20 | if (function_ptr == static_cast<const coal::MatrixXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getHeights)) |
| 113 | 20 | return "Returns a const reference of the heights. "; | |
| 114 | ✗ | return ""; | |
| 115 | } | ||
| 116 | |||
| 117 | template <typename BV> | ||
| 118 | inline boost::python::detail::keywords<1> member_func_args (const coal::MatrixXs & (coal::HeightField <BV >::*function_ptr) () const) | ||
| 119 | { | ||
| 120 | if (function_ptr == static_cast<const coal::MatrixXs & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getHeights)) | ||
| 121 | return (boost::python::arg("self")); | ||
| 122 | return (boost::python::arg("self")); | ||
| 123 | } | ||
| 124 | |||
| 125 | template <typename BV> | ||
| 126 | inline const char* member_func_doc ( coal::Scalar (coal::HeightField <BV >::*function_ptr) () const) | ||
| 127 | { | ||
| 128 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getXDim)) | ||
| 129 | return "Returns the dimension of the Height Field along the X direction. "; | ||
| 130 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getYDim)) | ||
| 131 | return "Returns the dimension of the Height Field along the Y direction. "; | ||
| 132 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getMinHeight)) | ||
| 133 | return "Returns the minimal height value of the Height Field. "; | ||
| 134 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getMaxHeight)) | ||
| 135 | return "Returns the maximal height value of the Height Field. "; | ||
| 136 | return ""; | ||
| 137 | } | ||
| 138 | |||
| 139 | template <typename BV> | ||
| 140 | inline boost::python::detail::keywords<1> member_func_args ( coal::Scalar (coal::HeightField <BV >::*function_ptr) () const) | ||
| 141 | { | ||
| 142 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getXDim)) | ||
| 143 | return (boost::python::arg("self")); | ||
| 144 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getYDim)) | ||
| 145 | return (boost::python::arg("self")); | ||
| 146 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getMinHeight)) | ||
| 147 | return (boost::python::arg("self")); | ||
| 148 | if (function_ptr == static_cast< coal::Scalar (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getMaxHeight)) | ||
| 149 | return (boost::python::arg("self")); | ||
| 150 | return (boost::python::arg("self")); | ||
| 151 | } | ||
| 152 | |||
| 153 | template <typename BV> | ||
| 154 | 20 | inline const char* member_func_doc ( coal::HeightField < BV > * (coal::HeightField <BV >::*function_ptr) () const) | |
| 155 | { | ||
| 156 |
2/6✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
|
20 | if (function_ptr == static_cast< coal::HeightField < BV > * (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::clone)) |
| 157 | 20 | return "Clone *this into a new coal::CollisionGeometry. "; | |
| 158 | ✗ | return ""; | |
| 159 | } | ||
| 160 | |||
| 161 | template <typename BV> | ||
| 162 | inline boost::python::detail::keywords<1> member_func_args ( coal::HeightField < BV > * (coal::HeightField <BV >::*function_ptr) () const) | ||
| 163 | { | ||
| 164 | if (function_ptr == static_cast< coal::HeightField < BV > * (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::clone)) | ||
| 165 | return (boost::python::arg("self")); | ||
| 166 | return (boost::python::arg("self")); | ||
| 167 | } | ||
| 168 | |||
| 169 | template <typename BV> | ||
| 170 | inline const char* member_func_doc (const typename coal::HeightField <BV >::BVS & (coal::HeightField <BV >::*function_ptr) () const) | ||
| 171 | { | ||
| 172 | if (function_ptr == static_cast<const typename coal::HeightField <BV >::BVS & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodes)) | ||
| 173 | return ""; | ||
| 174 | return ""; | ||
| 175 | } | ||
| 176 | |||
| 177 | template <typename BV> | ||
| 178 | inline boost::python::detail::keywords<1> member_func_args (const typename coal::HeightField <BV >::BVS & (coal::HeightField <BV >::*function_ptr) () const) | ||
| 179 | { | ||
| 180 | if (function_ptr == static_cast<const typename coal::HeightField <BV >::BVS & (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodes)) | ||
| 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 (void (coal::HeightField <BV >::*function_ptr) ()) | ||
| 187 | { | ||
| 188 | if (function_ptr == static_cast<void (coal::HeightField <BV >::*) ()>(&coal::HeightField <BV >::computeLocalAABB)) | ||
| 189 | return "Compute the coal::AABB for the coal::HeightField, used for broad-phase collision. "; | ||
| 190 | return ""; | ||
| 191 | } | ||
| 192 | |||
| 193 | template <typename BV> | ||
| 194 | inline boost::python::detail::keywords<1> member_func_args (void (coal::HeightField <BV >::*function_ptr) ()) | ||
| 195 | { | ||
| 196 | if (function_ptr == static_cast<void (coal::HeightField <BV >::*) ()>(&coal::HeightField <BV >::computeLocalAABB)) | ||
| 197 | return (boost::python::arg("self")); | ||
| 198 | return (boost::python::arg("self")); | ||
| 199 | } | ||
| 200 | |||
| 201 | template <typename BV> | ||
| 202 | inline const char* member_func_doc (void (coal::HeightField <BV >::*function_ptr) (const coal::MatrixXs &)) | ||
| 203 | { | ||
| 204 | if (function_ptr == static_cast<void (coal::HeightField <BV >::*) (const coal::MatrixXs &)>(&coal::HeightField <BV >::updateHeights)) | ||
| 205 | return "Update Height Field height. "; | ||
| 206 | return ""; | ||
| 207 | } | ||
| 208 | |||
| 209 | template <typename BV> | ||
| 210 | inline boost::python::detail::keywords<2> member_func_args (void (coal::HeightField <BV >::*function_ptr) (const coal::MatrixXs &)) | ||
| 211 | { | ||
| 212 | if (function_ptr == static_cast<void (coal::HeightField <BV >::*) (const coal::MatrixXs &)>(&coal::HeightField <BV >::updateHeights)) | ||
| 213 | return (boost::python::arg("self"), boost::python::arg("new_heights")); | ||
| 214 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
| 215 | } | ||
| 216 | |||
| 217 | template <typename BV> | ||
| 218 | inline const char* member_func_doc (const coal::HFNode < BV > & (coal::HeightField <BV >::*function_ptr) (unsigned int) const) | ||
| 219 | { | ||
| 220 | if (function_ptr == static_cast<const coal::HFNode < BV > & (coal::HeightField <BV >::*) (unsigned int) const>(&coal::HeightField <BV >::getBV)) | ||
| 221 | return "Access the bv giving the its index. "; | ||
| 222 | return ""; | ||
| 223 | } | ||
| 224 | |||
| 225 | template <typename BV> | ||
| 226 | inline boost::python::detail::keywords<2> member_func_args (const coal::HFNode < BV > & (coal::HeightField <BV >::*function_ptr) (unsigned int) const) | ||
| 227 | { | ||
| 228 | if (function_ptr == static_cast<const coal::HFNode < BV > & (coal::HeightField <BV >::*) (unsigned int) const>(&coal::HeightField <BV >::getBV)) | ||
| 229 | return (boost::python::arg("self"), boost::python::arg("i")); | ||
| 230 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
| 231 | } | ||
| 232 | |||
| 233 | template <typename BV> | ||
| 234 | 10 | inline const char* member_func_doc ( coal::HFNode < BV > & (coal::HeightField <BV >::*function_ptr) (unsigned int)) | |
| 235 | { | ||
| 236 | 10 | if (function_ptr == static_cast< coal::HFNode < BV > & (coal::HeightField <BV >::*) (unsigned int)>(&coal::HeightField <BV >::getBV)) | |
| 237 | 10 | return "Access the bv giving the its index. "; | |
| 238 | ✗ | return ""; | |
| 239 | } | ||
| 240 | |||
| 241 | template <typename BV> | ||
| 242 | inline boost::python::detail::keywords<2> member_func_args ( coal::HFNode < BV > & (coal::HeightField <BV >::*function_ptr) (unsigned int)) | ||
| 243 | { | ||
| 244 | if (function_ptr == static_cast< coal::HFNode < BV > & (coal::HeightField <BV >::*) (unsigned int)>(&coal::HeightField <BV >::getBV)) | ||
| 245 | return (boost::python::arg("self"), boost::python::arg("i")); | ||
| 246 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
| 247 | } | ||
| 248 | |||
| 249 | template <typename BV> | ||
| 250 | inline const char* member_func_doc ( coal::NODE_TYPE (coal::HeightField <BV >::*function_ptr) () const) | ||
| 251 | { | ||
| 252 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 253 | return "Get the BV type: default is unknown. "; | ||
| 254 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 255 | return "Specialization of getNodeType() for coal::HeightField with different BV types. "; | ||
| 256 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 257 | return "get the node type "; | ||
| 258 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 259 | return "get the node type "; | ||
| 260 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 261 | return "get the node type "; | ||
| 262 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 263 | return "get the node type "; | ||
| 264 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 265 | return "get the node type "; | ||
| 266 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 267 | return "get the node type "; | ||
| 268 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 269 | return "get the node type "; | ||
| 270 | return ""; | ||
| 271 | } | ||
| 272 | |||
| 273 | template <typename BV> | ||
| 274 | inline boost::python::detail::keywords<1> member_func_args ( coal::NODE_TYPE (coal::HeightField <BV >::*function_ptr) () const) | ||
| 275 | { | ||
| 276 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 277 | return (boost::python::arg("self")); | ||
| 278 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 279 | return (boost::python::arg("self")); | ||
| 280 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 281 | return (boost::python::arg("self")); | ||
| 282 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 283 | return (boost::python::arg("self")); | ||
| 284 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 285 | return (boost::python::arg("self")); | ||
| 286 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 287 | return (boost::python::arg("self")); | ||
| 288 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 289 | return (boost::python::arg("self")); | ||
| 290 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 291 | return (boost::python::arg("self")); | ||
| 292 | if (function_ptr == static_cast< coal::NODE_TYPE (coal::HeightField <BV >::*) () const>(&coal::HeightField <BV >::getNodeType)) | ||
| 293 | return (boost::python::arg("self")); | ||
| 294 | return (boost::python::arg("self")); | ||
| 295 | } | ||
| 296 | } // namespace doxygen | ||
| 297 | #include <coal/hfield.h> | ||
| 298 | |||
| 299 | namespace doxygen { | ||
| 300 | |||
| 301 | template <typename BV> | ||
| 302 | struct class_doc_impl< coal::HFNode <BV > > | ||
| 303 | { | ||
| 304 | static inline const char* run () | ||
| 305 | { | ||
| 306 | return ""; | ||
| 307 | } | ||
| 308 | static inline const char* attribute (const char* attrib) | ||
| 309 | { | ||
| 310 | if (strcmp(attrib, "bv") == 0) | ||
| 311 | return "bounding volume storing the geometry "; | ||
| 312 | (void)attrib; // turn off unused parameter warning. | ||
| 313 | return ""; | ||
| 314 | } | ||
| 315 | }; | ||
| 316 | |||
| 317 | template <typename BV> | ||
| 318 | struct destructor_doc_impl < coal::HFNode <BV > > | ||
| 319 | { | ||
| 320 | static inline const char* run () | ||
| 321 | { | ||
| 322 | return ""; | ||
| 323 | } | ||
| 324 | }; | ||
| 325 | |||
| 326 | template <typename BV> | ||
| 327 | inline const char* member_func_doc (bool (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &) const) | ||
| 328 | { | ||
| 329 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::operator==)) | ||
| 330 | return "Equality operator. "; | ||
| 331 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::operator!=)) | ||
| 332 | return "Difference operator. "; | ||
| 333 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::overlap)) | ||
| 334 | return "Check whether two coal::BVNode collide. "; | ||
| 335 | return ""; | ||
| 336 | } | ||
| 337 | |||
| 338 | template <typename BV> | ||
| 339 | inline boost::python::detail::keywords<2> member_func_args (bool (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &) const) | ||
| 340 | { | ||
| 341 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::operator==)) | ||
| 342 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
| 343 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::operator!=)) | ||
| 344 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
| 345 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &) const>(&coal::HFNode <BV >::overlap)) | ||
| 346 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
| 347 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
| 348 | } | ||
| 349 | |||
| 350 | template <typename BV> | ||
| 351 | inline const char* member_func_doc (bool (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &, const coal::CollisionRequest &, coal::Scalar &) const) | ||
| 352 | { | ||
| 353 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &, const coal::CollisionRequest &, coal::Scalar &) const>(&coal::HFNode <BV >::overlap)) | ||
| 354 | return "Check whether two coal::BVNode collide. "; | ||
| 355 | return ""; | ||
| 356 | } | ||
| 357 | |||
| 358 | template <typename BV> | ||
| 359 | inline boost::python::detail::keywords<4> member_func_args (bool (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &, const coal::CollisionRequest &, coal::Scalar &) const) | ||
| 360 | { | ||
| 361 | if (function_ptr == static_cast<bool (coal::HFNode <BV >::*) (const coal::HFNode <BV > &, const coal::CollisionRequest &, coal::Scalar &) const>(&coal::HFNode <BV >::overlap)) | ||
| 362 | return (boost::python::arg("self"), boost::python::arg("other"), boost::python::arg("request"), boost::python::arg("sqrDistLowerBound")); | ||
| 363 | return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2")); | ||
| 364 | } | ||
| 365 | |||
| 366 | template <typename BV> | ||
| 367 | inline const char* member_func_doc ( coal::Scalar (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &, coal::Vec3s *, coal::Vec3s *) const) | ||
| 368 | { | ||
| 369 | if (function_ptr == static_cast< coal::Scalar (coal::HFNode <BV >::*) (const coal::HFNode <BV > &, coal::Vec3s *, coal::Vec3s *) const>(&coal::HFNode <BV >::distance)) | ||
| 370 | return "Compute the distance between two coal::BVNode. P1 and P2, if not NULL and the underlying BV supports distance, return the nearest points. "; | ||
| 371 | return ""; | ||
| 372 | } | ||
| 373 | |||
| 374 | template <typename BV> | ||
| 375 | inline boost::python::detail::keywords<4> member_func_args ( coal::Scalar (coal::HFNode <BV >::*function_ptr) (const coal::HFNode <BV > &, coal::Vec3s *, coal::Vec3s *) const) | ||
| 376 | { | ||
| 377 | if (function_ptr == static_cast< coal::Scalar (coal::HFNode <BV >::*) (const coal::HFNode <BV > &, coal::Vec3s *, coal::Vec3s *) const>(&coal::HFNode <BV >::distance)) | ||
| 378 | return (boost::python::arg("self"), boost::python::arg("other"), boost::python::arg("P1"), boost::python::arg("P2")); | ||
| 379 | return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2")); | ||
| 380 | } | ||
| 381 | |||
| 382 | template <typename BV> | ||
| 383 | inline const char* member_func_doc ( coal::Vec3s (coal::HFNode <BV >::*function_ptr) () const) | ||
| 384 | { | ||
| 385 | if (function_ptr == static_cast< coal::Vec3s (coal::HFNode <BV >::*) () const>(&coal::HFNode <BV >::getCenter)) | ||
| 386 | return "Access to the center of the BV. "; | ||
| 387 | return ""; | ||
| 388 | } | ||
| 389 | |||
| 390 | template <typename BV> | ||
| 391 | inline boost::python::detail::keywords<1> member_func_args ( coal::Vec3s (coal::HFNode <BV >::*function_ptr) () const) | ||
| 392 | { | ||
| 393 | if (function_ptr == static_cast< coal::Vec3s (coal::HFNode <BV >::*) () const>(&coal::HFNode <BV >::getCenter)) | ||
| 394 | return (boost::python::arg("self")); | ||
| 395 | return (boost::python::arg("self")); | ||
| 396 | } | ||
| 397 | |||
| 398 | template <typename BV> | ||
| 399 | inline const char* member_func_doc (coal::Matrix3s::IdentityReturnType (coal::HFNode <BV >::*function_ptr) () const) | ||
| 400 | { | ||
| 401 | if (function_ptr == static_cast<coal::Matrix3s::IdentityReturnType (coal::HFNode <BV >::*) () const>(&coal::HFNode <BV >::getOrientation)) | ||
| 402 | return "Access to the orientation of the BV. "; | ||
| 403 | return ""; | ||
| 404 | } | ||
| 405 | |||
| 406 | template <typename BV> | ||
| 407 | inline boost::python::detail::keywords<1> member_func_args (coal::Matrix3s::IdentityReturnType (coal::HFNode <BV >::*function_ptr) () const) | ||
| 408 | { | ||
| 409 | if (function_ptr == static_cast<coal::Matrix3s::IdentityReturnType (coal::HFNode <BV >::*) () const>(&coal::HFNode <BV >::getOrientation)) | ||
| 410 | return (boost::python::arg("self")); | ||
| 411 | return (boost::python::arg("self")); | ||
| 412 | } | ||
| 413 | } // namespace doxygen | ||
| 414 | #include <coal/hfield.h> | ||
| 415 | |||
| 416 | namespace doxygen { | ||
| 417 | |||
| 418 | template <> | ||
| 419 | struct class_doc_impl< coal::HFNodeBase > | ||
| 420 | { | ||
| 421 | static inline const char* run () | ||
| 422 | { | ||
| 423 | return ""; | ||
| 424 | } | ||
| 425 | static inline const char* attribute (const char* attrib) | ||
| 426 | { | ||
| 427 | if (strcmp(attrib, "first_child") == 0) | ||
| 428 | return "An index for first child node or primitive If the value is positive, it is the index of the first child bv node If the value is negative, it is -(primitive index + 1) Zero is not used. "; | ||
| 429 | (void)attrib; // turn off unused parameter warning. | ||
| 430 | return ""; | ||
| 431 | } | ||
| 432 | }; | ||
| 433 | |||
| 434 | template <> | ||
| 435 | struct constructor_0_impl< coal::HFNodeBase > | ||
| 436 | { | ||
| 437 | static inline const char* doc () | ||
| 438 | { | ||
| 439 | return "Default constructor. "; | ||
| 440 | } | ||
| 441 | static inline boost::python::detail::keywords<0+1> args () | ||
| 442 | { | ||
| 443 | return (boost::python::arg("self")); | ||
| 444 | } | ||
| 445 | }; | ||
| 446 | |||
| 447 | inline const char* member_func_doc (bool (coal::HFNodeBase::*function_ptr) (const coal::HFNodeBase &) const) | ||
| 448 | { | ||
| 449 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) (const coal::HFNodeBase &) const>(&coal::HFNodeBase::operator==)) | ||
| 450 | return "Comparison operator. "; | ||
| 451 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) (const coal::HFNodeBase &) const>(&coal::HFNodeBase::operator!=)) | ||
| 452 | return "Difference operator. "; | ||
| 453 | return ""; | ||
| 454 | } | ||
| 455 | |||
| 456 | inline boost::python::detail::keywords<2> member_func_args (bool (coal::HFNodeBase::*function_ptr) (const coal::HFNodeBase &) const) | ||
| 457 | { | ||
| 458 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) (const coal::HFNodeBase &) const>(&coal::HFNodeBase::operator==)) | ||
| 459 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
| 460 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) (const coal::HFNodeBase &) const>(&coal::HFNodeBase::operator!=)) | ||
| 461 | return (boost::python::arg("self"), boost::python::arg("other")); | ||
| 462 | return (boost::python::arg("self"), boost::python::arg("arg0")); | ||
| 463 | } | ||
| 464 | |||
| 465 | inline const char* member_func_doc (bool (coal::HFNodeBase::*function_ptr) () const) | ||
| 466 | { | ||
| 467 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::isLeaf)) | ||
| 468 | return "Whether current node is a leaf node (i.e. contains a primitive index) "; | ||
| 469 | return ""; | ||
| 470 | } | ||
| 471 | |||
| 472 | inline boost::python::detail::keywords<1> member_func_args (bool (coal::HFNodeBase::*function_ptr) () const) | ||
| 473 | { | ||
| 474 | if (function_ptr == static_cast<bool (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::isLeaf)) | ||
| 475 | return (boost::python::arg("self")); | ||
| 476 | return (boost::python::arg("self")); | ||
| 477 | } | ||
| 478 | |||
| 479 | inline const char* member_func_doc (size_t (coal::HFNodeBase::*function_ptr) () const) | ||
| 480 | { | ||
| 481 | if (function_ptr == static_cast<size_t (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::leftChild)) | ||
| 482 | return "Return the index of the first child. The index is referred to the bounding volume array (i.e. bvs) in coal::BVHModel. "; | ||
| 483 | if (function_ptr == static_cast<size_t (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::rightChild)) | ||
| 484 | return "Return the index of the second child. The index is referred to the bounding volume array (i.e. bvs) in coal::BVHModel. "; | ||
| 485 | return ""; | ||
| 486 | } | ||
| 487 | |||
| 488 | inline boost::python::detail::keywords<1> member_func_args (size_t (coal::HFNodeBase::*function_ptr) () const) | ||
| 489 | { | ||
| 490 | if (function_ptr == static_cast<size_t (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::leftChild)) | ||
| 491 | return (boost::python::arg("self")); | ||
| 492 | if (function_ptr == static_cast<size_t (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::rightChild)) | ||
| 493 | return (boost::python::arg("self")); | ||
| 494 | return (boost::python::arg("self")); | ||
| 495 | } | ||
| 496 | |||
| 497 | inline const char* member_func_doc (Eigen::Vector2i (coal::HFNodeBase::*function_ptr) () const) | ||
| 498 | { | ||
| 499 | if (function_ptr == static_cast<Eigen::Vector2i (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::leftChildIndexes)) | ||
| 500 | return ""; | ||
| 501 | if (function_ptr == static_cast<Eigen::Vector2i (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::rightChildIndexes)) | ||
| 502 | return ""; | ||
| 503 | return ""; | ||
| 504 | } | ||
| 505 | |||
| 506 | inline boost::python::detail::keywords<1> member_func_args (Eigen::Vector2i (coal::HFNodeBase::*function_ptr) () const) | ||
| 507 | { | ||
| 508 | if (function_ptr == static_cast<Eigen::Vector2i (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::leftChildIndexes)) | ||
| 509 | return (boost::python::arg("self")); | ||
| 510 | if (function_ptr == static_cast<Eigen::Vector2i (coal::HFNodeBase::*) () const>(&coal::HFNodeBase::rightChildIndexes)) | ||
| 511 | return (boost::python::arg("self")); | ||
| 512 | return (boost::python::arg("self")); | ||
| 513 | } | ||
| 514 | } // namespace doxygen | ||
| 515 | #include <coal/hfield.h> | ||
| 516 | |||
| 517 | namespace doxygen { | ||
| 518 | } // namespace doxygen | ||
| 519 | |||
| 520 | #endif // DOXYGEN_AUTODOC_COAL_HFIELD_H | ||
| 521 | |||
| 522 |