# {py:mod}`simvx.core.animation.tween`

```{py:module} simvx.core.animation.tween
```

```{autodoc2-docstring} simvx.core.animation.tween
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`TweenChain <simvx.core.animation.tween.TweenChain>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.TweenChain
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ease_linear <simvx.core.animation.tween.ease_linear>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_linear
    :summary:
    ```
* - {py:obj}`ease_in_quad <simvx.core.animation.tween.ease_in_quad>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quad
    :summary:
    ```
* - {py:obj}`ease_out_quad <simvx.core.animation.tween.ease_out_quad>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quad
    :summary:
    ```
* - {py:obj}`ease_in_out_quad <simvx.core.animation.tween.ease_in_out_quad>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quad
    :summary:
    ```
* - {py:obj}`ease_in_cubic <simvx.core.animation.tween.ease_in_cubic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_cubic
    :summary:
    ```
* - {py:obj}`ease_out_cubic <simvx.core.animation.tween.ease_out_cubic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_cubic
    :summary:
    ```
* - {py:obj}`ease_in_out_cubic <simvx.core.animation.tween.ease_in_out_cubic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_cubic
    :summary:
    ```
* - {py:obj}`ease_in_quart <simvx.core.animation.tween.ease_in_quart>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quart
    :summary:
    ```
* - {py:obj}`ease_out_quart <simvx.core.animation.tween.ease_out_quart>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quart
    :summary:
    ```
* - {py:obj}`ease_in_out_quart <simvx.core.animation.tween.ease_in_out_quart>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quart
    :summary:
    ```
* - {py:obj}`ease_in_quint <simvx.core.animation.tween.ease_in_quint>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quint
    :summary:
    ```
* - {py:obj}`ease_out_quint <simvx.core.animation.tween.ease_out_quint>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quint
    :summary:
    ```
* - {py:obj}`ease_in_out_quint <simvx.core.animation.tween.ease_in_out_quint>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quint
    :summary:
    ```
* - {py:obj}`ease_in_sine <simvx.core.animation.tween.ease_in_sine>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_sine
    :summary:
    ```
* - {py:obj}`ease_out_sine <simvx.core.animation.tween.ease_out_sine>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_sine
    :summary:
    ```
* - {py:obj}`ease_in_out_sine <simvx.core.animation.tween.ease_in_out_sine>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_sine
    :summary:
    ```
* - {py:obj}`ease_in_expo <simvx.core.animation.tween.ease_in_expo>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_expo
    :summary:
    ```
* - {py:obj}`ease_out_expo <simvx.core.animation.tween.ease_out_expo>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_expo
    :summary:
    ```
* - {py:obj}`ease_in_out_expo <simvx.core.animation.tween.ease_in_out_expo>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_expo
    :summary:
    ```
* - {py:obj}`ease_in_back <simvx.core.animation.tween.ease_in_back>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_back
    :summary:
    ```
* - {py:obj}`ease_out_back <simvx.core.animation.tween.ease_out_back>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_back
    :summary:
    ```
* - {py:obj}`ease_in_out_back <simvx.core.animation.tween.ease_in_out_back>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_back
    :summary:
    ```
* - {py:obj}`ease_in_elastic <simvx.core.animation.tween.ease_in_elastic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_elastic
    :summary:
    ```
* - {py:obj}`ease_out_elastic <simvx.core.animation.tween.ease_out_elastic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_elastic
    :summary:
    ```
* - {py:obj}`ease_in_out_elastic <simvx.core.animation.tween.ease_in_out_elastic>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_elastic
    :summary:
    ```
* - {py:obj}`ease_in_bounce <simvx.core.animation.tween.ease_in_bounce>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_bounce
    :summary:
    ```
* - {py:obj}`ease_out_bounce <simvx.core.animation.tween.ease_out_bounce>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_out_bounce
    :summary:
    ```
* - {py:obj}`ease_in_out_bounce <simvx.core.animation.tween.ease_in_out_bounce>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_bounce
    :summary:
    ```
* - {py:obj}`tween <simvx.core.animation.tween.tween>`
  - ```{autodoc2-docstring} simvx.core.animation.tween.tween
    :summary:
    ```
````

### API

````{py:function} ease_linear(t: float) -> float
:canonical: simvx.core.animation.tween.ease_linear

```{autodoc2-docstring} simvx.core.animation.tween.ease_linear
```
````

````{py:function} ease_in_quad(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_quad

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quad
```
````

````{py:function} ease_out_quad(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_quad

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quad
```
````

````{py:function} ease_in_out_quad(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_quad

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quad
```
````

````{py:function} ease_in_cubic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_cubic

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_cubic
```
````

````{py:function} ease_out_cubic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_cubic

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_cubic
```
````

````{py:function} ease_in_out_cubic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_cubic

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_cubic
```
````

````{py:function} ease_in_quart(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_quart

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quart
```
````

````{py:function} ease_out_quart(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_quart

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quart
```
````

````{py:function} ease_in_out_quart(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_quart

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quart
```
````

````{py:function} ease_in_quint(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_quint

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_quint
```
````

````{py:function} ease_out_quint(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_quint

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_quint
```
````

````{py:function} ease_in_out_quint(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_quint

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_quint
```
````

````{py:function} ease_in_sine(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_sine

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_sine
```
````

````{py:function} ease_out_sine(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_sine

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_sine
```
````

````{py:function} ease_in_out_sine(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_sine

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_sine
```
````

````{py:function} ease_in_expo(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_expo

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_expo
```
````

````{py:function} ease_out_expo(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_expo

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_expo
```
````

````{py:function} ease_in_out_expo(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_expo

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_expo
```
````

````{py:function} ease_in_back(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_back

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_back
```
````

````{py:function} ease_out_back(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_back

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_back
```
````

````{py:function} ease_in_out_back(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_back

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_back
```
````

````{py:function} ease_in_elastic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_elastic

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_elastic
```
````

````{py:function} ease_out_elastic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_elastic

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_elastic
```
````

````{py:function} ease_in_out_elastic(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_elastic

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_elastic
```
````

````{py:function} ease_in_bounce(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_bounce

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_bounce
```
````

````{py:function} ease_out_bounce(t: float) -> float
:canonical: simvx.core.animation.tween.ease_out_bounce

```{autodoc2-docstring} simvx.core.animation.tween.ease_out_bounce
```
````

````{py:function} ease_in_out_bounce(t: float) -> float
:canonical: simvx.core.animation.tween.ease_in_out_bounce

```{autodoc2-docstring} simvx.core.animation.tween.ease_in_out_bounce
```
````

`````{py:class} TweenChain(obj, prop: str, start_value=None)
:canonical: simvx.core.animation.tween.TweenChain

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain.__init__
```

````{py:method} to(target, duration: float, easing=ease_linear)
:canonical: simvx.core.animation.tween.TweenChain.to

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain.to
```

````

````{py:method} wait(duration: float, fps: float = 60.0)
:canonical: simvx.core.animation.tween.TweenChain.wait

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain.wait
```

````

````{py:method} on_complete(callback: collections.abc.Callable)
:canonical: simvx.core.animation.tween.TweenChain.on_complete

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain.on_complete
```

````

````{py:method} build(fps: float = 60.0) -> simvx.core.descriptors.Coroutine
:canonical: simvx.core.animation.tween.TweenChain.build

```{autodoc2-docstring} simvx.core.animation.tween.TweenChain.build
```

````

`````

````{py:function} tween(obj, prop: str, target, duration: float, easing=ease_linear, delay: float = 0, repeat: int = 1, on_step: collections.abc.Callable[[float], None] | None = None, on_repeat: collections.abc.Callable[[int], None] | None = None, on_complete: collections.abc.Callable | None = None, fps: float = 60.0) -> simvx.core.descriptors.Coroutine
:canonical: simvx.core.animation.tween.tween

```{autodoc2-docstring} simvx.core.animation.tween.tween
```
````