| 1 |
libccd is library for a collision detection between two convex shapes. |
| 2 |
libccd implements variation on Gilbert–Johnson–Keerthi algorithm plus Expand |
| 3 |
Polytope Algorithm (EPA) and also implements algorithm Minkowski Portal |
| 4 |
Refinement (MPR, a.k.a. XenoCollide) as described in Game Programming Gems 7. |
| 5 |
|
| 6 |
For more info see home of libccd: http://libccd.danfis.cz. |
| 7 |
|
| 8 |
|
| 9 |
Dependencies |
| 10 |
------------- |
| 11 |
This library is currently based only on standard libraries. |
| 12 |
The only exception are testsuites that are built on top of CU |
| 13 |
(cu.danfis.cz) library licensed under LGPL, however only testing depends on |
| 14 |
it and libccd library itself can be distributed without it. |
| 15 |
|
| 16 |
|
| 17 |
License |
| 18 |
-------- |
| 19 |
libccd is licensed under OSI-approved 3-clause BSD License, text of license |
| 20 |
is distributed along with source code in BSD-LICENSE file. |
| 21 |
Each file should include license notice, the rest should be considered as |
| 22 |
licensed under 3-clause BSD License. |
| 23 |
|
| 24 |
|
| 25 |
Compile And Install |
| 26 |
-------------------- |
| 27 |
Simply type 'make' and 'make install' in src/ directory. |
| 28 |
|
| 29 |
Library libccd is by default compiled in double precision of floating point |
| 30 |
numbers - you can control this by options USE_SINGLE/USE_DOUBLE, i.e.: |
| 31 |
$ make USE_SINGLE=yes |
| 32 |
will compile library in single precision. |
| 33 |
|
| 34 |
Installation directory can be changed by options PREFIX, INCLUDEDIR and |
| 35 |
LIBDIR. |
| 36 |
|
| 37 |
For more info type 'make help'. |
| 38 |
|
| 39 |
|
| 40 |
Compile And Install Using Autotools |
| 41 |
------------------------------------ |
| 42 |
libccd also contains support for autotools: |
| 43 |
1) Generate configure script etc.: $ ./bootstrap |
| 44 |
2) Create new build/ directory: $ mkdir build && cd build |
| 45 |
3) Run configure script: $ ../configure |
| 46 |
4) Run make and make install: $ make && make install |
| 47 |
|
| 48 |
configure script can change the way libccd is compiled and installed, most |
| 49 |
significant option is --enable-double-precision which enables double |
| 50 |
precision (single is default in this case). |
| 51 |
|
| 52 |
|
| 53 |
Usage |
| 54 |
------ |
| 55 |
See ccd.h for public API. |
| 56 |
In your application include <ccd/ccd.h>, setup ccd_t structure and run some |
| 57 |
of functions (all functions are reentrant). Then link with libccd.a. |
| 58 |
|
| 59 |
|
| 60 |
Directories |
| 61 |
------------ |
| 62 |
src/ |
| 63 |
- contains source files of libccd. |
| 64 |
src/testsuites |
| 65 |
- testsuites - libccd must be compiled before compiling this. |
| 66 |
src/testsuites/cu |
| 67 |
- CU unit testing framework |
| 68 |
src/testsuites/regressions |
| 69 |
- files ready for regression tests |
| 70 |
|
| 71 |
doc/ |
| 72 |
- some documentation. |