irlanrobson / Bounce

Bounce

Welcome! Bounce is a 3D physics engine for games.

Features

Common

• Efficient data structures with no use of STL
• Frame, stack, and pool allocators
• Built-in math library
• Tunable settings used across the entire library

Collision

• Dynamic tree broadphase
• Static tree "midphase"
• SAT
• GJK
• Spheres, capsules, convex hulls, triangle meshes, signed distance functions
• Optimized pair management

Dynamics

• Rigid bodies
• Gyroscopic motion solver
• Contact, friction, restitution
• Mouse, spring, sphere, cone, revolute, friction, weld, motor, prismatic, wheel joint types
• Soft constraints
• Quaternion constraints
• Joint motors, limits
• Constraint graphs
• Simulation islands and sleep management
• Linear time solver
• Stable shape stacking
• One-shot contact manifolds
• Contact clustering, reduction, and persistence
• Contact callbacks: begin, pre-solve, post-solve
• Ray-casting, convex-casting, and volume queries

Soft Body

• Soft body using finite elements
• Stretch, spring, mouse, triangle and tetrahedron element force types
• Vertex contact, friction
• Elasticity, plasticity
• Linear/non-linear time solver
• Unconditional simulation stability
• Ray-casting

Rope

• Rope using joint coordinates
• Linear time dynamics

Testbed

• OpenGL 2 with GLFW and GLAD
• UI by imgui
• Mouse picking
• premake build system

Documentation

• Doxygen API documentation
• Quickstart Guide

License

Bounce is released under the zlib license. Please recognize this software in the product documentation if possible.

Dependencies

Testbed

External

These are the external dependencies for the Testbed example project. If you don't care about Testbed, then you don't need these dependencies.

• GLFW
• GLAD
• imgui
• Triangle

Internal

There are a couple of single file header libraries in the root directory of the project tree that are used across the library. I call them internal dependencies because I wrote them. I haven't researched a better name for them, although probably there exist one.

Contributing

You can ask anything relative to this project using the issue tracker.

Please do not open pull requests with bugfixes or new features that require large changes. Open an issue first for discussion.

Building

Bounce uses premake for generating project files in a platform agnostic manner. premake is available at https://premake.github.io/.

• Put premake into bounce/.

Windows

Visual Studio 2019

• Say { premake5 vs2019 } on a command line.
• Open build/vs2019/bounce.sln.
• Set testbed as the startup project.
• In the testbed debugging properties, set Working Directory to ..\..\examples\testbed.
• Press F5 to run.

Linux

GNU Make

x86

• Say { ./premake5 gmake2 } on a terminal.
• From build/gmake2 say { make config="debug_x86" }.
• Set the testbed directory as the working directory.
• From bin/x86/debug/testbed say { ./testbed }.

x64

• Say { ./premake5 gmake2 } on a terminal.
• From build/gmake2 say { make config="debug_x86_64" }.
• Set the testbed directory as the working directory.
• From bin/x86_64/debug/testbed say { ./testbed }.
• Install packages as necessary.

Mac

I don't run Mac currently and therefore can't test the build system in this platform.

Doxygen

• Grab Doxygen from http://www.doxygen.org.
• Say the following on the command line: doxygen doxyfile.
• Open doc/api/html/index.html.

While there isn't a complete user manual available for Bounce, you can use the quickstart guide and the Testbed for learning how to use Bounce. Testbed is a collection of visual tests and examples that can support the development of the library. As you would imagine, this application is not part of the library.