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

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

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

## Module Contents

### Classes

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

* - {py:obj}`WaterMaterial <simvx.core.water.WaterMaterial>`
  - ```{autodoc2-docstring} simvx.core.water.WaterMaterial
    :summary:
    ```
* - {py:obj}`WaterSurface3D <simvx.core.water.WaterSurface3D>`
  - ```{autodoc2-docstring} simvx.core.water.WaterSurface3D
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.water.__all__
:value: >
   ['WaterMaterial', 'WaterSurface3D']

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

````

`````{py:class} WaterMaterial(*, shallow_colour: tuple[float, float, float] = (0.1, 0.38, 0.42), deep_colour: tuple[float, float, float] = (0.02, 0.09, 0.16), depth_fade_distance: float = 3.0, wave_amplitude: float = 0.18, wave_steepness: float = 0.55, wave_length: float = 6.0, wave_direction: float = 0.6, direction_spread: float = 0.8, wave_speed: float = 1.0, normal_scroll_speed: float = 0.05, normal_strength: float = 0.5, foam_colour: tuple[float, float, float] = (0.9, 0.95, 1.0), foam_amount: float = 0.6, refraction_strength: float = 0.35, fresnel_power: float = 5.0, roughness: float = 0.04, opacity: float = 0.92)
:canonical: simvx.core.water.WaterMaterial

```{autodoc2-docstring} simvx.core.water.WaterMaterial
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.water.WaterMaterial.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.water.WaterMaterial.__slots__
:value: >
   ('shallow_colour', 'deep_colour', 'depth_fade_distance', 'wave_amplitude', 'wave_steepness', 'wave_l...

```{autodoc2-docstring} simvx.core.water.WaterMaterial.__slots__
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.water.WaterMaterial.__repr__

````

`````

`````{py:class} WaterSurface3D(material: simvx.core.water.WaterMaterial | None = None, reflection=None, **kwargs)
:canonical: simvx.core.water.WaterSurface3D

Bases: {py:obj}`simvx.core.nodes_3d.node3d.Node3D`

```{autodoc2-docstring} simvx.core.water.WaterSurface3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.__init__
```

````{py:attribute} size
:canonical: simvx.core.water.WaterSurface3D.size
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.size
```

````

````{py:attribute} subdivisions
:canonical: simvx.core.water.WaterSurface3D.subdivisions
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.subdivisions
```

````

````{py:attribute} gizmo_colour
:canonical: simvx.core.water.WaterSurface3D.gizmo_colour
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.gizmo_colour
```

````

````{py:property} material
:canonical: simvx.core.water.WaterSurface3D.material
:type: simvx.core.water.WaterMaterial

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.material
```

````

````{py:property} reflection
:canonical: simvx.core.water.WaterSurface3D.reflection

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.reflection
```

````

````{py:method} get_gizmo_lines() -> list[tuple[simvx.core.math.types.Vec3, simvx.core.math.types.Vec3]]
:canonical: simvx.core.water.WaterSurface3D.get_gizmo_lines

```{autodoc2-docstring} simvx.core.water.WaterSurface3D.get_gizmo_lines
```

````

````{py:attribute} position
:canonical: simvx.core.water.WaterSurface3D.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.water.WaterSurface3D.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.water.WaterSurface3D.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.water.WaterSurface3D.render_layer
:value: >
   'Property(...)'

````

````{py:property} rotation_degrees
:canonical: simvx.core.water.WaterSurface3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} world_position
:canonical: simvx.core.water.WaterSurface3D.world_position
:type: simvx.core.math.types.Vec3

````

````{py:property} world_rotation
:canonical: simvx.core.water.WaterSurface3D.world_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} world_scale
:canonical: simvx.core.water.WaterSurface3D.world_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.water.WaterSurface3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.water.WaterSurface3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.water.WaterSurface3D.up
:type: simvx.core.math.types.Vec3

````

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

````

````{py:method} translate_global(offset: tuple[float, float, float] | numpy.ndarray)
:canonical: simvx.core.water.WaterSurface3D.translate_global

````

````{py:method} rotate(axis: tuple[float, float, float] | numpy.ndarray, angle: float)
:canonical: simvx.core.water.WaterSurface3D.rotate

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.water.WaterSurface3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.water.WaterSurface3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.water.WaterSurface3D.rotate_z

````

````{py:method} look_at(target: tuple[float, float, float] | numpy.ndarray, up=None)
:canonical: simvx.core.water.WaterSurface3D.look_at

````

````{py:method} face_along(forward: tuple[float, float, float] | numpy.ndarray, up: tuple[float, float, float] | numpy.ndarray | None = None) -> None
:canonical: simvx.core.water.WaterSurface3D.face_along

````

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

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.water.WaterSurface3D.is_on_render_layer

````

````{py:method} wrap_bounds(bounds: tuple[float, float, float] | numpy.ndarray, margin: float = 1.0)
:canonical: simvx.core.water.WaterSurface3D.wrap_bounds

````

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

````

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

````

````{py:attribute} dynamic
:canonical: simvx.core.water.WaterSurface3D.dynamic
:type: bool
:value: >
   False

````

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

````

````{py:property} name
:canonical: simvx.core.water.WaterSurface3D.name
:type: str

````

````{py:property} update_mode
:canonical: simvx.core.water.WaterSurface3D.update_mode
:type: simvx.core.descriptors.UpdateMode

````

````{py:property} visible
:canonical: simvx.core.water.WaterSurface3D.visible
:type: bool

````

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

````

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

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.water.WaterSurface3D.remove_child

````

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

````

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

````

````{py:method} get_node_or_none(path: str) -> simvx.core.node.Node | None
:canonical: simvx.core.water.WaterSurface3D.get_node_or_none

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.water.WaterSurface3D.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.water.WaterSurface3D.find_all

````

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

````

````{py:property} path
:canonical: simvx.core.water.WaterSurface3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.water.WaterSurface3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.water.WaterSurface3D.remove_from_group

````

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

````

````{py:method} on_ready() -> None
:canonical: simvx.core.water.WaterSurface3D.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.water.WaterSurface3D.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.water.WaterSurface3D.on_exit_tree

````

````{py:method} on_update(dt: float) -> None
:canonical: simvx.core.water.WaterSurface3D.on_update

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.water.WaterSurface3D.on_fixed_update

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.water.WaterSurface3D.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.water.WaterSurface3D.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.water.WaterSurface3D.on_unhandled_input

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.water.WaterSurface3D.stop_coroutine

````

````{py:method} queue_redraw() -> None
:canonical: simvx.core.water.WaterSurface3D.queue_redraw

````

````{py:property} render_dirty
:canonical: simvx.core.water.WaterSurface3D.render_dirty
:type: bool

````

````{py:method} clear_children()
:canonical: simvx.core.water.WaterSurface3D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.water.WaterSurface3D.destroy

````

````{py:method} call_deferred(method: collections.abc.Callable[..., typing.Any], *args: typing.Any) -> None
:canonical: simvx.core.water.WaterSurface3D.call_deferred

````

````{py:property} app
:canonical: simvx.core.water.WaterSurface3D.app

````

````{py:property} tree
:canonical: simvx.core.water.WaterSurface3D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.water.WaterSurface3D.physics

````

````{py:property} physics_2d
:canonical: simvx.core.water.WaterSurface3D.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.water.WaterSurface3D.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.water.WaterSurface3D.__repr__

````

`````