Antkeeper  0.0.1
step.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_STEP_HPP
21 #define ANTKEEPER_ANIMATION_STEP_HPP
22 
26 struct step
27 {
28 public:
30  float duty_factor{};
31 
33  float delay{};
34 
42  [[nodiscard]] float phase(float t) const noexcept;
43 };
44 
45 #endif // ANTKEEPER_ANIMATION_STEP_HPP
step
Describes the timing of a single step in a gait.
Definition: step.hpp:27
step::phase
float phase(float t) const noexcept
Returns the phase of the step at the given gait phase.
Definition: step.cpp:24
step::delay
float delay
Fraction of the gait cycle, on [0, 1], at which the limb enters the swing phase.
Definition: step.hpp:33
step::duty_factor
float duty_factor
Fraction of the gait cycle, on [0, 1], in which the limb is in the stance phase.
Definition: step.hpp:30