Skip to content

rustgd/collision-rs

Repository files navigation

collision-rs

CI Documentation Version License Downloads Join the chat

This library is an extension of cgmath that provides collision detection primitives, bounding volumes and collision detection algorithms.

The library provides:

  • a generic ray: Ray
  • a plane type: Plane
  • a view frustum: Frustum
  • axis-aligned bounding boxes: Aabb2, Aabb3
  • oriented bounding boxes: Obb2, Obb3
  • additional bounding volumes: Sphere, Cylinder
  • collision primitives: Sphere, Circle, Rectangle, Cuboid, Particle, Convex Polygon, Convex Polyhedra
  • a dynamic bounding volume tree (DBVT)
  • broad phase collision detection: Brute Force, Sweep and Prune
  • discrete narrow phase collision detection: GJK (including EPA for manifold computation)
  • continuous narrow phase collision detection: GJK
  • convex shape distance computation: GJK

Not all of the functionality has been implemented yet, and the existing code is not fully covered by the testsuite. If you encounter any mistakes or omissions please let us know by posting an issue, or even better: send us a pull request with a fix.

License

Licensed under either of

at your option.

Contributing

Use CONTRIBUTING.md for further information.

Pull requests are most welcome, especially in the realm of performance enhancements and fixing any mistakes. Unit tests and benchmarks are also required, so help on that front would be most appreciated.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.