https://github.com/stephengold/sport-jolt
A Simple Physics-ORienTed 3-D graphics engine for Jolt JNI, based on OpenGL.
https://github.com/stephengold/sport-jolt
3d-graphics engine glfw graphics graphics-engine java joml jvm-library library lwjgl3 open-source opengl opengl-engine phong shaders
Last synced: 22 days ago
JSON representation
A Simple Physics-ORienTed 3-D graphics engine for Jolt JNI, based on OpenGL.
- Host: GitHub
- URL: https://github.com/stephengold/sport-jolt
- Owner: stephengold
- License: other
- Created: 2025-03-22T13:02:59.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-03-30T21:14:29.000Z (23 days ago)
- Last Synced: 2025-03-30T21:28:24.816Z (23 days ago)
- Topics: 3d-graphics, engine, glfw, graphics, graphics-engine, java, joml, jvm-library, library, lwjgl3, open-source, opengl, opengl-engine, phong, shaders
- Language: Java
- Homepage:
- Size: 1.95 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[The Sport-Jolt Project][project] implements
an [OpenGL]-based graphics engine
for [the Jolt-JNI 3-D physics library][joltjni].
It contains 2 subprojects:
1. library: the Sport-Jolt graphics engine (a single JVM runtime library)
2. java-apps: demos and non-automated test software in Java
Complete source code (in [Java]) is provided under
[a 3-clause BSD license][license].
## Contents of this document
+ [About Sport Jolt](#about)
+ [Coding a Sport-Jolt application](#add)
+ [How to build and run Sport Jolt from source](#build)
+ [Conventions](#conventions)
## About Sport Jolt
Sport Jolt is a Simple Physics-ORienTed graphics engine for [Jolt JNI][joltjni],
written in Java 11.
In addition to Jolt JNI,
it uses [LWJGL], [GLFW], [JOML], [jSnapLoader], and [OpenGL].
It has been tested on [Linux], macOS, and Windows.
[Jump to the table of contents](#toc)
### Coding a Sport-Jolt application
Every Sport-Jolt application should extend the `BasePhysicsApp` class,
which provides hooks for:
+ initializing the application,
+ creating and configuring the application's physics system,
+ populating the system with bodies and constraints, and
+ updating the system before each frame is rendered.
The graphics engine doesn't have a scene graph.
Instead, it maintains an internal list of renderable objects,
called *geometries*.
Instantiating a geometry automatically adds it to the list
and causes it to be visualized.
+ To visualize the world (physics-system) coordinate axes,
instantiate one or more `LocalAxisGeometry` objects.
By default, physics objects are not visualized.
+ To visualize the shape
of a rigid body, character, or vehicle,
invoke the `visualizeShape()` method on the object.
+ To visualize the local coordinate axes of a body, character, or vehicle,
invoke the `visualizeAxes()` method on it.
+ To visualize the wheels of a vehicle,
invoke the `visualizeWheels()` method on it.
+ To visualize the bounding box of a body, character, or vehicle,
instantiate an `AabbGeometry` for the object.
+ To visualize a `Constraint`,
instantiate a `ConstraintGeometry` for each end.
+ To visualize the faces of a soft body,
instantiate a `FacesGeometry` for it.
+ To visualize the edges of a soft body,
instantiate a `LinksGeometry` for it.
+ To visualize the pins of a soft body,
instantiate a `PinsGeometry` for it.
[Jump to the table of contents](#toc)
## How to build and run Sport Jolt from source
### Initial build
1. Install a [Java Development Kit (JDK)][adoptium],
if you don't already have one.
2. Point the `JAVA_HOME` environment variable to your JDK installation:
(In other words, set it to the path of a directory/folder
containing a "bin" that contains a Java executable.
That path might look something like
"C:\Program Files\Eclipse Adoptium\jdk-17.0.3.7-hotspot"
or "/usr/lib/jvm/java-17-openjdk-amd64/" or
"/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home" .)
+ using Bash or Zsh: `export JAVA_HOME="` *path to installation* `"`
+ using [Fish]: `set -g JAVA_HOME "` *path to installation* `"`
+ using Windows Command Prompt: `set JAVA_HOME="` *path to installation* `"`
+ using PowerShell: `$env:JAVA_HOME = '` *path to installation* `'`
3. Download and extract the Sport-Jolt source code from GitHub:
+ using [Git]:
+ `git clone https://github.com/stephengold/sport-jolt.git`
+ `cd sport-jolt`
4. Run the [Gradle] wrapper:
+ using Bash or Fish or PowerShell or Zsh: `./gradlew build`
+ using Windows Command Prompt: `.\gradlew build`
After a successful build,
[Maven] artifacts will be found in "library/build/libs".
You can install the artifacts to your local Maven repository:
+ using Bash or Fish or PowerShell or Zsh: `./gradlew install`
+ using Windows Command Prompt: `.\gradlew install`
### Cleanup
You can restore the project to a pristine state:
+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`
+ using Windows Command Prompt: `.\gradlew clean`
[Jump to the table of contents](#toc)
## Conventions
Package names begin with `com.github.stephengold.sportjolt`.
The source code and pre-built libraries are compatible with JDK 11.
Rotation signs, polygon windings, and 3-D coordinate axes
are right-handed/counter-clockwise unless otherwise noted.
Angles are quantified in *radians* unless otherwise noted.
The world coordinate system is assumed to be Z-forward, Y-up.
[Jump to the table of contents](#toc)
[adoptium]: https://adoptium.net/releases.html "Adoptium Project"
[fish]: https://fishshell.com/ "Fish command-line shell"
[git]: https://git-scm.com "Git"
[glfw]: https://www.glfw.org "GLFW Library"
[gradle]: https://gradle.org "Gradle Project"
[java]: https://en.wikipedia.org/wiki/Java_(programming_language) "Java programming language"
[joltjni]: https://github.com/stephengold/jolt-jni "Jolt JNI Project"
[joml]: https://joml-ci.github.io/JOML "Java OpenGL Math Library"
[jsnaploader]: https://github.com/Electrostat-Lab/jSnapLoader "jSnapLoader Project"
[license]: https://github.com/stephengold/sport-jolt/blob/master/LICENSE "Sport-Jolt license"
[linux]: https://www.linux.com/what-is-linux "Linux"
[lwjgl]: https://www.lwjgl.org "Lightweight Java Game Library"
[maven]: https://maven.apache.org "Maven Project"
[opengl]: https://www.khronos.org/opengl "OpenGL API"
[project]: https://github.com/stephengold/sport-jolt "Sport-Jolt Project"