Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pmonks/gravity

Mathematically dubious riffs on Newton's law of universal gravitation
https://github.com/pmonks/gravity

2d-graphics clojure gravity newton simulation

Last synced: 9 days ago
JSON representation

Mathematically dubious riffs on Newton's law of universal gravitation

Host: GitHub
URL: https://github.com/pmonks/gravity
Owner: pmonks
License: agpl-3.0
Created: 2019-12-15T00:55:29.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-05-07T17:06:34.000Z (6 months ago)
Last Synced: 2024-10-15T15:18:11.503Z (21 days ago)
Topics: 2d-graphics, clojure, gravity, newton, simulation
Language: Clojure
Homepage:
Size: 3.48 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: COPYING
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

[![Build](https://github.com/pmonks/gravity/workflows/CI/badge.svg?branch=main)](https://github.com/pmonks/gravity/actions?query=workflow%3ACI+branch%3Amain) [![Dependencies](https://github.com/pmonks/gravity/workflows/dependencies/badge.svg?branch=main)](https://github.com/pmonks/gravity/actions?query=workflow%3Adependencies+branch%3Amain) [![Open Issues](https://img.shields.io/github/issues/pmonks/gravity.svg)](https://github.com/pmonks/gravity/issues) [![License](https://img.shields.io/github/license/pmonks/gravity.svg)](https://github.com/pmonks/gravity/blob/main/COPYING)

# gravity

A micro codebase that plays around with some mathematically dubious riffs on Newton's law of universal gravitation, in order to produce some pretty (though unrealistic) animations:

![Demo](demo.gif?raw=true "Demo")

Note: actual animation is smoother than what's shown in this screencap.

## Trying it Out
Clone the repo, then run:

```shell
$ clj -i init.clj -r
```

Look for the Java GUI window and bring it into focus; an initial random simulation will be running in it. Press the 'q' key to close the window, or use the OS controls.

To run another random simulation, with between 50 and 200 randomly located objects:

```clojure
(gg/simulate width height (gu/gen-random-objs 50 200 width height))
```

## Code Structure

The code is divided into 2 primary namespaces: `gravity.core` and `gravity.gui`, and one supplementary namespace: `gravity.util`.

### gravity.core

This ns contains pure logic for calculating the pseudo-gravitational effects a sequence of 'objects' has on one another. Objects are simple maps with these keys (all of which are unitless numerical values):

* `:x` - x location
* `:y` - y location
* `:x-vel` - velocity in the horizontal dimension (optional, defaults to 0)
* `:y-vel` - velocity in the vertical dimension (optional, defaults to 0)
* `:mass` - mass of the object (optional, defaults to 1)

To step the objects, based on the (fudged) forces they exert on one another, the function `gravity.core/step-simul` may be called. The first, mandatory, parameter is the sequence of objects to use as input, and it returns an equivalent sequence with all of the objects' positions and velocities updated.

The remaining, optional, parameters allow the caller to specify that the objects "bounce" at the edge of a given bounding box. These parameters are:

2. `merge-collided-objects?` - boolean indicating whether to merge objects that have collided or not
3. `bounce-at-edge?` - boolean indicating whether edge bouncing is enabled or not
4. `min-x` - the minimum value of the horizontal dimension of the bounding box
5. `min-y` - the minimum value of the vertical dimension of the bounding box
6. `max-x` - the maximum value of the horizontal dimension of the bounding box
7. `max-y` - the maximum value of the vertical dimension of the bounding box

### gravity.gui

This ns contains the logic related to displaying a simulation in a GUI window, currently via the [`clojure2d` library](https://github.com/Clojure2D/clojure2d). The primary function here is `gravity.gui/simulate`, which takes these parameters:

1. `width` - the width of the window, in pixels
2. `height` - the height of the window, in pixels
3. `objs` - the sequence of objects to use in the simulation
4. `:trails true/false` - an optional flag that indicates whether the visualisation should have object trails or not (defaults to `false`)

The window runs independently of the calling thread, and terminates when the window is closed via OS mechanisms, or when the 'q' key is pressed while the window has focus.

Note that this also means you can have any number of independent simulation windows open concurrently.

### gravity.util

Includes a `gen-random-objs` fn that will create a random number of randomly located objects, with random velocities.
It takes four mandatory parameters:

1. `mini` - the minimum number of objects to create (inclusive)
2. `maxi` - the maximum number of objects to create (inclusive)
3. `width` - the maximum x coordinate to generate
4. `height` - the maximum y coordinate to generate

## Contributor Information

[GitHub project](https://github.com/pmonks/gravity)

[Bug Tracker](https://github.com/pmonks/gravity/issues)

## License

This work is licensed under the [GNU Affero General Public License v3.0 or later](http://www.gnu.org/licenses/agpl-3.0.html).

SPDX-License-Identifier: [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html)