GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: python/doxygen_autodoc/hpp/fcl/broadphase/broadphase_callbacks.h Lines: 16 20 80.0 %
Date: 2024-02-09 12:57:42 Branches: 14 36 38.9 %

Line Branch Exec Source
1
#ifndef DOXYGEN_AUTODOC_HPP_FCL_BROADPHASE_BROADPHASE_CALLBACKS_H
2
#define DOXYGEN_AUTODOC_HPP_FCL_BROADPHASE_BROADPHASE_CALLBACKS_H
3
4
#include "/root/robotpkg/path/py-hpp-fcl/work/hpp-fcl-2.4.1/doc/python/doxygen.hh"
5
6
#include <hpp/fcl/broadphase/broadphase_callbacks.h>
7
8
namespace doxygen {
9
10
template <>
11
struct class_doc_impl< hpp::fcl::CollisionCallBackBase >
12
{
13
static inline const char* run ()
14
{
15
  return "Base callback class for collision queries. This class can be supersed by child classes to provide desired behaviors according to the application (e.g, only listing the potential CollisionObjects in collision). ";
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
5
inline const char* member_func_doc (void (hpp::fcl::CollisionCallBackBase::*function_ptr) ())
25
{
26

5
  if (function_ptr == static_cast<void (hpp::fcl::CollisionCallBackBase::*) ()>(&hpp::fcl::CollisionCallBackBase::init))
27
5
    return "Initialization of the callback before running the collision broadphase manager. ";
28
  return "";
29
}
30
31
inline boost::python::detail::keywords<1> member_func_args (void (hpp::fcl::CollisionCallBackBase::*function_ptr) ())
32
{
33
  if (function_ptr == static_cast<void (hpp::fcl::CollisionCallBackBase::*) ()>(&hpp::fcl::CollisionCallBackBase::init))
34
    return (boost::python::arg("self"));
35
  return (boost::python::arg("self"));
36
}
37
38
10
inline const char* member_func_doc (bool (hpp::fcl::CollisionCallBackBase::*function_ptr) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *))
39
{
40

10
  if (function_ptr == static_cast<bool (hpp::fcl::CollisionCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *)>(&hpp::fcl::CollisionCallBackBase::collide))
41
    return "Collision evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. \n"
42
"\n"
43
"\n"
44
"Param\n"
45
"  - o1 Collision object #1. \n"
46
5
"  - o2 Collision object #2. ";
47

5
  if (function_ptr == static_cast<bool (hpp::fcl::CollisionCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *)>(&hpp::fcl::CollisionCallBackBase::operator()))
48
5
    return "Functor call associated to the collide operation. ";
49
  return "";
50
}
51
52
inline boost::python::detail::keywords<3> member_func_args (bool (hpp::fcl::CollisionCallBackBase::*function_ptr) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *))
53
{
54
  if (function_ptr == static_cast<bool (hpp::fcl::CollisionCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *)>(&hpp::fcl::CollisionCallBackBase::collide))
55
    return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"));
56
  if (function_ptr == static_cast<bool (hpp::fcl::CollisionCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *)>(&hpp::fcl::CollisionCallBackBase::operator()))
57
    return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"));
58
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"));
59
}
60
} // namespace doxygen
61
#include <hpp/fcl/broadphase/broadphase_callbacks.h>
62
63
namespace doxygen {
64
65
template <>
66
struct class_doc_impl< hpp::fcl::DistanceCallBackBase >
67
{
68
static inline const char* run ()
69
{
70
  return "Base callback class for distance queries. This class can be supersed by child classes to provide desired behaviors according to the application (e.g, only listing the potential CollisionObjects in collision). ";
71
}
72
static inline const char* attribute (const char* attrib)
73
{
74
  (void)attrib; // turn off unused parameter warning.
75
  return "";
76
}
77
};
78
79
5
inline const char* member_func_doc (void (hpp::fcl::DistanceCallBackBase::*function_ptr) ())
80
{
81

5
  if (function_ptr == static_cast<void (hpp::fcl::DistanceCallBackBase::*) ()>(&hpp::fcl::DistanceCallBackBase::init))
82
5
    return "Initialization of the callback before running the collision broadphase manager. ";
83
  return "";
84
}
85
86
inline boost::python::detail::keywords<1> member_func_args (void (hpp::fcl::DistanceCallBackBase::*function_ptr) ())
87
{
88
  if (function_ptr == static_cast<void (hpp::fcl::DistanceCallBackBase::*) ()>(&hpp::fcl::DistanceCallBackBase::init))
89
    return (boost::python::arg("self"));
90
  return (boost::python::arg("self"));
91
}
92
93
10
inline const char* member_func_doc (bool (hpp::fcl::DistanceCallBackBase::*function_ptr) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &))
94
{
95

10
  if (function_ptr == static_cast<bool (hpp::fcl::DistanceCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &)>(&hpp::fcl::DistanceCallBackBase::distance))
96
    return "Distance evaluation between two objects in collision. This callback will cause the broadphase evaluation to stop if it returns true. \n"
97
"\n"
98
"\n"
99
"Param\n"
100
"  - o1 Collision object #1. \n"
101
"  - o2 Collision object #2. \n"
102
5
"  - dist Distance between the two collision geometries. ";
103

5
  if (function_ptr == static_cast<bool (hpp::fcl::DistanceCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &)>(&hpp::fcl::DistanceCallBackBase::operator()))
104
5
    return "Functor call associated to the distance operation. ";
105
  return "";
106
}
107
108
inline boost::python::detail::keywords<4> member_func_args (bool (hpp::fcl::DistanceCallBackBase::*function_ptr) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &))
109
{
110
  if (function_ptr == static_cast<bool (hpp::fcl::DistanceCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &)>(&hpp::fcl::DistanceCallBackBase::distance))
111
    return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"), boost::python::arg("dist"));
112
  if (function_ptr == static_cast<bool (hpp::fcl::DistanceCallBackBase::*) ( hpp::fcl::CollisionObject *,  hpp::fcl::CollisionObject *,  hpp::fcl::FCL_REAL &)>(&hpp::fcl::DistanceCallBackBase::operator()))
113
    return (boost::python::arg("self"), boost::python::arg("o1"), boost::python::arg("o2"), boost::python::arg("dist"));
114
  return (boost::python::arg("self"), boost::python::arg("arg0"), boost::python::arg("arg1"), boost::python::arg("arg2"));
115
}
116
} // namespace doxygen
117
118
#endif // DOXYGEN_AUTODOC_HPP_FCL_BROADPHASE_BROADPHASE_CALLBACKS_H
119