summary refs log tree commit diff stats
path: root/src/components/ponderable.h
blob: 221d26767b4cdc663c1ee929d53a791dd73440c1 (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
#ifndef TANGIBLE_H_746DB3EE
#define TANGIBLE_H_746DB3EE

#include <set>
#include "component.h"
#include "entity_manager.h"
#include "vector.h"
#include "direction.h"

class PonderableComponent : public Component {
public:

  using id_type = EntityManager::id_type;

  /**
   * List of different types of physical bodies.
   *
   * vacuumed     - Default.
   * freefalling  - The body will be treated as if there were a downward force
   *                of gravity being exerted onto it. The body will also exhibit
   *                terminal velocity (that is, its downward velocity will be
   *                capped at a constant value).
   */
  enum class Type {
    vacuumed,
    freefalling
  };

  /**
   * List of different types of collidable surfaces.
   */
  enum class Collision {
    wall,
    platform,
    adjacency,
    warp,
    danger,
    event
  };

  /**
   * Constructor for initializing the body type, which is a constant.
   */
  PonderableComponent(Type type) : type(type)
  {
  }

  /**
   * The velocity of the body.
   */
  vec2d vel = { 0.0, 0.0 };

  /**
   * The acceleration of the body.
   */
  vec2d accel = { 0.0, 0.0 };

  /**
   * The type of physical body that the entity is meant to assume. The body will
   * be acted upon differently based on this. See the enumeration above for more
   * details.
   *
   * @managed_by PonderingSystem
   */
  const Type type;

  /**
   * Whether or not a freefalling body is in contact with the ground.
   *
   * @managed_by PonderingSystem
   */
  bool grounded = false;

  /**
   * Whether or not a freefalling body is being ferried by another body.
   *
   * @managed_by PonderingSystem
   */
  bool ferried = false;

  /**
   * The entity that is ferrying this body, if there is one.
   *
   * @managed_by PonderingSystem
   */
  id_type ferry;

  /**
   * The side of the ferry that the body is resting on, if there is one.
   *
   * @managed_by PonderingSystem
   */
  Direction ferrySide;

  /**
   * The bodies that are being ferried by this body.
   *
   * @managed_by PonderingSystem
   */
  std::set<id_type> passengers;

  /**
   * If enabled, this will prevent the body from moving and accelerating. The
   * velocity and position of the body can still be affected by sources external
   * to the PonderingSystem. Enabling this will cause applicable bodies to
   * become ungrounded and unferried.
   */
  bool frozen = false;

  /**
   * If disabled, collision detection for this body will not be performed and
   * other bodies will ignore it. Disabling this will cause applicable bodies to
   * become ungrounded and unferried.
   */
  bool collidable = true;

  /**
   * The effect that colliding with this body has.
   */
  Collision colliderType = Collision::wall;

  /**
   * If this flag is disabled, the entity will be ignored by the pondering
   * system.
   *
   * @managed_by RealizingSystem
   */
  bool active = false;
};

#endif /* end of include guard: TANGIBLE_H_746DB3EE */