C++ API
The C++ API of each package is documented with Doxygen.
When HPP is installed with its documentation, the documentation of the
installed version can be opened from share/doc/hpp-doc/index.html in the
installation prefix, for instance
$DEVEL_HPP_DIR/install/share/doc/hpp-doc/index.html or
/opt/openrobots/share/doc/hpp-doc/index.html.
The online documentation is generated by Gepetto/doc.
| Package | Content | Documentation | Source |
|---|---|---|---|
| coal | Collision detection and distance computation | Doxygen | GitHub |
| pinocchio | Kinematic chains with dynamic computations | Doxygen | GitHub |
| hpp-util | Logging, benchmark and quality assurance tools | Doxygen | GitHub |
| hpp-statistics | Statistics on motion planning algorithms | Doxygen | GitHub |
| hpp-pinocchio | Interface between pinocchio and hpp-core | Doxygen | GitHub |
| hpp-constraints | Nonlinear constraints | Doxygen | GitHub |
| hpp-core | Basic classes, path planning problems and solvers | Doxygen | GitHub |
| hpp-manipulation | Manipulation planning | Doxygen | GitHub |
| hpp-manipulation-urdf | SRDF parser for manipulation planning (handles, grippers, contact surfaces) | Doxygen | GitHub |
| hpp-gepetto-viewer | Display of robots and paths with viser, rviz2 and gepetto-viewer | Doxygen | GitHub |
| hpp-python | Python bindings | Python API | GitHub |
| hpp-exec | Execution of paths with ros2_control | README | GitHub |