# {py:mod}`simvx.core.nodes_2d.background_bands`

```{py:module} simvx.core.nodes_2d.background_bands
```

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`BackgroundBands <simvx.core.nodes_2d.background_bands.BackgroundBands>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands
    :summary:
    ```
````

### Data

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

* - {py:obj}`Band <simvx.core.nodes_2d.background_bands.Band>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.Band
    :summary:
    ```
````

### API

````{py:data} Band
:canonical: simvx.core.nodes_2d.background_bands.Band
:value: >
   None

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.Band
```

````

`````{py:class} BackgroundBands(bands: collections.abc.Sequence[simvx.core.nodes_2d.background_bands.Band] | None = None, world_space: bool = True, **kwargs)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands

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

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.__init__
```

````{py:attribute} world_space
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.world_space
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.world_space
```

````

````{py:property} bands
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.bands
:type: list[simvx.core.nodes_2d.background_bands.Band]

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.bands
```

````

````{py:method} add_band(top_y: float, colour: tuple[float, ...], bottom_colour: tuple[float, ...] | None = None) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.add_band

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.add_band
```

````

````{py:method} clear_bands() -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.clear_bands

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.clear_bands
```

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_draw

```{autodoc2-docstring} simvx.core.nodes_2d.background_bands.BackgroundBands.on_draw
```

````

````{py:attribute} position
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.absolute_z_index
:type: int

````

````{py:property} rotation_degrees
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.rotation_degrees
:type: float

````

````{py:property} world_position
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_transform
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.world_transform
:type: tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2, float]

````

````{py:property} forward
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.right
:type: simvx.core.math.types.Vec2

````

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

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.rotate_deg

````

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

````

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

````

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

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.get_node

````

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

````

````{py:method} find(target: type | str, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.find

````

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

````

````{py:method} walk(*, include_self: bool = True) -> collections.abc.Iterator[simvx.core.node.Node]
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.walk

````

````{py:property} path
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_exit_tree

````

````{py:method} on_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_process

````

````{py:method} on_physics_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_physics_process

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.app

````

````{py:property} tree
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_2d.background_bands.BackgroundBands.__repr__

````

`````