Skip to content
Snippets Groups Projects
Commit c18d6bcc authored by panjia1983's avatar panjia1983
Browse files

more changes to readme.md

parent 42ff6cf5
No related branches found
No related tags found
No related merge requests found
...@@ -24,6 +24,10 @@ FCL has the following features ...@@ -24,6 +24,10 @@ FCL has the following features
## Installation ## Installation
Before compiling FCL, please make sure boost and libccd (for collision checking between convex objects and is available here https://github.com/danfis/libccd) are installed. For libccd, make sure to compile from github version instead of the zip file from the webpage, because one bug fixing is not included in the zipped version.
Some optional libraries need to be installed for some optional capability of FCL. For octree collision, please install the octomap library from http://octomap.github.com. For global penetration depth, please install FLANN from https://github.com/mariusmuja/flann. For global penetration depth test, please install tinyxml.
CMakeLists.txt is used to generate makefiles in Linux or Visual studio projects in windows. In command line, run CMakeLists.txt is used to generate makefiles in Linux or Visual studio projects in windows. In command line, run
``` cmake ``` cmake
mkdir build mkdir build
...@@ -34,7 +38,7 @@ Next, in linux, use make to compile the code. ...@@ -34,7 +38,7 @@ Next, in linux, use make to compile the code.
In windows, there will generate a visual studio project and then you can compile the code. In windows, there will generate a visual studio project and then you can compile the code.
### Interfaces ## Interfaces
Before starting the proximity computation, we need first to set the geometry and transform for the objects involving in computation. The geometry of an object is represented as a mesh soup, which can be set as follows: Before starting the proximity computation, we need first to set the geometry and transform for the objects involving in computation. The geometry of an object is represented as a mesh soup, which can be set as follows:
```cpp ```cpp
...@@ -133,3 +137,12 @@ PenetrationDepthResult result; ...@@ -133,3 +137,12 @@ PenetrationDepthResult result;
// perform global penetration depth test // perform global penetration depth test
penetrationDepth(o1, o2,request, result); penetrationDepth(o1, o2,request, result);
``` ```
For more examples, please refer to the test folder:
-test_fcl_collision.cpp: provide examples for collision test
-test_fcl_distance.cpp: provide examples for distance test
-test_fcl_broadphase.cpp: provide examples for broadphase collision/distance test
-test_fcl_frontlist.cpp: provide examples for frontlist collision acceleration
-test_fcl_global_penetration.cpp: provide examples for global penetration depth test
-test_fcl_xmldata.cpp: provide examples for more global penetration depth test based on xml data
-test_fcl_octomap.cpp: provide examples for collision/distance computation between octomap data and other data types.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment