Skip to content

Easing Functions

Module: terminaltexteffects.utils.easing

This module contains functions for easing calculations.

Functions:

Name Description
linear

Linear easing function.
in_sine

Ease in using a sine function.
out_sine

Ease out using a sine function.
in_out_sine

Ease in/out using a sine function.
in_quad

Ease in using a quadratic function.
out_quad

Ease out using a quadratic function.
in_out_quad

Ease in/out using a quadratic function.
in_cubic

Ease in using a cubic function.
out_cubic

Ease out using a cubic function.
in_out_cubic

Ease in/out using a cubic function.
in_quart

Ease in using a quartic function.
out_quart

Ease out using a quartic function.
in_out_quart

Ease in/out using a quartic function.
in_quint

Ease in using a quintic function.
out_quint

Ease out using a quintic function.
in_out_quint

Ease in/out using a quintic function.
in_expo

Ease in using an exponential function.
out_expo

Ease out using an exponential function.
in_out_expo

Ease in/out using an exponential function.
in_circ

Ease in using a circular function.
out_circ

Ease out using a circular function.
in_out_circ

Ease in/out using a circular function.
in_back

Ease in using a back function.
out_back

Ease out using a back function.
in_out_back

Ease in/out using a back function.
in_elastic

Ease in using an elastic function.
out_elastic

Ease out using an elastic function.
in_out_elastic

Ease in/out using an elastic function.
in_bounce

Ease in using a bounce function.
out_bounce

Ease out using a bounce function.
in_out_bounce

Ease in/out using a bounce function.

EasingFunction = typing.Callable[[float], float] module-attribute

EasingFunctions are Callable[[float], float] functions that take a float between 0 and 1 and return a float between 0 and 1.

in_back(progress_ratio)

Ease in using a back function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
367
368
369
370
371
372
373
374
375
376
377
378
379
def in_back(progress_ratio: float) -> float:
    """
    Ease in using a back function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    c1 = 1.70158
    c3 = c1 + 1
    return c3 * progress_ratio**3 - c1 * progress_ratio**2

in_bounce(progress_ratio)

Ease in using a bounce function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
Source code in terminaltexteffects/utils/easing.py 
475
476
477
478
479
480
481
482
483
484
485
def in_bounce(progress_ratio: float) -> float:
    """
    Ease in using a bounce function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
    """
    return 1 - out_bounce(1 - progress_ratio)

in_circ(progress_ratio)

Ease in using a circular function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
325
326
327
328
329
330
331
332
333
334
335
def in_circ(progress_ratio: float) -> float:
    """
    Ease in using a circular function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return 1 - math.sqrt(1 - progress_ratio**2)

in_cubic(progress_ratio)

Ease in using a cubic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
145
146
147
148
149
150
151
152
153
154
155
def in_cubic(progress_ratio: float) -> float:
    """
    Ease in using a cubic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return progress_ratio**3

in_elastic(progress_ratio)

Ease in using an elastic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
def in_elastic(progress_ratio: float) -> float:
    """
    Ease in using an elastic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """

    c4 = (2 * math.pi) / 3
    if progress_ratio == 0:
        return 0
    elif progress_ratio == 1:
        return 1
    else:
        return -(2 ** (10 * progress_ratio - 10)) * math.sin((progress_ratio * 10 - 10.75) * c4)

in_expo(progress_ratio)

Ease in using an exponential function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
273
274
275
276
277
278
279
280
281
282
283
284
285
286
def in_expo(progress_ratio: float) -> float:
    """
    Ease in using an exponential function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio == 0:
        return 0
    else:
        return 2 ** (10 * progress_ratio - 10)

in_out_back(progress_ratio)

Ease in/out using a back function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
def in_out_back(progress_ratio: float) -> float:
    """
    Ease in/out using a back function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    c1 = 1.70158
    c2 = c1 * 1.525
    if progress_ratio < 0.5:
        return ((2 * progress_ratio) ** 2 * ((c2 + 1) * 2 * progress_ratio - c2)) / 2
    else:
        return ((2 * progress_ratio - 2) ** 2 * ((c2 + 1) * (progress_ratio * 2 - 2) + c2) + 2) / 2

in_out_bounce(progress_ratio)

Ease in/out using a bounce function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
510
511
512
513
514
515
516
517
518
519
520
521
522
523
def in_out_bounce(progress_ratio: float) -> float:
    """
    Ease in/out using a bounce function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio < 0.5:
        return (1 - out_bounce(1 - 2 * progress_ratio)) / 2
    else:
        return (1 + out_bounce(2 * progress_ratio - 1)) / 2

in_out_circ(progress_ratio)

Ease in/out using a circular function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
351
352
353
354
355
356
357
358
359
360
361
362
363
364
def in_out_circ(progress_ratio: float) -> float:
    """
    Ease in/out using a circular function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio < 0.5:
        return (1 - math.sqrt(1 - (2 * progress_ratio) ** 2)) / 2
    else:
        return (math.sqrt(1 - (-2 * progress_ratio + 2) ** 2) + 1) / 2

in_out_cubic(progress_ratio)

Ease in/out using a cubic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the
float

character
Source code in terminaltexteffects/utils/easing.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
def in_out_cubic(progress_ratio: float) -> float:
    """
    Ease in/out using a cubic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the
        character
    """
    if progress_ratio < 0.5:
        return 4 * progress_ratio**3
    else:
        return 1 - (-2 * progress_ratio + 2) ** 3 / 2

in_out_elastic(progress_ratio)

Ease in/out using an elastic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
Source code in terminaltexteffects/utils/easing.py 
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
def in_out_elastic(progress_ratio: float) -> float:
    """
    Ease in/out using an elastic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
    """
    c5 = (2 * math.pi) / 4.5
    if progress_ratio == 0:
        return 0
    elif progress_ratio == 1:
        return 1
    elif progress_ratio < 0.5:
        return -(2 ** (20 * progress_ratio - 10) * math.sin((20 * progress_ratio - 11.125) * c5)) / 2
    else:
        return (2 ** (-20 * progress_ratio + 10) * math.sin((20 * progress_ratio - 11.125) * c5)) / 2 + 1

in_out_expo(progress_ratio)

Ease in/out using an exponential function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
def in_out_expo(progress_ratio: float) -> float:
    """
    Ease in/out using an exponential function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio == 0:
        return 0
    elif progress_ratio == 1:
        return 1
    elif progress_ratio < 0.5:
        return 2 ** (20 * progress_ratio - 10) / 2
    else:
        return (2 - 2 ** (-20 * progress_ratio + 10)) / 2

in_out_quad(progress_ratio)

Ease in/out using a quadratic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def in_out_quad(progress_ratio: float) -> float:
    """
    Ease in/out using a quadratic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value

    """
    if progress_ratio < 0.5:
        return 2 * progress_ratio**2
    else:
        return 1 - (-2 * progress_ratio + 2) ** 2 / 2

in_out_quart(progress_ratio)

Ease in/out using a quartic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def in_out_quart(progress_ratio: float) -> float:
    """
    Ease in/out using a quartic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio < 0.5:
        return 8 * progress_ratio**4
    else:
        return 1 - (-2 * progress_ratio + 2) ** 4 / 2

in_out_quint(progress_ratio)

Ease in/out using a quintic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
257
258
259
260
261
262
263
264
265
266
267
268
269
270
def in_out_quint(progress_ratio: float) -> float:
    """
    Ease in/out using a quintic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio < 0.5:
        return 16 * progress_ratio**5
    else:
        return 1 - (-2 * progress_ratio + 2) ** 5 / 2

in_out_sine(progress_ratio)

Ease in/out using a sine function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
86
87
88
89
90
91
92
93
94
95
96
97
def in_out_sine(progress_ratio: float) -> float:
    """
    Ease in/out using a sine function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """

    return -(math.cos(math.pi * progress_ratio) - 1) / 2

in_quad(progress_ratio)

Ease in using a quadratic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
100
101
102
103
104
105
106
107
108
109
110
111
def in_quad(progress_ratio: float) -> float:
    """
    Ease in using a quadratic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """

    return progress_ratio**2

in_quart(progress_ratio)

Ease in using a quartic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 representing the percentage
float

of the current waypoint speed to apply to the character
Source code in terminaltexteffects/utils/easing.py 
188
189
190
191
192
193
194
195
196
197
198
199
def in_quart(progress_ratio: float) -> float:
    """
    Ease in using a quartic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 representing the percentage
        of the current waypoint speed to apply to the character
    """
    return progress_ratio**4

in_quint(progress_ratio)

Ease in using a quintic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
231
232
233
234
235
236
237
238
239
240
241
def in_quint(progress_ratio: float) -> float:
    """
    Ease in using a quintic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return progress_ratio**5

in_sine(progress_ratio)

Ease in using a sine function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
60
61
62
63
64
65
66
67
68
69
70
def in_sine(progress_ratio: float) -> float:
    """
    Ease in using a sine function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return 1 - math.cos((progress_ratio * math.pi) / 2)

linear(progress_ratio)

Linear easing function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
47
48
49
50
51
52
53
54
55
56
57
def linear(progress_ratio: float) -> float:
    """
    Linear easing function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return progress_ratio

out_back(progress_ratio)

Ease out using a back function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
382
383
384
385
386
387
388
389
390
391
392
393
394
def out_back(progress_ratio: float) -> float:
    """
    Ease out using a back function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    c1 = 1.70158
    c3 = c1 + 1
    return 1 + c3 * (progress_ratio - 1) ** 3 + c1 * (progress_ratio - 1) ** 2

out_bounce(progress_ratio)

Ease out using a bounce function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
def out_bounce(progress_ratio: float) -> float:
    """
    Ease out using a bounce function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    n1 = 7.5625
    d1 = 2.75
    if progress_ratio < 1 / d1:
        return n1 * progress_ratio**2
    elif progress_ratio < 2 / d1:
        return n1 * (progress_ratio - 1.5 / d1) ** 2 + 0.75
    elif progress_ratio < 2.5 / d1:
        return n1 * (progress_ratio - 2.25 / d1) ** 2 + 0.9375
    else:
        return n1 * (progress_ratio - 2.625 / d1) ** 2 + 0.984375

out_circ(progress_ratio)

Ease out using a circular function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
338
339
340
341
342
343
344
345
346
347
348
def out_circ(progress_ratio: float) -> float:
    """
    Ease out using a circular function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return math.sqrt(1 - (progress_ratio - 1) ** 2)

out_cubic(progress_ratio)

Ease out using a cubic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
158
159
160
161
162
163
164
165
166
167
168
def out_cubic(progress_ratio: float) -> float:
    """
    Ease out using a cubic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return 1 - (1 - progress_ratio) ** 3

out_elastic(progress_ratio)

Ease out using an elastic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
Source code in terminaltexteffects/utils/easing.py 
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
def out_elastic(progress_ratio: float) -> float:
    """
    Ease out using an elastic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 representing the percentage of the current waypoint speed to apply to the character
    """
    c4 = (2 * math.pi) / 3
    if progress_ratio == 0:
        return 0
    elif progress_ratio == 1:
        return 1
    else:
        return 2 ** (-10 * progress_ratio) * math.sin((progress_ratio * 10 - 0.75) * c4) + 1

out_expo(progress_ratio)

Ease out using an exponential function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
def out_expo(progress_ratio: float) -> float:
    """
    Ease out using an exponential function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    if progress_ratio == 1:
        return 1
    else:
        return 1 - 2 ** (-10 * progress_ratio)

out_quad(progress_ratio)

Ease out using a quadratic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
114
115
116
117
118
119
120
121
122
123
124
125
def out_quad(progress_ratio: float) -> float:
    """
    Ease out using a quadratic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value

    """
    return 1 - (1 - progress_ratio) * (1 - progress_ratio)

out_quart(progress_ratio)

Ease out using a quartic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
202
203
204
205
206
207
208
209
210
211
212
def out_quart(progress_ratio: float) -> float:
    """
    Ease out using a quartic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return 1 - (1 - progress_ratio) ** 4

out_quint(progress_ratio)

Ease out using a quintic function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
244
245
246
247
248
249
250
251
252
253
254
def out_quint(progress_ratio: float) -> float:
    """
    Ease out using a quintic function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return 1 - (1 - progress_ratio) ** 5

out_sine(progress_ratio)

Ease out using a sine function.

Parameters:

Name Type Description Default
progress_ratio float

the ratio of the current step to the maximum steps

 required

Returns:

Name Type Description
float float

0 <= n <= 1 eased value
Source code in terminaltexteffects/utils/easing.py 
73
74
75
76
77
78
79
80
81
82
83
def out_sine(progress_ratio: float) -> float:
    """
    Ease out using a sine function.

    Args:
        progress_ratio (float): the ratio of the current step to the maximum steps

    Returns:
        float: 0 <= n <= 1 eased value
    """
    return math.sin((progress_ratio * math.pi) / 2)