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

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

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

## Module Contents

### Classes

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

* - {py:obj}`FogVolumeShape <simvx.core.fog_volume.FogVolumeShape>`
  - ```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape
    :summary:
    ```
* - {py:obj}`FogMaterial <simvx.core.fog_volume.FogMaterial>`
  - ```{autodoc2-docstring} simvx.core.fog_volume.FogMaterial
    :summary:
    ```
* - {py:obj}`FogVolume3D <simvx.core.fog_volume.FogVolume3D>`
  - ```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

`````{py:class} FogVolumeShape()
:canonical: simvx.core.fog_volume.FogVolumeShape

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape.__init__
```

````{py:attribute} BOX
:canonical: simvx.core.fog_volume.FogVolumeShape.BOX
:value: >
   0

```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape.BOX
```

````

````{py:attribute} SPHERE
:canonical: simvx.core.fog_volume.FogVolumeShape.SPHERE
:value: >
   1

```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape.SPHERE
```

````

````{py:attribute} CYLINDER
:canonical: simvx.core.fog_volume.FogVolumeShape.CYLINDER
:value: >
   2

```{autodoc2-docstring} simvx.core.fog_volume.FogVolumeShape.CYLINDER
```

````

````{py:method} __abs__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__abs__

````

````{py:method} __add__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__add__

````

````{py:method} __and__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__and__

````

````{py:method} __bool__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__bool__

````

````{py:method} __ceil__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__ceil__

````

````{py:method} __delattr__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__dir__

````

````{py:method} __divmod__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__divmod__

````

````{py:method} __eq__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__eq__

````

````{py:method} __float__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__float__

````

````{py:method} __floor__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__floor__

````

````{py:method} __floordiv__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__floordiv__

````

````{py:method} __format__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__getattribute__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__hash__

````

````{py:method} __index__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__index__

````

````{py:method} __int__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__int__

````

````{py:method} __invert__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__invert__

````

````{py:method} __le__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__le__

````

````{py:method} __lshift__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__lshift__

````

````{py:method} __lt__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__ne__

````

````{py:method} __neg__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__neg__

````

````{py:method} __new__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__new__

````

````{py:method} __or__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__or__

````

````{py:method} __pos__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__pos__

````

````{py:method} __pow__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__pow__

````

````{py:method} __radd__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__radd__

````

````{py:method} __rand__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rand__

````

````{py:method} __rdivmod__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rdivmod__

````

````{py:method} __reduce__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__repr__

````

````{py:method} __rfloordiv__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rfloordiv__

````

````{py:method} __rlshift__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rlshift__

````

````{py:method} __rmod__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rmul__

````

````{py:method} __ror__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__ror__

````

````{py:method} __round__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__round__

````

````{py:method} __rpow__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rpow__

````

````{py:method} __rrshift__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rrshift__

````

````{py:method} __rshift__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rshift__

````

````{py:method} __rsub__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rsub__

````

````{py:method} __rtruediv__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rtruediv__

````

````{py:method} __rxor__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__rxor__

````

````{py:method} __setattr__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__str__

````

````{py:method} __sub__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__sub__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__subclasshook__

````

````{py:method} __truediv__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__truediv__

````

````{py:method} __trunc__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__trunc__

````

````{py:method} __xor__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__xor__

````

````{py:method} as_integer_ratio()
:canonical: simvx.core.fog_volume.FogVolumeShape.as_integer_ratio

````

````{py:method} bit_count()
:canonical: simvx.core.fog_volume.FogVolumeShape.bit_count

````

````{py:method} bit_length()
:canonical: simvx.core.fog_volume.FogVolumeShape.bit_length

````

````{py:method} conjugate()
:canonical: simvx.core.fog_volume.FogVolumeShape.conjugate

````

```{py:class} denominator
:canonical: simvx.core.fog_volume.FogVolumeShape.denominator

```

```{py:class} imag
:canonical: simvx.core.fog_volume.FogVolumeShape.imag

```

````{py:method} is_integer()
:canonical: simvx.core.fog_volume.FogVolumeShape.is_integer

````

```{py:class} numerator
:canonical: simvx.core.fog_volume.FogVolumeShape.numerator

```

```{py:class} real
:canonical: simvx.core.fog_volume.FogVolumeShape.real

```

````{py:method} to_bytes()
:canonical: simvx.core.fog_volume.FogVolumeShape.to_bytes

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.fog_volume.FogVolumeShape.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.fog_volume.FogVolumeShape.__copy__

````

````{py:method} name()
:canonical: simvx.core.fog_volume.FogVolumeShape.name

````

````{py:method} value()
:canonical: simvx.core.fog_volume.FogVolumeShape.value

````

`````

`````{py:class} FogMaterial(*, albedo: tuple[float, ...] = (1.0, 1.0, 1.0, 1.0), density: float = 1.0, emission: tuple[float, ...] = (0.0, 0.0, 0.0, 0.0), scattering: float = 0.0, absorption: float = 0.0)
:canonical: simvx.core.fog_volume.FogMaterial

```{autodoc2-docstring} simvx.core.fog_volume.FogMaterial
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.fog_volume.FogMaterial.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.fog_volume.FogMaterial.__slots__
:value: >
   ('albedo', 'density', 'emission', 'scattering', 'absorption')

```{autodoc2-docstring} simvx.core.fog_volume.FogMaterial.__slots__
```

````

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

````

`````

`````{py:class} FogVolume3D(**kwargs)
:canonical: simvx.core.fog_volume.FogVolume3D

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

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.__init__
```

````{py:attribute} shape
:canonical: simvx.core.fog_volume.FogVolume3D.shape
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.shape
```

````

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

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.size
```

````

````{py:attribute} density
:canonical: simvx.core.fog_volume.FogVolume3D.density
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.density
```

````

````{py:attribute} albedo
:canonical: simvx.core.fog_volume.FogVolume3D.albedo
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.albedo
```

````

````{py:attribute} falloff
:canonical: simvx.core.fog_volume.FogVolume3D.falloff
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.falloff
```

````

````{py:attribute} height_falloff
:canonical: simvx.core.fog_volume.FogVolume3D.height_falloff
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.height_falloff
```

````

````{py:attribute} priority
:canonical: simvx.core.fog_volume.FogVolume3D.priority
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.priority
```

````

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

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.gizmo_colour
```

````

````{py:property} material
:canonical: simvx.core.fog_volume.FogVolume3D.material
:type: simvx.core.fog_volume.FogMaterial | None

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.material
```

````

````{py:property} effective_density
:canonical: simvx.core.fog_volume.FogVolume3D.effective_density
:type: float

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.effective_density
```

````

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

```{autodoc2-docstring} simvx.core.fog_volume.FogVolume3D.get_gizmo_lines
```

````

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

````

````{py:property} position
:canonical: simvx.core.fog_volume.FogVolume3D.position

````

````{py:property} rotation
:canonical: simvx.core.fog_volume.FogVolume3D.rotation
:type: simvx.core.math.types.Quat

````

````{py:property} scale
:canonical: simvx.core.fog_volume.FogVolume3D.scale

````

````{py:property} rotation_degrees
:canonical: simvx.core.fog_volume.FogVolume3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} world_position
:canonical: simvx.core.fog_volume.FogVolume3D.world_position
:type: simvx.core.math.types.Vec3

````

````{py:property} world_rotation
:canonical: simvx.core.fog_volume.FogVolume3D.world_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} world_scale
:canonical: simvx.core.fog_volume.FogVolume3D.world_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.fog_volume.FogVolume3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.fog_volume.FogVolume3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.fog_volume.FogVolume3D.up
:type: simvx.core.math.types.Vec3

````

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

````

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

````

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

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.fog_volume.FogVolume3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.fog_volume.FogVolume3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.fog_volume.FogVolume3D.rotate_z

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.fog_volume.FogVolume3D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.fog_volume.FogVolume3D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.fog_volume.FogVolume3D.remove_child

````

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

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.fog_volume.FogVolume3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.fog_volume.FogVolume3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.fog_volume.FogVolume3D.remove_from_group

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.fog_volume.FogVolume3D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.fog_volume.FogVolume3D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.fog_volume.FogVolume3D.destroy

````

````{py:property} app
:canonical: simvx.core.fog_volume.FogVolume3D.app

````

````{py:property} tree
:canonical: simvx.core.fog_volume.FogVolume3D.tree
:type: simvx.core.scene_tree.SceneTree

````

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

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.fog_volume.FogVolume3D.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.fog_volume.FogVolume3D.__repr__

````

`````