Antkeeper  0.0.1
gait.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_ANIMATION_GAIT_HPP
21 #define ANTKEEPER_ANIMATION_GAIT_HPP
22 
23 #include <engine/animation/locomotion/step.hpp>
24 #include <vector>
25 
29 struct gait
30 {
31 public:
33  float frequency{};
34 
36  std::vector<step> steps;
37 
45  [[nodiscard]] float phase(float t) const noexcept;
46 };
47 
48 #endif // ANTKEEPER_ANIMATION_GAIT_HPP
gait
Describes the synchronized timing of limbs in a locomotion pattern.
Definition: gait.hpp:30
gait::frequency
float frequency
Frequency of the gait cycle, in Hz.
Definition: gait.hpp:33
gait::phase
float phase(float t) const noexcept
Returns the phase of the gait at the elapsed time.
Definition: gait.cpp:24
gait::steps
std::vector< step > steps
Array of steps for each limb.
Definition: gait.hpp:36