mgf 0.2.0

A 3D collision and physics framework for video games.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# MGF: Matt's Game Framework

[![Documentation](https://docs.rs/mgf/badge.svg)](https://docs.rs/mgf)
[![Version](https://img.shields.io/crates/v/mgf.svg)](https://crates.io/crates/mgf)
[![License](https://img.shields.io/crates/l/mgf.svg)](https://github.com/DataAnalysisCosby/mgf/blob/master/LICENSE)
[![Downloads](https://img.shields.io/crates/d/mgf.svg)](https://crates.io/crates/mgf)

MGF is a collision detection and physics library for use in 3D video games.

The library provides various features such as:

- structures to define shapes: `Ray`, `Segment`, `AABB`, `Rectangle`, `Triangle`, `Sphere`, `Capsule`
- structures to define aggregate shapes: `Mesh`, `Compound`
- discrete collision detection: `Overlaps`, `Contains`
- continuous collision detection: `Intersection`, `Contact`, `LocalContact`
- a bounding volume hierarchy: `BVH`
- rigid body physics: `RigidBody`, `StaticBody`
- dynamic containers: `Pool`

MGF is very much in its infancy and is therefore not feature complete. If you
notice any errors or poorly thought out interfaces be sure to let me know.

## 3D only

For the time being MGF is solely designed to handle 3D video games. This 
reflects my own use of MGF. If there is enough demand for MGF to support 2D
games, it may in the future.

## Contributing

MGF is welcome to anyone's contribution, and any part of the interface is open to 
discussion. Although if you are going to contribute new features please do 
be sure to include unit tests.