https://github.com/tolisz/simulation_pr2
Spinning Top Simulator
https://github.com/tolisz/simulation_pr2
cpp20 opengl simulation
Last synced: 5 months ago
JSON representation
Spinning Top Simulator
- Host: GitHub
- URL: https://github.com/tolisz/simulation_pr2
- Owner: Tolisz
- License: mit
- Created: 2024-11-11T16:01:16.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-03T21:06:53.000Z (about 1 year ago)
- Last Synced: 2025-02-22T23:28:49.178Z (11 months ago)
- Topics: cpp20, opengl, simulation
- Language: C++
- Homepage:
- Size: 4.91 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spinning Top Simulator
https://github.com/user-attachments/assets/da728654-1424-4829-ac30-96f00d14a6b2
## About project
This is the second project created during *"Physical simulations in a virtual environment"* course, specialty **CAD/CAM systems design** of degree in *Computer Science and Information Systems* at *Warsaw University of Technology*.
The project is a simulation of a spinning top using Euler's equations describing rigid body dynamics. The simulation parameters are easily changeable via a convenient to use user interface. Additionally, various simulation presets were added to observe different behaviors of the spinning top. Colors of all rendered elements are changeable. For trajectory's line, there are two draw modes available: points and lines. The first one is good for observation of different integration step values.
## Compilation
The project is written in C++ (OpenGL) using CMake as a build system. It has two configuration CMake options:
| Option | Description |
| :---: | :--- |
| `PR2_EMBEDDED_SHADERS` | If `ON` shader code will be embedded into a resulting app's binary. If `OFF` shader code will be read from `shaders` directory, so a binary has to be run from repository root directory. |
| `PR2_SHOW_DEBUG_CONSOLE` | If `ON` - beside app's window - a debug console will be shown on app start up. If `OFF` only app's window will be shown. |
### MS Windows
All subsequent commands should be called from Windows Power Shell.
```
git clone --recurse-submodules -j8 https://github.com/Tolisz/Simulation_PR2.git
cd Simulation_PR2
cmake -S . -B build -DPR2_EMBEDDED_SHADERS=ON -DPR2_SHOW_DEBUG_CONSOLE=OFF
cmake --build build --config Release
```
```
.\build\Release\SimulationPr2.exe
```
### Linux
All subsequent commands should be called from terminal. Compilation was checked using **g++** (version 11.4.0) and **clang++** (version 14.0.0) compilers.
```
$ git clone --recurse-submodules -j8 https://github.com/Tolisz/Simulation_PR2.git
$ cd Simulation_PR2
$ cmake -S . -B build -DPR2_EMBEDDED_SHADERS=ON -DPR2_SHOW_DEBUG_CONSOLE=OFF
$ cmake --build build --config Release -j 26
```
```
./build/SimulationPr2
```
## Used Libraries
Libraries `GLFW`, `GLM` and `ImGui` are used as submodules located in `externals` directory. `GLAD` is used as a generated file from [this](https://glad.dav1d.de/) web page.
| Library | Licence |
| :---: | :---: |
| [GLFW](https://github.com/glfw/glfw) | [Zlib](https://github.com/glfw/glfw?tab=Zlib-1-ov-file#readme) |
| [GLM](https://github.com/g-truc/glm) | [Modified MIT](https://github.com/g-truc/glm?tab=License-1-ov-file#readme)|
| [ImGui](https://github.com/ocornut/imgui) | [MIT](https://github.com/ocornut/imgui?tab=MIT-1-ov-file#readme)|
| [GLAD](https://github.com/Dav1dde/glad) | [MIT](https://github.com/Dav1dde/glad?tab=License-1-ov-file#readme) |