turtlebasket
/
openGJK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of openGJK with minor fixes https://github.com/MattiaMontanari/openGJK/pull/42
138 Commits
1 Branch
0 Tags
484 KiB
C 87.4%
CMake 12.6%
 
 
Go to file
Mattia Montanari f9b1f94d52
Merge pull request #40 from MattiaMontanari/add_github_action 
Add github actions to run examples
 		2023-02-14 17:28:18 +01:00
.github/workflows not great solution 2023-02-14 17:26:10 +01:00
examples Major changes: build static and dyn library. the first is for C example, the latter for CS example. The CS example is also ran in the action 2023-02-14 17:16:19 +01:00
include/openGJK Format all c and h files 2023-02-13 14:35:05 +01:00
.gitignore Merge branch 'cmakeWin' into dev 2021-07-03 13:33:36 +02:00
CMakeLists.txt Major changes: build static and dyn library. the first is for C example, the latter for CS example. The CS example is also ran in the action 2023-02-14 17:16:19 +01:00
LICENSE New sub-algorithm 2020-04-18 12:28:17 +01:00
README.md Enhance documentation in Readme and Header 2023-02-13 14:11:28 +01:00
openGJK.c Format all c and h files 2023-02-13 14:35:05 +01:00

README.md

Getting started

On Linux, Mac or Windows, if you have a basic C/C++ toolchain installed (git, compiler and cmake) clone this repo:

git clone https://github.com/MattiaMontanari/openGJK.git

Then use these commands to build and run an example:

cmake -E make_directory build
cmake -E chdir build cmake -DCMAKE_BUILD_TYPE=Release .. 
cmake --build build 
cmake -E chdir build/examples/c ./example_lib_opengjk_ce

If you get no errors, the successfull output is:

Distance between bodies 3.653650.

However, if you do get an error - any error - please file a bug! Support requests are welcome too.

Use OpenGJK in your project

The best source to learn how to use OpenGJK are the examples. They are listed here for C, C#, Go, Matlab and Python. I aim to publish few more for Julia and Unity.

Take a look at the examples folder in this repo and have fun. File a request if you wish to see more!

Contribute

You are very welcome to:

  • Create pull requests of any kind
  • Let me know if you are using this library and find it usefule
  • Open issues with request for support because they will help you and many others
  • Cite this repository (a sweet GitHub feature) or my paper: Montanari, M. et at, Improving the GJK Algorithm for Faster and More Reliable Distance Queries Between Convex Objects (2017). ACM Trans. Graph.