Antkeeper  0.0.1
constraint-system.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_GAME_CONSTRAINT_SYSTEM_HPP
21 #define ANTKEEPER_GAME_CONSTRAINT_SYSTEM_HPP
22 
23 #include "game/systems/updatable-system.hpp"
24 #include "game/components/transform-component.hpp"
25 #include "game/constraints/child-of-constraint.hpp"
26 #include "game/constraints/copy-rotation-constraint.hpp"
27 #include "game/constraints/copy-scale-constraint.hpp"
28 #include "game/constraints/copy-transform-constraint.hpp"
29 #include "game/constraints/copy-translation-constraint.hpp"
30 #include "game/constraints/ease-to-constraint.hpp"
31 #include "game/constraints/pivot-constraint.hpp"
32 #include "game/constraints/spring-rotation-constraint.hpp"
33 #include "game/constraints/spring-to-constraint.hpp"
34 #include "game/constraints/spring-translation-constraint.hpp"
35 #include "game/constraints/three-dof-constraint.hpp"
36 #include "game/constraints/track-to-constraint.hpp"
37 #include <engine/entity/id.hpp>
38 
39 
43 class constraint_system:
44  public updatable_system
45 {
46 public:
47  explicit constraint_system(entity::registry& registry);
48  ~constraint_system();
49 
50  virtual void update(float t, float dt);
51 
57  void evaluate(entity::id entity_id);
58 
59 private:
60  void on_constraint_stack_update(entity::registry& registry, entity::id constraint_stack_eid);
61 
62  void handle_constraint(transform_component& transform, entity::id constraint_eid, float dt);
63  void handle_child_of_constraint(transform_component& transform, const child_of_constraint& constraint);
64  void handle_copy_rotation_constraint(transform_component& transform, const copy_rotation_constraint& constraint);
65  void handle_copy_scale_constraint(transform_component& transform, const copy_scale_constraint& constraint);
66  void handle_copy_transform_constraint(transform_component& transform, const copy_transform_constraint& constraint);
67  void handle_copy_translation_constraint(transform_component& transform, const copy_translation_constraint& constraint);
68  void handle_ease_to_constraint(transform_component& transform, ease_to_constraint& constraint, float dt);
69  void handle_pivot_constraint(transform_component& transform, const pivot_constraint& constraint);
70  void handle_spring_rotation_constraint(transform_component& transform, spring_rotation_constraint& constraint, float dt);
71  void handle_spring_to_constraint(transform_component& transform, spring_to_constraint& constraint, float dt);
72  void handle_spring_translation_constraint(transform_component& transform, spring_translation_constraint& constraint, float dt);
73  void handle_three_dof_constraint(transform_component& transform, const three_dof_constraint& constraint);
74  void handle_track_to_constraint(transform_component& transform, const track_to_constraint& constraint);
75 };
76 
77 
78 #endif // ANTKEEPER_GAME_CONSTRAINT_SYSTEM_HPP
constraint_system
Applies constraint stacks to transform components.
Definition: constraint-system.hpp:45
constraint_system::~constraint_system
~constraint_system()
Definition: constraint-system.cpp:32
constraint_system::constraint_system
constraint_system(entity::registry &registry)
Definition: constraint-system.cpp:24
constraint_system::update
virtual void update(float t, float dt)
Perform's a system's update() function.
Definition: constraint-system.cpp:39
constraint_system::evaluate
void evaluate(entity::id entity_id)
Manually evaluates an entity's constraints.
Definition: constraint-system.cpp:73
updatable_system
Abstract base class for updatable systems.
Definition: updatable-system.hpp:30
updatable_system::registry
entity::registry & registry
Registry on which the system operate.
Definition: updatable-system.hpp:49
entity::registry
entt::registry registry
Component registry type.
Definition: registry.hpp:28
entity::id
entt::entity id
Entity ID type.
Definition: id.hpp:28
child_of_constraint
Makes the entity a child of the target entity.
Definition: child-of-constraint.hpp:31
copy_rotation_constraint
Copies the rotation of a target entity.
Definition: copy-rotation-constraint.hpp:30
copy_scale_constraint
Copies the scale of a target entity.
Definition: copy-scale-constraint.hpp:30
copy_transform_constraint
Copies the transform of a target entity.
Definition: copy-transform-constraint.hpp:30
copy_translation_constraint
Copies the translation of a target entity.
Definition: copy-translation-constraint.hpp:30
ease_to_constraint
Eases toward a target entity.
Definition: ease-to-constraint.hpp:31
pivot_constraint
Pivots around a target entity.
Definition: pivot-constraint.hpp:31
spring_rotation_constraint
Definition: spring-rotation-constraint.hpp:31
spring_to_constraint
Springs to a target entity.
Definition: spring-to-constraint.hpp:32
spring_translation_constraint
Definition: spring-translation-constraint.hpp:31
three_dof_constraint
Builds rotation from 3DoF angles.
Definition: three-dof-constraint.hpp:28
track_to_constraint
Rotates a transform to face a target.
Definition: track-to-constraint.hpp:31
transform_component
Definition: transform-component.hpp:27