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

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

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

## Module Contents

### Classes

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

* - {py:obj}`Sprite2D <simvx.core.animation.sprite.Sprite2D>`
  - ```{autodoc2-docstring} simvx.core.animation.sprite.Sprite2D
    :summary:
    ```
* - {py:obj}`SpriteAnimation <simvx.core.animation.sprite.SpriteAnimation>`
  - ```{autodoc2-docstring} simvx.core.animation.sprite.SpriteAnimation
    :summary:
    ```
* - {py:obj}`AnimatedSprite2D <simvx.core.animation.sprite.AnimatedSprite2D>`
  - ```{autodoc2-docstring} simvx.core.animation.sprite.AnimatedSprite2D
    :summary:
    ```
````

### API

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

Bases: {py:obj}`simvx.core.nodes_2d.node2d.Node2D`

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

```{rubric} Initialization
```

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

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

````

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

````

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

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.animation.sprite.Sprite2D.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.animation.sprite.Sprite2D.is_on_render_layer

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:attribute} strict_errors
:canonical: simvx.core.animation.sprite.Sprite2D.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.sprite.Sprite2D.find

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} app
:canonical: simvx.core.animation.sprite.Sprite2D.app

````

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

````

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

````

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

````

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

````

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

````

`````

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

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

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

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

````

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

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

````

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

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

````

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

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

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

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

```{rubric} Initialization
```

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

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

````

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

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

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

````

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

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

````

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

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.animation.sprite.AnimatedSprite2D.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.animation.sprite.AnimatedSprite2D.is_on_render_layer

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:attribute} strict_errors
:canonical: simvx.core.animation.sprite.AnimatedSprite2D.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.animation.sprite.AnimatedSprite2D.find

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} app
:canonical: simvx.core.animation.sprite.AnimatedSprite2D.app

````

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

````

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

````

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

````

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

````

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

````

`````