summaryrefslogtreecommitdiff
path: root/platformer/src/physics.h
blob: 580d09bf33eac75921f1f4ff20ceec29e179cd8d (plain) (blame)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
 * ============================================================
 * FILE:        physics.h
 *
 * PURPOSE:     Public interface for generic physical motion: a `Body` that
 *              falls, moves and lands on the ground. It knows nothing about
 *              players or controllers, so enemies and objects can reuse it later.
 *
 * FITS IN:     player.c owns a Body, sets its horizontal velocity from input,
 *              then calls physics_step() once per tick. physics.c asks world.h
 *              about the ground and the bounds.
 *
 * INTERFACE:   Use these exact names:
 *
 *   typedef struct Body {
 *       Vec3 pos;        position of the body's FEET (bottom center), meters
 *       Vec3 vel;        velocity, meters/second
 *       bool on_ground;  true if the body ended the last step standing on ground
 *   } Body;
 *
 *   void physics_step(Body *b, float dt);
 *
 *   Include <stdbool.h> and "math3d.h".
 *
 * CONVENTIONS: Include guard: PHYSICS_H.
 *
 * NOT IN SCOPE: Rigid bodies, rotation, mass, forces/impulses API, collision
 *              between bodies.
 *
 * DONE WHEN:   player.c can move and land using only Body + physics_step.
 * ============================================================
 */
#ifndef PHYSICS_H
#define PHYSICS_H

#include <stdbool.h>

#include "math3d.h"

typedef struct Body {
    Vec3 pos;        /* position of the body's FEET (bottom center), meters */
    Vec3 vel;        /* velocity, meters/second */
    bool on_ground;  /* true if the body ended the last step standing on ground */
} Body;

void physics_step(Body *b, float dt);

#endif /* PHYSICS_H */