Gamedev Framework (gf) 1.2.0
A C++17 framework for 2D games
Move.h
1/*
2 * Gamedev Framework (gf)
3 * Copyright (C) 2016-2022 Julien Bernard
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 * 2. Altered source versions must be plainly marked as such, and must not be
18 * misrepresented as being the original software.
19 * 3. This notice may not be removed or altered from any source distribution.
20 */
21#ifndef GF_MOVE_H
22#define GF_MOVE_H
23
24#include <cstdint>
25
26#include "CoreApi.h"
27
28namespace gf {
29#ifndef DOXYGEN_SHOULD_SKIP_THIS
30inline namespace v1 {
31#endif
32
41 enum class AngularMove : uint8_t {
42 None,
43 Left,
44 Right,
45 };
46
53 GF_CORE_API float angularFactor(AngularMove move);
54
63 enum class LinearMove : uint8_t {
64 None,
65 Forward,
66 Backward,
67 };
68
75 GF_CORE_API float linearFactor(LinearMove move);
76
77#ifndef DOXYGEN_SHOULD_SKIP_THIS
78}
79#endif
80}
81
82#endif // GF_MOVE_H
AngularMove
An angular move.
Definition: Move.h:41
constexpr NoneType None
Constant to represent "none".
Definition: Types.h:45
GF_CORE_API float linearFactor(LinearMove move)
Get the linear factor from the linear move.
GF_CORE_API float angularFactor(AngularMove move)
Get the angular factor from the angular move.
LinearMove
A linear move.
Definition: Move.h:63
@ Forward
Move forward.
@ Backward
Move backward.
@ Right
Right alignement.
@ Left
Left alignement.
The namespace for gf classes.