summaryrefslogtreecommitdiff
path: root/libs/ode-0.16.1/libccd/README
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-10-01 20:59:36 -0500
committersanine <sanine.not@pm.me>2022-10-01 20:59:36 -0500
commitc5fc66ee58f2c60f2d226868bb1cf5b91badaf53 (patch)
tree277dd280daf10bf77013236b8edfa5f88708c7e0 /libs/ode-0.16.1/libccd/README
parent1cf9cc3408af7008451f9133fb95af66a9697d15 (diff)
add ode
Diffstat (limited to 'libs/ode-0.16.1/libccd/README')
-rw-r--r--libs/ode-0.16.1/libccd/README72
1 files changed, 72 insertions, 0 deletions
diff --git a/libs/ode-0.16.1/libccd/README b/libs/ode-0.16.1/libccd/README
new file mode 100644
index 0000000..f363d6c
--- /dev/null
+++ b/libs/ode-0.16.1/libccd/README
@@ -0,0 +1,72 @@
+libccd is library for a collision detection between two convex shapes.
+libccd implements variation on Gilbert–Johnson–Keerthi algorithm plus Expand
+Polytope Algorithm (EPA) and also implements algorithm Minkowski Portal
+Refinement (MPR, a.k.a. XenoCollide) as described in Game Programming Gems 7.
+
+For more info see home of libccd: http://libccd.danfis.cz.
+
+
+Dependencies
+-------------
+This library is currently based only on standard libraries.
+The only exception are testsuites that are built on top of CU
+(cu.danfis.cz) library licensed under LGPL, however only testing depends on
+it and libccd library itself can be distributed without it.
+
+
+License
+--------
+libccd is licensed under OSI-approved 3-clause BSD License, text of license
+is distributed along with source code in BSD-LICENSE file.
+Each file should include license notice, the rest should be considered as
+licensed under 3-clause BSD License.
+
+
+Compile And Install
+--------------------
+Simply type 'make' and 'make install' in src/ directory.
+
+Library libccd is by default compiled in double precision of floating point
+numbers - you can controll this by options USE_SINGLE/USE_DOUBLE, i.e.:
+ $ make USE_SINGLE=yes
+will compile library in single precision.
+
+Installation directory can be changed by options PREFIX, INCLUDEDIR and
+LIBDIR.
+
+For more info type 'make help'.
+
+
+Compile And Install Using Autotools
+------------------------------------
+libccd also contains support for autotools:
+1) Generate configure script etc.: $ ./bootstrap
+2) Create new build/ directory: $ mkdir build && cd build
+3) Run configure script: $ ../configure
+4) Run make and make install: $ make && make install
+
+configure script can change the way libccd is compiled and installed, most
+significant option is --enable-double-precision which enables double
+precision (single is default in this case).
+
+
+Usage
+------
+See ccd.h for public API.
+In your application include <ccd/ccd.h>, setup ccd_t structure and run some
+of functions (all functions are reentrant). Then link with libccd.a.
+
+
+Directories
+------------
+src/
+ - contains source files of libccd.
+src/testsuites
+ - testsuites - libccd must be compiled before compiling this.
+src/testsuites/cu
+ - CU unit testing framework
+src/testsuites/regressions
+ - files ready for regression tests
+
+doc/
+ - some documentation.