# {py:mod}`simvx.core.navigation3d.server`

```{py:module} simvx.core.navigation3d.server
```

```{autodoc2-docstring} simvx.core.navigation3d.server
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`NavigationServer3D <simvx.core.navigation3d.server.NavigationServer3D>`
  - ```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D
    :summary:
    ```
````

### Data

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

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

### API

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

```{autodoc2-docstring} simvx.core.navigation3d.server.log
```

````

`````{py:class} NavigationServer3D()
:canonical: simvx.core.navigation3d.server.NavigationServer3D

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.__init__
```

````{py:method} get_singleton() -> simvx.core.navigation3d.server.NavigationServer3D
:canonical: simvx.core.navigation3d.server.NavigationServer3D.get_singleton
:classmethod:

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.get_singleton
```

````

````{py:method} reset() -> None
:canonical: simvx.core.navigation3d.server.NavigationServer3D.reset
:classmethod:

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.reset
```

````

````{py:method} register_region(region: simvx.core.navigation3d.nodes.NavigationRegion3D) -> None
:canonical: simvx.core.navigation3d.server.NavigationServer3D.register_region

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.register_region
```

````

````{py:method} unregister_region(region: simvx.core.navigation3d.nodes.NavigationRegion3D) -> None
:canonical: simvx.core.navigation3d.server.NavigationServer3D.unregister_region

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.unregister_region
```

````

````{py:method} register_obstacle(obstacle: simvx.core.navigation3d.nodes.NavigationObstacle3D) -> None
:canonical: simvx.core.navigation3d.server.NavigationServer3D.register_obstacle

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.register_obstacle
```

````

````{py:method} unregister_obstacle(obstacle: simvx.core.navigation3d.nodes.NavigationObstacle3D) -> None
:canonical: simvx.core.navigation3d.server.NavigationServer3D.unregister_obstacle

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.unregister_obstacle
```

````

````{py:method} find_path(start: simvx.core.math.types.Vec3, end: simvx.core.math.types.Vec3) -> list[simvx.core.math.types.Vec3]
:canonical: simvx.core.navigation3d.server.NavigationServer3D.find_path

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.find_path
```

````

````{py:method} get_closest_point(point: simvx.core.math.types.Vec3) -> simvx.core.math.types.Vec3
:canonical: simvx.core.navigation3d.server.NavigationServer3D.get_closest_point

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.get_closest_point
```

````

````{py:property} obstacles
:canonical: simvx.core.navigation3d.server.NavigationServer3D.obstacles
:type: list[simvx.core.navigation3d.nodes.NavigationObstacle3D]

```{autodoc2-docstring} simvx.core.navigation3d.server.NavigationServer3D.obstacles
```

````

`````