https://github.com/jsh32/particlesim
Falling Sand / Cellular Automata. APCS Java assignment
https://github.com/jsh32/particlesim
cell cellular-automata falling-sand
Last synced: 3 months ago
JSON representation
Falling Sand / Cellular Automata. APCS Java assignment
- Host: GitHub
- URL: https://github.com/jsh32/particlesim
- Owner: JSH32
- Created: 2021-01-10T09:13:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-11T16:01:09.000Z (over 4 years ago)
- Last Synced: 2025-01-16T11:26:46.751Z (5 months ago)
- Topics: cell, cellular-automata, falling-sand
- Language: Java
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Cellular automata / Falling sand
`ParticleSim.SandLab.main` is the entry point. This program is designed differently than the original architecture given in the document (I have been given permission to deviate).
### Design
- `ParticleSim.Cell.getSurroundingCell`
This method looks for surrounding cells that either are any type on `Cell`'s inheritance tree, accomplished with generics. This is used in `ParticleSim.Cells.Fire` to look for surrounding `ParticleSim.FlammableCell`
- Each cell has a bitflag as does the program itself, this flag will be flipped when a cell is updated and the program's bitflag will be flipped once all updates are completed. This ensures a cell will not be updated twice after moving.
- The buttons no longer register with index numbers, instead you register classes directly and they get added as buttons with their class name, this is made possible with generics.
- Each pixel derives from Cell class and has its own update function that is called with each display update. Each pixel has a state such as `Wood`/`FlammableCell` having durability and a `damage` method.
### Important notes
I was told not to modify `ParticleSim.SandLab.run` but the time loop was broken and the slider was useless. I implemented my own TPS system for world updates per second. I changed `step` to `update` for personal preference. Due to architecture design I had to add more fields to `ParticleSim.SandLab`, this includes new buttons and bounds checking methods or circular brush sizes. The slider on the bottom that should be used for speed but didn't work is now a brush size slider. `ParticleSim.SandDisplay` was also modified to accomodate these changes.
### Running
I would have preffered to not need any build systems to make this function as it should but unfortunately with Java there is no such luck. This is bundled as a barebones maven project, as long as JDK and maven are downloaded/installed you should be able to run `run.bat` or `run.sh` in the root directory on your respective platform. A jar redistributable is attached in github releases if you do not want to manually compile it yourself.