NavigationMesh
Classes
| Name | Type | Summary |
|---|---|---|
| NavMeshModel | NavMeshModel | - |
| NsdkNavMesh | NsdkNavMesh | This class manages the data structures associated with a navigation mesh ("NsdkNavMesh"). It dynamically builds a 2d grid on the meshes detected in the environment for running navigation algorithms on. You are able to retrieve a number of properties of the "NsdkNavMesh" from it. There are also a number of methods to help you place and move NsdkNavMeshAgents on the board. |
| NsdkNavMeshAgent | MonoBehaviour | NsdkNavMeshAgent is an example agent implementation that navigates a NsdkNavMesh based on logic programmed here. You place this MonoBehaviour on a GameObject to have that GameObject navigate autonomously through your real environment. You can create new versions of this to change how your creatures navigate the NsdkNavMesh. For example you may want to use physics/forces or add splines rather than straight lines. This is a basic example that uses linear interpolation and coroutines. |
| NsdkNavMeshAgentPathRenderer | MonoBehaviour | NsdkNavMeshAgentPathRenderer is a debug renderer to show you the path a NsdkNavMeshAgent is moving along while navigating the environment. You add it to the NsdkNavMeshAgentGameObject in your scene and it will draw that agent's current path. |
| NsdkNavMeshManager | MonoBehaviour | LightshipNavMeshManager is a MonoBehaviour that will create a NsdkNavMesh configured according to your settings and manage how it gets updated. You can add this component to a GameObject in your scene to use the NsdkNavMesh features. You can pass this to any GameObject s that may need the NsdkNavMesh e.g. your agents that handle moving across the board. |
| NsdkNavMeshRenderer | MonoBehaviour | NsdkNavMeshRenderer is a helper MonoBehaviour which will draw the NsdkNavMesh tiles If you want to draw the NsdkNavMesh in a custom way you can create a similar renderer e.g. stylize the board as water/snow/sand etc. |
| Path | Path | - |
| SpatialTree | SpatialTree | - |
| Surface | Surface | - |
| Utils | Utils | - |
Structs
| Name | Type | Summary |
|---|---|---|
| AgentConfiguration | ValueType | - |
| Bounds | ValueType, IEquatable<Bounds> | - |
| GridNode | ValueType, IEquatable<GridNode> | Encloses data for grid elements used during scanning for walkable areas. |
| ModelSettings | ValueType | The ModelSettings struct provides a configuration for how NsdkNavMesh scans the real environment and creates a navigable space. An instance of ModelSettings is created by the NsdkNavMeshManager using the parameters specified by the user in the Inspector, and that instance is subsequently used to create a NsdkNavMesh that is configured this way. |
| Waypoint | ValueType | - |
Enums
| Name | Type | Summary |
|---|---|---|
| AgentNavigationState | AgentNavigationState | - |
| MovementType | MovementType | - |
| PathFindingBehaviour | PathFindingBehaviour | - |
| Status | Status | - |