---
orphan: true
---

# {py:mod}`simvx.core.physics._raycasting`

```{py:module} simvx.core.physics._raycasting
```

```{autodoc2-docstring} simvx.core.physics._raycasting
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`RayCast3D <simvx.core.physics._raycasting.RayCast3D>`
  - ```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D
    :summary:
    ```
* - {py:obj}`RayCast2D <simvx.core.physics._raycasting.RayCast2D>`
  - ```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.physics._raycasting.__all__
:value: >
   ['RayCast2D', 'RayCast3D']

```{autodoc2-docstring} simvx.core.physics._raycasting.__all__
```

````

`````{py:class} RayCast3D(target_position=None, collision_mask: int = 4294967295, enabled: bool = True, **kwargs)
:canonical: simvx.core.physics._raycasting.RayCast3D

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

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.__init__
```

````{py:attribute} target_position
:canonical: simvx.core.physics._raycasting.RayCast3D.target_position
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.target_position
```

````

````{py:attribute} collision_mask
:canonical: simvx.core.physics._raycasting.RayCast3D.collision_mask
:value: >
   'Bitmask(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.collision_mask
```

````

````{py:attribute} enabled
:canonical: simvx.core.physics._raycasting.RayCast3D.enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.enabled
```

````

````{py:attribute} gizmo_colour
:canonical: simvx.core.physics._raycasting.RayCast3D.gizmo_colour
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.gizmo_colour
```

````

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

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.get_gizmo_lines
```

````

````{py:method} on_physics_process(dt: float) -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_physics_process

````

````{py:method} is_colliding() -> bool
:canonical: simvx.core.physics._raycasting.RayCast3D.is_colliding

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.is_colliding
```

````

````{py:property} collider
:canonical: simvx.core.physics._raycasting.RayCast3D.collider
:type: simvx.core.nodes_3d.node3d.Node3D | None

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.collider
```

````

````{py:property} collision_point
:canonical: simvx.core.physics._raycasting.RayCast3D.collision_point
:type: simvx.core.math.types.Vec3

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.collision_point
```

````

````{py:property} collision_normal
:canonical: simvx.core.physics._raycasting.RayCast3D.collision_normal
:type: simvx.core.math.types.Vec3

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.collision_normal
```

````

````{py:property} all_hits
:canonical: simvx.core.physics._raycasting.RayCast3D.all_hits
:type: list[simvx.core.collision.RayHit]

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast3D.all_hits
```

````

````{py:attribute} position
:canonical: simvx.core.physics._raycasting.RayCast3D.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.physics._raycasting.RayCast3D.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.physics._raycasting.RayCast3D.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.physics._raycasting.RayCast3D.render_layer
:value: >
   'Property(...)'

````

````{py:property} rotation_degrees
:canonical: simvx.core.physics._raycasting.RayCast3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} world_position
:canonical: simvx.core.physics._raycasting.RayCast3D.world_position
:type: simvx.core.math.types.Vec3

````

````{py:property} world_rotation
:canonical: simvx.core.physics._raycasting.RayCast3D.world_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} world_scale
:canonical: simvx.core.physics._raycasting.RayCast3D.world_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.physics._raycasting.RayCast3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.physics._raycasting.RayCast3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.physics._raycasting.RayCast3D.up
:type: simvx.core.math.types.Vec3

````

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

````

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

````

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

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.physics._raycasting.RayCast3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.physics._raycasting.RayCast3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.physics._raycasting.RayCast3D.rotate_z

````

````{py:method} look_at(target: tuple[float, float, float] | numpy.ndarray, up=None)
:canonical: simvx.core.physics._raycasting.RayCast3D.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.physics._raycasting.RayCast3D.face_along

````

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

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.physics._raycasting.RayCast3D.is_on_render_layer

````

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

````

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

````

````{py:attribute} script_error_raised
:canonical: simvx.core.physics._raycasting.RayCast3D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.physics._raycasting.RayCast3D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.physics._raycasting.RayCast3D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.physics._raycasting.RayCast3D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.core.physics._raycasting.RayCast3D.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.physics._raycasting.RayCast3D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.physics._raycasting.RayCast3D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.physics._raycasting.RayCast3D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.physics._raycasting.RayCast3D.get_node

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.physics._raycasting.RayCast3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.physics._raycasting.RayCast3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.physics._raycasting.RayCast3D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.physics._raycasting.RayCast3D.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_exit_tree

````

````{py:method} on_process(dt: float) -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_process

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.physics._raycasting.RayCast3D.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.physics._raycasting.RayCast3D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.physics._raycasting.RayCast3D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.physics._raycasting.RayCast3D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.physics._raycasting.RayCast3D.destroy

````

````{py:property} app
:canonical: simvx.core.physics._raycasting.RayCast3D.app

````

````{py:property} tree
:canonical: simvx.core.physics._raycasting.RayCast3D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.physics._raycasting.RayCast3D.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.physics._raycasting.RayCast3D.__repr__

````

`````

`````{py:class} RayCast2D(target_position=None, collision_mask: int = 4294967295, enabled: bool = True, **kwargs)
:canonical: simvx.core.physics._raycasting.RayCast2D

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

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.__init__
```

````{py:attribute} target_position
:canonical: simvx.core.physics._raycasting.RayCast2D.target_position
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.target_position
```

````

````{py:attribute} collision_mask
:canonical: simvx.core.physics._raycasting.RayCast2D.collision_mask
:value: >
   'Bitmask(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.collision_mask
```

````

````{py:attribute} enabled
:canonical: simvx.core.physics._raycasting.RayCast2D.enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.enabled
```

````

````{py:attribute} gizmo_colour
:canonical: simvx.core.physics._raycasting.RayCast2D.gizmo_colour
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.gizmo_colour
```

````

````{py:method} get_gizmo_lines() -> list[tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2]]
:canonical: simvx.core.physics._raycasting.RayCast2D.get_gizmo_lines

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.get_gizmo_lines
```

````

````{py:method} on_physics_process(dt: float) -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_physics_process

````

````{py:method} is_colliding() -> bool
:canonical: simvx.core.physics._raycasting.RayCast2D.is_colliding

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.is_colliding
```

````

````{py:property} collider
:canonical: simvx.core.physics._raycasting.RayCast2D.collider
:type: simvx.core.nodes_2d.node2d.Node2D | None

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.collider
```

````

````{py:property} collision_point
:canonical: simvx.core.physics._raycasting.RayCast2D.collision_point
:type: simvx.core.math.types.Vec2

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.collision_point
```

````

````{py:property} collision_normal
:canonical: simvx.core.physics._raycasting.RayCast2D.collision_normal
:type: simvx.core.math.types.Vec2

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.collision_normal
```

````

````{py:property} all_hits
:canonical: simvx.core.physics._raycasting.RayCast2D.all_hits
:type: list[simvx.core.collision.RayHit]

```{autodoc2-docstring} simvx.core.physics._raycasting.RayCast2D.all_hits
```

````

````{py:attribute} position
:canonical: simvx.core.physics._raycasting.RayCast2D.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.physics._raycasting.RayCast2D.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.physics._raycasting.RayCast2D.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.physics._raycasting.RayCast2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.physics._raycasting.RayCast2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.physics._raycasting.RayCast2D.render_layer
:value: >
   'Property(...)'

````

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

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.physics._raycasting.RayCast2D.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.physics._raycasting.RayCast2D.absolute_z_index
:type: int

````

````{py:property} rotation_degrees
:canonical: simvx.core.physics._raycasting.RayCast2D.rotation_degrees
:type: float

````

````{py:property} world_position
:canonical: simvx.core.physics._raycasting.RayCast2D.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.physics._raycasting.RayCast2D.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.physics._raycasting.RayCast2D.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_transform
:canonical: simvx.core.physics._raycasting.RayCast2D.world_transform
:type: tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2, float]

````

````{py:property} forward
:canonical: simvx.core.physics._raycasting.RayCast2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.physics._raycasting.RayCast2D.right
:type: simvx.core.math.types.Vec2

````

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

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.physics._raycasting.RayCast2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.physics._raycasting.RayCast2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.physics._raycasting.RayCast2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.physics._raycasting.RayCast2D.transform_points

````

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

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.physics._raycasting.RayCast2D.wrap_screen

````

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

````

````{py:attribute} script_error_raised
:canonical: simvx.core.physics._raycasting.RayCast2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.physics._raycasting.RayCast2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.physics._raycasting.RayCast2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.physics._raycasting.RayCast2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.core.physics._raycasting.RayCast2D.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.physics._raycasting.RayCast2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.physics._raycasting.RayCast2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.physics._raycasting.RayCast2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.physics._raycasting.RayCast2D.get_node

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.physics._raycasting.RayCast2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.physics._raycasting.RayCast2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.physics._raycasting.RayCast2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.physics._raycasting.RayCast2D.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_exit_tree

````

````{py:method} on_process(dt: float) -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_process

````

````{py:method} on_draw(renderer) -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_draw

````

````{py:method} on_picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_picked

````

````{py:method} on_unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.physics._raycasting.RayCast2D.on_unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.physics._raycasting.RayCast2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.physics._raycasting.RayCast2D.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.physics._raycasting.RayCast2D.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.physics._raycasting.RayCast2D.destroy

````

````{py:property} app
:canonical: simvx.core.physics._raycasting.RayCast2D.app

````

````{py:property} tree
:canonical: simvx.core.physics._raycasting.RayCast2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.physics._raycasting.RayCast2D.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.physics._raycasting.RayCast2D.__repr__

````

`````