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

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

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

## Module Contents

### Classes

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

* - {py:obj}`AStar2D <simvx.core.navigation.AStar2D>`
  - ```{autodoc2-docstring} simvx.core.navigation.AStar2D
    :summary:
    ```
* - {py:obj}`AStarGrid2D <simvx.core.navigation.AStarGrid2D>`
  - ```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D
    :summary:
    ```
* - {py:obj}`NavigationAgent2D <simvx.core.navigation.NavigationAgent2D>`
  - ```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.navigation.__all__
:value: >
   ['AStar2D', 'AStarGrid2D', 'NavigationAgent2D']

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

````

`````{py:class} AStar2D()
:canonical: simvx.core.navigation.AStar2D

```{autodoc2-docstring} simvx.core.navigation.AStar2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.navigation.AStar2D.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.navigation.AStar2D.__slots__
:value: >
   ('_points', '_connections', '_weights', '_disabled')

```{autodoc2-docstring} simvx.core.navigation.AStar2D.__slots__
```

````

````{py:method} add_point(id: int, position: tuple[float, float], weight: float = 1.0)
:canonical: simvx.core.navigation.AStar2D.add_point

```{autodoc2-docstring} simvx.core.navigation.AStar2D.add_point
```

````

````{py:method} remove_point(id: int)
:canonical: simvx.core.navigation.AStar2D.remove_point

```{autodoc2-docstring} simvx.core.navigation.AStar2D.remove_point
```

````

````{py:method} connect_points(id1: int, id2: int, bidirectional: bool = True)
:canonical: simvx.core.navigation.AStar2D.connect_points

```{autodoc2-docstring} simvx.core.navigation.AStar2D.connect_points
```

````

````{py:method} disconnect_points(id1: int, id2: int, bidirectional: bool = True)
:canonical: simvx.core.navigation.AStar2D.disconnect_points

```{autodoc2-docstring} simvx.core.navigation.AStar2D.disconnect_points
```

````

````{py:method} set_point_disabled(id: int, disabled: bool = True)
:canonical: simvx.core.navigation.AStar2D.set_point_disabled

```{autodoc2-docstring} simvx.core.navigation.AStar2D.set_point_disabled
```

````

````{py:method} is_point_disabled(id: int) -> bool
:canonical: simvx.core.navigation.AStar2D.is_point_disabled

```{autodoc2-docstring} simvx.core.navigation.AStar2D.is_point_disabled
```

````

````{py:method} has_point(id: int) -> bool
:canonical: simvx.core.navigation.AStar2D.has_point

```{autodoc2-docstring} simvx.core.navigation.AStar2D.has_point
```

````

````{py:method} get_point_position(id: int) -> tuple[float, float]
:canonical: simvx.core.navigation.AStar2D.get_point_position

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_point_position
```

````

````{py:method} get_point_connections(id: int) -> set[int]
:canonical: simvx.core.navigation.AStar2D.get_point_connections

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_point_connections
```

````

````{py:method} get_point_count() -> int
:canonical: simvx.core.navigation.AStar2D.get_point_count

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_point_count
```

````

````{py:method} get_closest_point(position: tuple[float, float]) -> int
:canonical: simvx.core.navigation.AStar2D.get_closest_point

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_closest_point
```

````

````{py:method} get_id_path(from_id: int, to_id: int) -> list[int]
:canonical: simvx.core.navigation.AStar2D.get_id_path

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_id_path
```

````

````{py:method} get_point_path(from_id: int, to_id: int) -> list[tuple[float, float]]
:canonical: simvx.core.navigation.AStar2D.get_point_path

```{autodoc2-docstring} simvx.core.navigation.AStar2D.get_point_path
```

````

`````

`````{py:class} AStarGrid2D(width: int, height: int, cell_size: float = 1.0, diagonal: bool = True, offset: tuple[float, float] = (0.0, 0.0))
:canonical: simvx.core.navigation.AStarGrid2D

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.navigation.AStarGrid2D.__slots__
:value: >
   ('_width', '_height', '_cell_size', '_diagonal', '_offset', '_solid', '_weights')

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.__slots__
```

````

````{py:property} width
:canonical: simvx.core.navigation.AStarGrid2D.width
:type: int

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.width
```

````

````{py:property} height
:canonical: simvx.core.navigation.AStarGrid2D.height
:type: int

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.height
```

````

````{py:property} cell_size
:canonical: simvx.core.navigation.AStarGrid2D.cell_size
:type: float

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.cell_size
```

````

````{py:method} set_solid(x: int, y: int, solid: bool = True)
:canonical: simvx.core.navigation.AStarGrid2D.set_solid

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.set_solid
```

````

````{py:method} is_solid(x: int, y: int) -> bool
:canonical: simvx.core.navigation.AStarGrid2D.is_solid

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.is_solid
```

````

````{py:method} set_weight(x: int, y: int, weight: float)
:canonical: simvx.core.navigation.AStarGrid2D.set_weight

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.set_weight
```

````

````{py:method} find_path(from_cell: tuple[int, int], to_cell: tuple[int, int]) -> list[tuple[int, int]]
:canonical: simvx.core.navigation.AStarGrid2D.find_path

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.find_path
```

````

````{py:method} find_path_world(from_pos: tuple[float, float], to_pos: tuple[float, float]) -> list[tuple[float, float]]
:canonical: simvx.core.navigation.AStarGrid2D.find_path_world

```{autodoc2-docstring} simvx.core.navigation.AStarGrid2D.find_path_world
```

````

`````

`````{py:class} NavigationAgent2D(max_speed: float = 100.0, path_desired_distance: float = 4.0, **kwargs)
:canonical: simvx.core.navigation.NavigationAgent2D

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

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.__init__
```

````{py:attribute} max_speed
:canonical: simvx.core.navigation.NavigationAgent2D.max_speed
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.max_speed
```

````

````{py:attribute} path_desired_distance
:canonical: simvx.core.navigation.NavigationAgent2D.path_desired_distance
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.path_desired_distance
```

````

````{py:property} target_position
:canonical: simvx.core.navigation.NavigationAgent2D.target_position
:type: simvx.core.math.types.Vec2

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.target_position
```

````

````{py:property} velocity
:canonical: simvx.core.navigation.NavigationAgent2D.velocity
:type: simvx.core.math.types.Vec2

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.velocity
```

````

````{py:property} is_navigation_finished
:canonical: simvx.core.navigation.NavigationAgent2D.is_navigation_finished
:type: bool

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.is_navigation_finished
```

````

````{py:method} set_navigation(nav: simvx.core.navigation.AStar2D | simvx.core.navigation.AStarGrid2D)
:canonical: simvx.core.navigation.NavigationAgent2D.set_navigation

```{autodoc2-docstring} simvx.core.navigation.NavigationAgent2D.set_navigation
```

````

````{py:method} physics_process(dt: float)
:canonical: simvx.core.navigation.NavigationAgent2D.physics_process

````

````{py:attribute} z_index
:canonical: simvx.core.navigation.NavigationAgent2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.navigation.NavigationAgent2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.navigation.NavigationAgent2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.navigation.NavigationAgent2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.navigation.NavigationAgent2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.navigation.NavigationAgent2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.navigation.NavigationAgent2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.navigation.NavigationAgent2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.navigation.NavigationAgent2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.navigation.NavigationAgent2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.navigation.NavigationAgent2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.navigation.NavigationAgent2D.right
:type: simvx.core.math.types.Vec2

````

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

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.navigation.NavigationAgent2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.navigation.NavigationAgent2D.rotate_deg

````

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

````

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

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.navigation.NavigationAgent2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.navigation.NavigationAgent2D.wrap_screen

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.navigation.NavigationAgent2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.navigation.NavigationAgent2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.navigation.NavigationAgent2D.remove_child

````

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

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.navigation.NavigationAgent2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.navigation.NavigationAgent2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.navigation.NavigationAgent2D.remove_from_group

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.navigation.NavigationAgent2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.navigation.NavigationAgent2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.navigation.NavigationAgent2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.navigation.NavigationAgent2D.tree
:type: simvx.core.scene_tree.SceneTree

````

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

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.navigation.NavigationAgent2D.__getitem__

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.navigation.NavigationAgent2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.navigation.NavigationAgent2D.__repr__

````

`````