Metadata-Version: 2.1
Name: easing-functions
Version: 1.0.1
Summary: A collection of the basic easing functions for python
Home-page: https://github.com/semitable/easing-functions
Author: Filippos Christianos
Author-email: almak72@gmail.com
License: GPL 3.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# easing-functions
A collection of Penner's easing functions for python

The collection includes the following ease in/ease out and ease inout:
1. Quadratic (Quad)
2. Cubic
3. Quartic
4. Quintic
5. Sine,
6. Circular,
7. Exponential,
8. Elastic,
9. Back,
10. Bounce

# Some Examples:
![Cubic Ease](/docs/cubic.png?raw=true)
![Bounce Ease](/docs/bounce.png?raw=true)
![Back Ease](/docs/back.png?raw=true)



# To use:
```python
from easing_functions import *

# For a duration 10 you will get the relevant output from start to end
a = QuadEaseInOut(start=0, end = 3, duration = 10)
k = a.ease(4) # 4 is a number between 0 and the duration you specified

#k is the returned value from start to end (0 to 3)

# example plots:

import numpy as np

import matplotlib.pyplot as plt

a = BounceEaseInOut(start=3, end=1, duration=1)
b = BounceEaseIn(start=0, end=1)
c = BounceEaseOut(start=0, end=1)

x = np.arange(0, 1, 0.001)
y0 = list(map(a.ease, x))
y1 = list(map(b.ease, x))
y2 = list(map(c.ease, x))

plt.plot(x,y0)
plt.plot(x,y1)
plt.plot(x,y2)
```


