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

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

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

## Module Contents

### Classes

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

* - {py:obj}`TweenChain <simvx.core.animation.TweenChain>`
  - ```{autodoc2-docstring} simvx.core.animation.TweenChain
    :summary:
    ```
* - {py:obj}`Sprite2D <simvx.core.animation.Sprite2D>`
  - ```{autodoc2-docstring} simvx.core.animation.Sprite2D
    :summary:
    ```
* - {py:obj}`SpriteAnimation <simvx.core.animation.SpriteAnimation>`
  - ```{autodoc2-docstring} simvx.core.animation.SpriteAnimation
    :summary:
    ```
* - {py:obj}`AnimatedSprite2D <simvx.core.animation.AnimatedSprite2D>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D
    :summary:
    ```
* - {py:obj}`AnimationEvent <simvx.core.animation.AnimationEvent>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimationEvent
    :summary:
    ```
* - {py:obj}`Track <simvx.core.animation.Track>`
  - ```{autodoc2-docstring} simvx.core.animation.Track
    :summary:
    ```
* - {py:obj}`AnimationClip <simvx.core.animation.AnimationClip>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimationClip
    :summary:
    ```
* - {py:obj}`AnimationPlayer <simvx.core.animation.AnimationPlayer>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimationPlayer
    :summary:
    ```
* - {py:obj}`AnimationState <simvx.core.animation.AnimationState>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimationState
    :summary:
    ```
* - {py:obj}`Transition <simvx.core.animation.Transition>`
  - ```{autodoc2-docstring} simvx.core.animation.Transition
    :summary:
    ```
* - {py:obj}`AnimationTree <simvx.core.animation.AnimationTree>`
  - ```{autodoc2-docstring} simvx.core.animation.AnimationTree
    :summary:
    ```
* - {py:obj}`BlendSpace1D <simvx.core.animation.BlendSpace1D>`
  - ```{autodoc2-docstring} simvx.core.animation.BlendSpace1D
    :summary:
    ```
* - {py:obj}`BlendSpace2D <simvx.core.animation.BlendSpace2D>`
  - ```{autodoc2-docstring} simvx.core.animation.BlendSpace2D
    :summary:
    ```
* - {py:obj}`BoneTrack <simvx.core.animation.BoneTrack>`
  - ```{autodoc2-docstring} simvx.core.animation.BoneTrack
    :summary:
    ```
* - {py:obj}`SkeletalAnimationClip <simvx.core.animation.SkeletalAnimationClip>`
  - ```{autodoc2-docstring} simvx.core.animation.SkeletalAnimationClip
    :summary:
    ```
````

### Functions

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

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

### Data

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

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

### API

````{py:data} log
:canonical: simvx.core.animation.log
:value: >
   'getLogger(...)'

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

````

````{py:data} __all__
:canonical: simvx.core.animation.__all__
:value: >
   ['tween', 'TweenChain', 'ease_linear', 'ease_in_quad', 'ease_out_quad', 'ease_in_out_quad', 'ease_in...

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

````

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

```{rubric} Initialization
```

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

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

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

````

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

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

````

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

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

````

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

```{autodoc2-docstring} simvx.core.animation.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

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

`````{py:class} Sprite2D(texture: str | None = None, position=None, rotation: float = 0.0, scale=None, color: tuple = (1.0, 1.0, 1.0, 1.0), width: int = 0, height: int = 0, **kwargs)
:canonical: simvx.core.animation.Sprite2D

Bases: {py:obj}`simvx.core.engine.Node2D`

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.Sprite2D.__init__
```

````{py:attribute} texture
:canonical: simvx.core.animation.Sprite2D.texture
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.animation.Sprite2D.texture
```

````

````{py:attribute} color
:canonical: simvx.core.animation.Sprite2D.color
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.animation.Sprite2D.color
```

````

````{py:attribute} width
:canonical: simvx.core.animation.Sprite2D.width
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.animation.Sprite2D.width
```

````

````{py:attribute} height
:canonical: simvx.core.animation.Sprite2D.height
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.animation.Sprite2D.height
```

````

````{py:property} texture_path
:canonical: simvx.core.animation.Sprite2D.texture_path
:type: str

```{autodoc2-docstring} simvx.core.animation.Sprite2D.texture_path
```

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.animation.Sprite2D.draw

```{autodoc2-docstring} simvx.core.animation.Sprite2D.draw
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.Sprite2D.to_dict

```{autodoc2-docstring} simvx.core.animation.Sprite2D.to_dict
```

````

````{py:method} from_dict(data: dict)
:canonical: simvx.core.animation.Sprite2D.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.Sprite2D.from_dict
```

````

````{py:attribute} z_index
:canonical: simvx.core.animation.Sprite2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.animation.Sprite2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.animation.Sprite2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.animation.Sprite2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.animation.Sprite2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.animation.Sprite2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.animation.Sprite2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.animation.Sprite2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.animation.Sprite2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.animation.Sprite2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.animation.Sprite2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.animation.Sprite2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.animation.Sprite2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.animation.Sprite2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.animation.Sprite2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.animation.Sprite2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.animation.Sprite2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.animation.Sprite2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.animation.Sprite2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.animation.Sprite2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.animation.Sprite2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.animation.Sprite2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.animation.Sprite2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.animation.Sprite2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.animation.Sprite2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.animation.Sprite2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.animation.Sprite2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.animation.Sprite2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.Sprite2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.Sprite2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.animation.Sprite2D.find_all

````

````{py:property} path
:canonical: simvx.core.animation.Sprite2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.animation.Sprite2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.animation.Sprite2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.animation.Sprite2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.animation.Sprite2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.animation.Sprite2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.animation.Sprite2D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.animation.Sprite2D.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.animation.Sprite2D.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.animation.Sprite2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.Sprite2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.Sprite2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.animation.Sprite2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.animation.Sprite2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.animation.Sprite2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.animation.Sprite2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.animation.Sprite2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.animation.Sprite2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.animation.Sprite2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.animation.Sprite2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.animation.Sprite2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.animation.Sprite2D.__repr__

````

`````

`````{py:class} SpriteAnimation
:canonical: simvx.core.animation.SpriteAnimation

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

````{py:attribute} name
:canonical: simvx.core.animation.SpriteAnimation.name
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.SpriteAnimation.name
```

````

````{py:attribute} frames
:canonical: simvx.core.animation.SpriteAnimation.frames
:type: list[int]
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.SpriteAnimation.frames
```

````

````{py:attribute} fps
:canonical: simvx.core.animation.SpriteAnimation.fps
:type: float
:value: >
   10.0

```{autodoc2-docstring} simvx.core.animation.SpriteAnimation.fps
```

````

````{py:attribute} loop
:canonical: simvx.core.animation.SpriteAnimation.loop
:type: bool
:value: >
   True

```{autodoc2-docstring} simvx.core.animation.SpriteAnimation.loop
```

````

`````

`````{py:class} AnimatedSprite2D(texture: str = None, frames_horizontal: int = 1, frames_vertical: int = 1, frame_width: int | None = None, frame_height: int | None = None, **kwargs)
:canonical: simvx.core.animation.AnimatedSprite2D

Bases: {py:obj}`simvx.core.animation.Sprite2D`

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.__init__
```

````{py:method} add_animation(name: str, frames: list[int], fps: float = 10.0, loop: bool = True)
:canonical: simvx.core.animation.AnimatedSprite2D.add_animation

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.add_animation
```

````

````{py:method} play(animation_name: str = 'default')
:canonical: simvx.core.animation.AnimatedSprite2D.play

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.play
```

````

````{py:method} stop()
:canonical: simvx.core.animation.AnimatedSprite2D.stop

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.stop
```

````

````{py:method} pause()
:canonical: simvx.core.animation.AnimatedSprite2D.pause

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.pause
```

````

````{py:method} resume()
:canonical: simvx.core.animation.AnimatedSprite2D.resume

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.resume
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.animation.AnimatedSprite2D.process

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.process
```

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.animation.AnimatedSprite2D.draw

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.draw
```

````

````{py:method} get_current_frame_index() -> int
:canonical: simvx.core.animation.AnimatedSprite2D.get_current_frame_index

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.get_current_frame_index
```

````

````{py:method} get_frame_uv() -> tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2]
:canonical: simvx.core.animation.AnimatedSprite2D.get_frame_uv

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.get_frame_uv
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.AnimatedSprite2D.to_dict

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.to_dict
```

````

````{py:method} from_dict(data: dict)
:canonical: simvx.core.animation.AnimatedSprite2D.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.AnimatedSprite2D.from_dict
```

````

````{py:attribute} texture
:canonical: simvx.core.animation.AnimatedSprite2D.texture
:value: >
   'Property(...)'

````

````{py:attribute} color
:canonical: simvx.core.animation.AnimatedSprite2D.color
:value: >
   'Property(...)'

````

````{py:attribute} width
:canonical: simvx.core.animation.AnimatedSprite2D.width
:value: >
   'Property(...)'

````

````{py:attribute} height
:canonical: simvx.core.animation.AnimatedSprite2D.height
:value: >
   'Property(...)'

````

````{py:property} texture_path
:canonical: simvx.core.animation.AnimatedSprite2D.texture_path
:type: str

````

````{py:attribute} z_index
:canonical: simvx.core.animation.AnimatedSprite2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.animation.AnimatedSprite2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.animation.AnimatedSprite2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.animation.AnimatedSprite2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.animation.AnimatedSprite2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.animation.AnimatedSprite2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.animation.AnimatedSprite2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.animation.AnimatedSprite2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.animation.AnimatedSprite2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.animation.AnimatedSprite2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.animation.AnimatedSprite2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.animation.AnimatedSprite2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.animation.AnimatedSprite2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.animation.AnimatedSprite2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.animation.AnimatedSprite2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.animation.AnimatedSprite2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.animation.AnimatedSprite2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.animation.AnimatedSprite2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.animation.AnimatedSprite2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.animation.AnimatedSprite2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.animation.AnimatedSprite2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.animation.AnimatedSprite2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.animation.AnimatedSprite2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.animation.AnimatedSprite2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimatedSprite2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimatedSprite2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimatedSprite2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimatedSprite2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimatedSprite2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimatedSprite2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.animation.AnimatedSprite2D.find_all

````

````{py:property} path
:canonical: simvx.core.animation.AnimatedSprite2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.animation.AnimatedSprite2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.animation.AnimatedSprite2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.animation.AnimatedSprite2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.animation.AnimatedSprite2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.animation.AnimatedSprite2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.animation.AnimatedSprite2D.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.animation.AnimatedSprite2D.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.animation.AnimatedSprite2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimatedSprite2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimatedSprite2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.animation.AnimatedSprite2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.animation.AnimatedSprite2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.animation.AnimatedSprite2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.animation.AnimatedSprite2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.animation.AnimatedSprite2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.animation.AnimatedSprite2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.animation.AnimatedSprite2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.animation.AnimatedSprite2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.animation.AnimatedSprite2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.animation.AnimatedSprite2D.__repr__

````

`````

`````{py:class} AnimationEvent
:canonical: simvx.core.animation.AnimationEvent

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

````{py:attribute} time
:canonical: simvx.core.animation.AnimationEvent.time
:type: float
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.AnimationEvent.time
```

````

````{py:attribute} callback
:canonical: simvx.core.animation.AnimationEvent.callback
:type: collections.abc.Callable
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.AnimationEvent.callback
```

````

````{py:attribute} args
:canonical: simvx.core.animation.AnimationEvent.args
:type: tuple
:value: >
   ()

```{autodoc2-docstring} simvx.core.animation.AnimationEvent.args
```

````

`````

`````{py:class} Track(property_name: str)
:canonical: simvx.core.animation.Track

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.Track.__init__
```

````{py:method} add_keyframe(time: float, value: typing.Any)
:canonical: simvx.core.animation.Track.add_keyframe

```{autodoc2-docstring} simvx.core.animation.Track.add_keyframe
```

````

````{py:method} add_event(time: float, callback: collections.abc.Callable, *args)
:canonical: simvx.core.animation.Track.add_event

```{autodoc2-docstring} simvx.core.animation.Track.add_event
```

````

````{py:method} fire_events(prev_time: float, cur_time: float) -> None
:canonical: simvx.core.animation.Track.fire_events

```{autodoc2-docstring} simvx.core.animation.Track.fire_events
```

````

````{py:method} evaluate(time: float) -> typing.Any
:canonical: simvx.core.animation.Track.evaluate

```{autodoc2-docstring} simvx.core.animation.Track.evaluate
```

````

`````

`````{py:class} AnimationClip(name: str, duration: float)
:canonical: simvx.core.animation.AnimationClip

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.AnimationClip.__init__
```

````{py:method} add_track(property_name: str, keyframes: list[tuple[float, typing.Any]], easing=ease_linear)
:canonical: simvx.core.animation.AnimationClip.add_track

```{autodoc2-docstring} simvx.core.animation.AnimationClip.add_track
```

````

````{py:method} evaluate(time: float) -> dict[str, typing.Any]
:canonical: simvx.core.animation.AnimationClip.evaluate

```{autodoc2-docstring} simvx.core.animation.AnimationClip.evaluate
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.AnimationClip.to_dict

```{autodoc2-docstring} simvx.core.animation.AnimationClip.to_dict
```

````

````{py:method} from_dict(data: dict)
:canonical: simvx.core.animation.AnimationClip.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.AnimationClip.from_dict
```

````

`````

`````{py:class} AnimationPlayer(target=None, **kwargs)
:canonical: simvx.core.animation.AnimationPlayer

Bases: {py:obj}`simvx.core.engine.Node`

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.__init__
```

````{py:method} add_clip(clip: simvx.core.animation.AnimationClip)
:canonical: simvx.core.animation.AnimationPlayer.add_clip

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.add_clip
```

````

````{py:method} play(clip_name: str, loop: bool = False)
:canonical: simvx.core.animation.AnimationPlayer.play

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.play
```

````

````{py:method} crossfade(clip_name: str, duration: float = 0.3)
:canonical: simvx.core.animation.AnimationPlayer.crossfade

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.crossfade
```

````

````{py:method} stop()
:canonical: simvx.core.animation.AnimationPlayer.stop

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.stop
```

````

````{py:method} pause()
:canonical: simvx.core.animation.AnimationPlayer.pause

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.pause
```

````

````{py:method} resume()
:canonical: simvx.core.animation.AnimationPlayer.resume

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.resume
```

````

````{py:method} seek(time: float)
:canonical: simvx.core.animation.AnimationPlayer.seek

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.seek
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.animation.AnimationPlayer.process

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.process
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.AnimationPlayer.to_dict

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.to_dict
```

````

````{py:method} from_dict(data: dict, target=None)
:canonical: simvx.core.animation.AnimationPlayer.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.AnimationPlayer.from_dict
```

````

````{py:attribute} script_error_raised
:canonical: simvx.core.animation.AnimationPlayer.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.animation.AnimationPlayer.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.animation.AnimationPlayer.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.animation.AnimationPlayer.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.animation.AnimationPlayer.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimationPlayer.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimationPlayer.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimationPlayer.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimationPlayer.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimationPlayer.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimationPlayer.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.animation.AnimationPlayer.find_all

````

````{py:property} path
:canonical: simvx.core.animation.AnimationPlayer.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.animation.AnimationPlayer.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.animation.AnimationPlayer.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.animation.AnimationPlayer.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.animation.AnimationPlayer.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.animation.AnimationPlayer.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.animation.AnimationPlayer.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.animation.AnimationPlayer.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.animation.AnimationPlayer.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.animation.AnimationPlayer.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimationPlayer.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimationPlayer.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.animation.AnimationPlayer.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.animation.AnimationPlayer.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.animation.AnimationPlayer.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.animation.AnimationPlayer.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.animation.AnimationPlayer.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.animation.AnimationPlayer.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.animation.AnimationPlayer.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.animation.AnimationPlayer.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.animation.AnimationPlayer.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.animation.AnimationPlayer.__repr__

````

`````

`````{py:class} AnimationState
:canonical: simvx.core.animation.AnimationState

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

````{py:attribute} name
:canonical: simvx.core.animation.AnimationState.name
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.AnimationState.name
```

````

````{py:attribute} clip
:canonical: simvx.core.animation.AnimationState.clip
:type: simvx.core.animation.AnimationClip
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.AnimationState.clip
```

````

````{py:attribute} speed_scale
:canonical: simvx.core.animation.AnimationState.speed_scale
:type: float
:value: >
   1.0

```{autodoc2-docstring} simvx.core.animation.AnimationState.speed_scale
```

````

````{py:attribute} loop
:canonical: simvx.core.animation.AnimationState.loop
:type: bool
:value: >
   True

```{autodoc2-docstring} simvx.core.animation.AnimationState.loop
```

````

`````

`````{py:class} Transition
:canonical: simvx.core.animation.Transition

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

````{py:attribute} from_state
:canonical: simvx.core.animation.Transition.from_state
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.Transition.from_state
```

````

````{py:attribute} to_state
:canonical: simvx.core.animation.Transition.to_state
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.Transition.to_state
```

````

````{py:attribute} condition
:canonical: simvx.core.animation.Transition.condition
:type: collections.abc.Callable[[], bool]
:value: >
   None

```{autodoc2-docstring} simvx.core.animation.Transition.condition
```

````

````{py:attribute} blend_time
:canonical: simvx.core.animation.Transition.blend_time
:type: float
:value: >
   0.2

```{autodoc2-docstring} simvx.core.animation.Transition.blend_time
```

````

`````

`````{py:class} AnimationTree(target=None, **kwargs)
:canonical: simvx.core.animation.AnimationTree

Bases: {py:obj}`simvx.core.engine.Node`

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.AnimationTree.__init__
```

````{py:method} add_state(name: str, clip: simvx.core.animation.AnimationClip, speed_scale: float = 1.0, loop: bool = True)
:canonical: simvx.core.animation.AnimationTree.add_state

```{autodoc2-docstring} simvx.core.animation.AnimationTree.add_state
```

````

````{py:method} add_transition(from_state: str, to_state: str, condition: collections.abc.Callable[[], bool], blend_time: float = 0.2)
:canonical: simvx.core.animation.AnimationTree.add_transition

```{autodoc2-docstring} simvx.core.animation.AnimationTree.add_transition
```

````

````{py:method} set_parameter(name: str, value: typing.Any)
:canonical: simvx.core.animation.AnimationTree.set_parameter

```{autodoc2-docstring} simvx.core.animation.AnimationTree.set_parameter
```

````

````{py:method} get_parameter(name: str, default: typing.Any = None) -> typing.Any
:canonical: simvx.core.animation.AnimationTree.get_parameter

```{autodoc2-docstring} simvx.core.animation.AnimationTree.get_parameter
```

````

````{py:method} start(state_name: str)
:canonical: simvx.core.animation.AnimationTree.start

```{autodoc2-docstring} simvx.core.animation.AnimationTree.start
```

````

````{py:method} stop()
:canonical: simvx.core.animation.AnimationTree.stop

```{autodoc2-docstring} simvx.core.animation.AnimationTree.stop
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.animation.AnimationTree.process

```{autodoc2-docstring} simvx.core.animation.AnimationTree.process
```

````

````{py:method} to_dict() -> dict
:canonical: simvx.core.animation.AnimationTree.to_dict

```{autodoc2-docstring} simvx.core.animation.AnimationTree.to_dict
```

````

````{py:method} from_dict(data: dict, target=None)
:canonical: simvx.core.animation.AnimationTree.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.animation.AnimationTree.from_dict
```

````

````{py:attribute} script_error_raised
:canonical: simvx.core.animation.AnimationTree.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.animation.AnimationTree.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.animation.AnimationTree.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.animation.AnimationTree.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.animation.AnimationTree.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimationTree.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimationTree.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.animation.AnimationTree.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.animation.AnimationTree.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimationTree.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.AnimationTree.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.animation.AnimationTree.find_all

````

````{py:property} path
:canonical: simvx.core.animation.AnimationTree.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.animation.AnimationTree.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.animation.AnimationTree.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.animation.AnimationTree.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.animation.AnimationTree.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.animation.AnimationTree.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.animation.AnimationTree.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.animation.AnimationTree.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.animation.AnimationTree.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.animation.AnimationTree.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimationTree.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.animation.AnimationTree.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.animation.AnimationTree.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.animation.AnimationTree.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.animation.AnimationTree.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.animation.AnimationTree.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.animation.AnimationTree.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.animation.AnimationTree.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.animation.AnimationTree.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.animation.AnimationTree.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.animation.AnimationTree.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.animation.AnimationTree.__repr__

````

`````

`````{py:class} BlendSpace1D()
:canonical: simvx.core.animation.BlendSpace1D

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.__init__
```

````{py:method} add_point(clip: simvx.core.animation.AnimationClip, position: float) -> None
:canonical: simvx.core.animation.BlendSpace1D.add_point

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.add_point
```

````

````{py:method} set_parameter(value: float) -> None
:canonical: simvx.core.animation.BlendSpace1D.set_parameter

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.set_parameter
```

````

````{py:property} parameter
:canonical: simvx.core.animation.BlendSpace1D.parameter
:type: float

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.parameter
```

````

````{py:method} sample(property_path: str, time: float) -> typing.Any
:canonical: simvx.core.animation.BlendSpace1D.sample

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.sample
```

````

````{py:method} sample_all(time: float) -> dict[str, typing.Any]
:canonical: simvx.core.animation.BlendSpace1D.sample_all

```{autodoc2-docstring} simvx.core.animation.BlendSpace1D.sample_all
```

````

`````

`````{py:class} BlendSpace2D()
:canonical: simvx.core.animation.BlendSpace2D

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.BlendSpace2D.__init__
```

````{py:method} add_point(clip: simvx.core.animation.AnimationClip, position: tuple[float, float]) -> None
:canonical: simvx.core.animation.BlendSpace2D.add_point

```{autodoc2-docstring} simvx.core.animation.BlendSpace2D.add_point
```

````

````{py:method} set_parameter(x: float, y: float) -> None
:canonical: simvx.core.animation.BlendSpace2D.set_parameter

```{autodoc2-docstring} simvx.core.animation.BlendSpace2D.set_parameter
```

````

````{py:method} sample(property_path: str, time: float) -> typing.Any
:canonical: simvx.core.animation.BlendSpace2D.sample

```{autodoc2-docstring} simvx.core.animation.BlendSpace2D.sample
```

````

````{py:method} sample_all(time: float) -> dict[str, typing.Any]
:canonical: simvx.core.animation.BlendSpace2D.sample_all

```{autodoc2-docstring} simvx.core.animation.BlendSpace2D.sample_all
```

````

`````

`````{py:class} BoneTrack(bone_index: int)
:canonical: simvx.core.animation.BoneTrack

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.BoneTrack.__init__
```

````{py:method} sample(time: float) -> numpy.ndarray
:canonical: simvx.core.animation.BoneTrack.sample

```{autodoc2-docstring} simvx.core.animation.BoneTrack.sample
```

````

`````

`````{py:class} SkeletalAnimationClip(name: str, duration: float)
:canonical: simvx.core.animation.SkeletalAnimationClip

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

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.animation.SkeletalAnimationClip.__init__
```

````{py:method} add_bone_track(track: simvx.core.animation.BoneTrack) -> None
:canonical: simvx.core.animation.SkeletalAnimationClip.add_bone_track

```{autodoc2-docstring} simvx.core.animation.SkeletalAnimationClip.add_bone_track
```

````

````{py:method} evaluate(time: float) -> dict[int, numpy.ndarray]
:canonical: simvx.core.animation.SkeletalAnimationClip.evaluate

```{autodoc2-docstring} simvx.core.animation.SkeletalAnimationClip.evaluate
```

````

`````