suwako / VulkanExample

master
ブランチ master
VulkanExample / dep / include / glm / gtx / easing.hpp
6.9 KB、217行 生 Blame 履歴
1/// @ref gtx_easing
2/// @file glm/gtx/easing.hpp
3/// @author Robert Chisholm
4///
5/// @see core (dependence)
6///
7/// @defgroup gtx_easing GLM_GTX_easing
8/// @ingroup gtx
9///
10/// Include <glm/gtx/easing.hpp> to use the features of this extension.
11///
12/// Easing functions for animations and transitions
13/// All functions take a parameter x in the range [0.0,1.0]
14///
15/// Based on the AHEasing project of Warren Moore (https://github.com/warrenm/AHEasing)
16
17#pragma once
18
19// Dependency:
20#include "../glm.hpp"
21#include "../gtc/constants.hpp"
22#include "../detail/qualifier.hpp"
23
24#ifndef GLM_ENABLE_EXPERIMENTAL
25# error "GLM: GLM_GTX_easing is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."
26#elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
27# pragma message("GLM: GLM_GTX_easing extension included")
28#endif
29
30namespace glm{
31 /// @addtogroup gtx_easing
32 /// @{
33
34 /// Modelled after the line y = x
35 /// @see gtx_easing
36 template <typename genType>
37 GLM_FUNC_DECL genType linearInterpolation(genType const & a);
38
39 /// Modelled after the parabola y = x^2
40 /// @see gtx_easing
41 template <typename genType>
42 GLM_FUNC_DECL genType quadraticEaseIn(genType const & a);
43
44 /// Modelled after the parabola y = -x^2 + 2x
45 /// @see gtx_easing
46 template <typename genType>
47 GLM_FUNC_DECL genType quadraticEaseOut(genType const & a);
48
49 /// Modelled after the piecewise quadratic
50 /// y = (1/2)((2x)^2) ; [0, 0.5)
51 /// y = -(1/2)((2x-1)*(2x-3) - 1) ; [0.5, 1]
52 /// @see gtx_easing
53 template <typename genType>
54 GLM_FUNC_DECL genType quadraticEaseInOut(genType const & a);
55
56 /// Modelled after the cubic y = x^3
57 template <typename genType>
58 GLM_FUNC_DECL genType cubicEaseIn(genType const & a);
59
60 /// Modelled after the cubic y = (x - 1)^3 + 1
61 /// @see gtx_easing
62 template <typename genType>
63 GLM_FUNC_DECL genType cubicEaseOut(genType const & a);
64
65 /// Modelled after the piecewise cubic
66 /// y = (1/2)((2x)^3) ; [0, 0.5)
67 /// y = (1/2)((2x-2)^3 + 2) ; [0.5, 1]
68 /// @see gtx_easing
69 template <typename genType>
70 GLM_FUNC_DECL genType cubicEaseInOut(genType const & a);
71
72 /// Modelled after the quartic x^4
73 /// @see gtx_easing
74 template <typename genType>
75 GLM_FUNC_DECL genType quarticEaseIn(genType const & a);
76
77 /// Modelled after the quartic y = 1 - (x - 1)^4
78 /// @see gtx_easing
79 template <typename genType>
80 GLM_FUNC_DECL genType quarticEaseOut(genType const & a);
81
82 /// Modelled after the piecewise quartic
83 /// y = (1/2)((2x)^4) ; [0, 0.5)
84 /// y = -(1/2)((2x-2)^4 - 2) ; [0.5, 1]
85 /// @see gtx_easing
86 template <typename genType>
87 GLM_FUNC_DECL genType quarticEaseInOut(genType const & a);
88
89 /// Modelled after the quintic y = x^5
90 /// @see gtx_easing
91 template <typename genType>
92 GLM_FUNC_DECL genType quinticEaseIn(genType const & a);
93
94 /// Modelled after the quintic y = (x - 1)^5 + 1
95 /// @see gtx_easing
96 template <typename genType>
97 GLM_FUNC_DECL genType quinticEaseOut(genType const & a);
98
99 /// Modelled after the piecewise quintic
100 /// y = (1/2)((2x)^5) ; [0, 0.5)
101 /// y = (1/2)((2x-2)^5 + 2) ; [0.5, 1]
102 /// @see gtx_easing
103 template <typename genType>
104 GLM_FUNC_DECL genType quinticEaseInOut(genType const & a);
105
106 /// Modelled after quarter-cycle of sine wave
107 /// @see gtx_easing
108 template <typename genType>
109 GLM_FUNC_DECL genType sineEaseIn(genType const & a);
110
111 /// Modelled after quarter-cycle of sine wave (different phase)
112 /// @see gtx_easing
113 template <typename genType>
114 GLM_FUNC_DECL genType sineEaseOut(genType const & a);
115
116 /// Modelled after half sine wave
117 /// @see gtx_easing
118 template <typename genType>
119 GLM_FUNC_DECL genType sineEaseInOut(genType const & a);
120
121 /// Modelled after shifted quadrant IV of unit circle
122 /// @see gtx_easing
123 template <typename genType>
124 GLM_FUNC_DECL genType circularEaseIn(genType const & a);
125
126 /// Modelled after shifted quadrant II of unit circle
127 /// @see gtx_easing
128 template <typename genType>
129 GLM_FUNC_DECL genType circularEaseOut(genType const & a);
130
131 /// Modelled after the piecewise circular function
132 /// y = (1/2)(1 - sqrt(1 - 4x^2)) ; [0, 0.5)
133 /// y = (1/2)(sqrt(-(2x - 3)*(2x - 1)) + 1) ; [0.5, 1]
134 /// @see gtx_easing
135 template <typename genType>
136 GLM_FUNC_DECL genType circularEaseInOut(genType const & a);
137
138 /// Modelled after the exponential function y = 2^(10(x - 1))
139 /// @see gtx_easing
140 template <typename genType>
141 GLM_FUNC_DECL genType exponentialEaseIn(genType const & a);
142
143 /// Modelled after the exponential function y = -2^(-10x) + 1
144 /// @see gtx_easing
145 template <typename genType>
146 GLM_FUNC_DECL genType exponentialEaseOut(genType const & a);
147
148 /// Modelled after the piecewise exponential
149 /// y = (1/2)2^(10(2x - 1)) ; [0,0.5)
150 /// y = -(1/2)*2^(-10(2x - 1))) + 1 ; [0.5,1]
151 /// @see gtx_easing
152 template <typename genType>
153 GLM_FUNC_DECL genType exponentialEaseInOut(genType const & a);
154
155 /// Modelled after the damped sine wave y = sin(13pi/2*x)*pow(2, 10 * (x - 1))
156 /// @see gtx_easing
157 template <typename genType>
158 GLM_FUNC_DECL genType elasticEaseIn(genType const & a);
159
160 /// Modelled after the damped sine wave y = sin(-13pi/2*(x + 1))*pow(2, -10x) + 1
161 /// @see gtx_easing
162 template <typename genType>
163 GLM_FUNC_DECL genType elasticEaseOut(genType const & a);
164
165 /// Modelled after the piecewise exponentially-damped sine wave:
166 /// y = (1/2)*sin(13pi/2*(2*x))*pow(2, 10 * ((2*x) - 1)) ; [0,0.5)
167 /// y = (1/2)*(sin(-13pi/2*((2x-1)+1))*pow(2,-10(2*x-1)) + 2) ; [0.5, 1]
168 /// @see gtx_easing
169 template <typename genType>
170 GLM_FUNC_DECL genType elasticEaseInOut(genType const & a);
171
172 /// @see gtx_easing
173 template <typename genType>
174 GLM_FUNC_DECL genType backEaseIn(genType const& a);
175
176 /// @see gtx_easing
177 template <typename genType>
178 GLM_FUNC_DECL genType backEaseOut(genType const& a);
179
180 /// @see gtx_easing
181 template <typename genType>
182 GLM_FUNC_DECL genType backEaseInOut(genType const& a);
183
184 /// @param a parameter
185 /// @param o Optional overshoot modifier
186 /// @see gtx_easing
187 template <typename genType>
188 GLM_FUNC_DECL genType backEaseIn(genType const& a, genType const& o);
189
190 /// @param a parameter
191 /// @param o Optional overshoot modifier
192 /// @see gtx_easing
193 template <typename genType>
194 GLM_FUNC_DECL genType backEaseOut(genType const& a, genType const& o);
195
196 /// @param a parameter
197 /// @param o Optional overshoot modifier
198 /// @see gtx_easing
199 template <typename genType>
200 GLM_FUNC_DECL genType backEaseInOut(genType const& a, genType const& o);
201
202 /// @see gtx_easing
203 template <typename genType>
204 GLM_FUNC_DECL genType bounceEaseIn(genType const& a);
205
206 /// @see gtx_easing
207 template <typename genType>
208 GLM_FUNC_DECL genType bounceEaseOut(genType const& a);
209
210 /// @see gtx_easing
211 template <typename genType>
212 GLM_FUNC_DECL genType bounceEaseInOut(genType const& a);
213
214 /// @}
215}//namespace glm
216
217#include "easing.inl"