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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

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

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

````

````{py:data} __all__
:canonical: simvx.core.particles.__all__
:value: >
   ['ParticleEmitter', 'PARTICLE_DTYPE']

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

````

````{py:data} PARTICLE_DTYPE
:canonical: simvx.core.particles.PARTICLE_DTYPE
:value: >
   'dtype(...)'

```{autodoc2-docstring} simvx.core.particles.PARTICLE_DTYPE
```

````

`````{py:class} ParticleEmitter(seed: int | None = None, **kwargs)
:canonical: simvx.core.particles.ParticleEmitter

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

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.__init__
```

````{py:attribute} amount
:canonical: simvx.core.particles.ParticleEmitter.amount
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.amount
```

````

````{py:attribute} lifetime
:canonical: simvx.core.particles.ParticleEmitter.lifetime
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.lifetime
```

````

````{py:attribute} emission_rate
:canonical: simvx.core.particles.ParticleEmitter.emission_rate
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emission_rate
```

````

````{py:attribute} one_shot
:canonical: simvx.core.particles.ParticleEmitter.one_shot
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.one_shot
```

````

````{py:attribute} emitting
:canonical: simvx.core.particles.ParticleEmitter.emitting
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emitting
```

````

````{py:attribute} emission_shape
:canonical: simvx.core.particles.ParticleEmitter.emission_shape
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emission_shape
```

````

````{py:attribute} emission_radius
:canonical: simvx.core.particles.ParticleEmitter.emission_radius
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emission_radius
```

````

````{py:attribute} emission_box
:canonical: simvx.core.particles.ParticleEmitter.emission_box
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emission_box
```

````

````{py:attribute} initial_velocity
:canonical: simvx.core.particles.ParticleEmitter.initial_velocity
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.initial_velocity
```

````

````{py:attribute} velocity_spread
:canonical: simvx.core.particles.ParticleEmitter.velocity_spread
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.velocity_spread
```

````

````{py:attribute} gravity
:canonical: simvx.core.particles.ParticleEmitter.gravity
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.gravity
```

````

````{py:attribute} damping
:canonical: simvx.core.particles.ParticleEmitter.damping
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.damping
```

````

````{py:attribute} start_scale
:canonical: simvx.core.particles.ParticleEmitter.start_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.start_scale
```

````

````{py:attribute} end_scale
:canonical: simvx.core.particles.ParticleEmitter.end_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.end_scale
```

````

````{py:attribute} start_color
:canonical: simvx.core.particles.ParticleEmitter.start_color
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.start_color
```

````

````{py:attribute} end_color
:canonical: simvx.core.particles.ParticleEmitter.end_color
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.end_color
```

````

````{py:attribute} gpu_simulation
:canonical: simvx.core.particles.ParticleEmitter.gpu_simulation
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.gpu_simulation
```

````

````{py:attribute} collision_enabled
:canonical: simvx.core.particles.ParticleEmitter.collision_enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.collision_enabled
```

````

````{py:attribute} collision_bounce
:canonical: simvx.core.particles.ParticleEmitter.collision_bounce
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.collision_bounce
```

````

````{py:attribute} collision_friction
:canonical: simvx.core.particles.ParticleEmitter.collision_friction
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.collision_friction
```

````

````{py:attribute} collision_mode
:canonical: simvx.core.particles.ParticleEmitter.collision_mode
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.collision_mode
```

````

````{py:attribute} collision_plane_y
:canonical: simvx.core.particles.ParticleEmitter.collision_plane_y
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.collision_plane_y
```

````

````{py:attribute} trail_enabled
:canonical: simvx.core.particles.ParticleEmitter.trail_enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.trail_enabled
```

````

````{py:attribute} trail_length
:canonical: simvx.core.particles.ParticleEmitter.trail_length
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.trail_length
```

````

````{py:attribute} trail_width
:canonical: simvx.core.particles.ParticleEmitter.trail_width
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.trail_width
```

````

````{py:attribute} particle_born
:canonical: simvx.core.particles.ParticleEmitter.particle_born
:value: >
   'Signal(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.particle_born
```

````

````{py:attribute} particle_died
:canonical: simvx.core.particles.ParticleEmitter.particle_died
:value: >
   'Signal(...)'

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.particle_died
```

````

````{py:property} seed
:canonical: simvx.core.particles.ParticleEmitter.seed
:type: int | None

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.seed
```

````

````{py:property} emitter_config
:canonical: simvx.core.particles.ParticleEmitter.emitter_config
:type: dict

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.emitter_config
```

````

````{py:method} ready()
:canonical: simvx.core.particles.ParticleEmitter.ready

````

````{py:method} restart()
:canonical: simvx.core.particles.ParticleEmitter.restart

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.restart
```

````

````{py:method} physics_process(dt: float)
:canonical: simvx.core.particles.ParticleEmitter.physics_process

````

````{py:property} alive_count
:canonical: simvx.core.particles.ParticleEmitter.alive_count
:type: int

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.alive_count
```

````

````{py:property} particle_data
:canonical: simvx.core.particles.ParticleEmitter.particle_data
:type: numpy.ndarray | None

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.particle_data
```

````

````{py:property} trail_data
:canonical: simvx.core.particles.ParticleEmitter.trail_data

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.trail_data
```

````

````{py:property} trail_vertices
:canonical: simvx.core.particles.ParticleEmitter.trail_vertices
:type: numpy.ndarray | None

```{autodoc2-docstring} simvx.core.particles.ParticleEmitter.trail_vertices
```

````

````{py:property} position
:canonical: simvx.core.particles.ParticleEmitter.position

````

````{py:property} rotation
:canonical: simvx.core.particles.ParticleEmitter.rotation
:type: simvx.core.math.types.Quat

````

````{py:property} scale
:canonical: simvx.core.particles.ParticleEmitter.scale

````

````{py:property} rotation_degrees
:canonical: simvx.core.particles.ParticleEmitter.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} global_position
:canonical: simvx.core.particles.ParticleEmitter.global_position
:type: simvx.core.math.types.Vec3

````

````{py:property} global_rotation
:canonical: simvx.core.particles.ParticleEmitter.global_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} global_scale
:canonical: simvx.core.particles.ParticleEmitter.global_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.particles.ParticleEmitter.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.particles.ParticleEmitter.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.particles.ParticleEmitter.up
:type: simvx.core.math.types.Vec3

````

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

````

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

````

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

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.particles.ParticleEmitter.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.particles.ParticleEmitter.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.particles.ParticleEmitter.rotate_z

````

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

````

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

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.particles.ParticleEmitter.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.particles.ParticleEmitter.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.particles.ParticleEmitter.remove_child

````

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

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.particles.ParticleEmitter.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.particles.ParticleEmitter.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.particles.ParticleEmitter.remove_from_group

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.particles.ParticleEmitter.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.particles.ParticleEmitter.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.particles.ParticleEmitter.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.particles.ParticleEmitter.tree
:type: simvx.core.scene_tree.SceneTree

````

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

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.particles.ParticleEmitter.__getitem__

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.particles.ParticleEmitter.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.particles.ParticleEmitter.__repr__

````

`````