Classes
struct	Area
	An area groups together pieces of data through the navmesh generation process. More...

class	AreaGenerator
	A class that filters geometry and applies an Area to it. More...

class	Cell
	A cell is a column of voxels represented in Spans. More...

struct	CompactCell
	Represents a cell in a CompactHeightfield. More...

class	CompactHeightfield
	A more memory-compact heightfield that stores open spans of voxels instead of closed ones. More...

struct	CompactSpan
	Represents a voxel span in a CompactHeightfield. More...

struct	CompactSpanReference
	A reference to a CompactSpan in a CompactHeightfield. More...

class	Contour
	A contour is formed from a region. More...

class	ContourSet
	A set of contours around the regions of a CompactHeightfield, used as the edges of a PolyMesh. More...

struct	ContourVertex
	A ContourVertex is a vertex that stores 3 integer coordinates and a region ID, and is used to build Contours. More...

class	DirectionExtensions
	A set of extension methods to make using the Direction enum a lot simpler.

class	EdgeFlagsHelper
	A static class with helper functions to modify instances of the EdgeFlags enum.

class	Heightfield
	A Heightfield represents a "voxel" grid represented as a 2-dimensional grid of Cells. More...

class	HeightPatch
	Stores height data in a grid. More...

class	MathHelper
	A class where all the small, miscellaneous math functions are stored.

class	NavMesh
	A TiledNavMesh generated from a collection of triangles and some settings More...

class	NavMeshBuilder
	The NavMeshBuilder class converst PolyMesh and PolyMeshDetail into a different data structure suited for pathfinding. This class will create tiled data. More...

class	NavMeshGenerationSettings
	Contains all the settings necessary to convert a mesh to a navmesh. More...

class	NavMeshQuery
	Do pathfinding calculations on the TiledNavMesh More...

class	Node
	Every polygon becomes a Node, which contains a position and cost. More...

class	NodePool
	Link all nodes together. Store indices in hash map. More...

struct	PolyBounds
	A bounding box for vertices in a PolyMesh. More...

class	PolyMesh
	The class of Poly mesh. More...

class	PolyMeshDetail
	The PolyMeshDetail class is a combination of a PolyMesh and a CompactHeightfield merged together More...

struct	PolyVertex
	A vertex inside a PolyMesh. More...

struct	RegionId
	A RegionId is an identifier with flags marking borders. More...

class	Region
	A Region contains a group of adjacent spans. More...

struct	Span
	A span is a range of integers which represents a range of voxels in a Cell. More...

struct	SpanReference
	References a Span within a Heightfield. More...

class	TiledNavMesh
	A TiledNavMesh is a continuous region, which is used for pathfinding. More...

class	Tuple
	Represents a functional tuple that can be used to store two values of different types inside one object. More...

Enumerations
enum class	ContourBuildFlags { None = 0 , TessellateWallEdges = 0x01 , TessellateAreaEdges = 0x02 }
	A set of flags that control the way contours are built. More...

enum class	Direction { West = 0 , North = 1 , East = 2 , South = 3 }
	A set of cardinal directions. More...

enum class	EdgeFlags : byte { None = 0x0 , West = 0x1 , North = 0x2 , East = 0x4 , South = 0x8 , All = West \| North \| East \| South }
	An enum similar to Direction, but with the ability to store multiple directions. More...

enum class	NodeFlags { Open = 0x01 , Closed = 0x02 }
	Determine which list the node is in. More...

enum class	RegionFlags { Border = 0x20000000 , VertexBorder = 0x40000000 , AreaBorder = unchecked((int)0x80000000) }
	Flags that can be applied to a region. More...

Enumeration Type Documentation

◆ ContourBuildFlags

enum SharpNav.ContourBuildFlags

strong

A set of flags that control the way contours are built.

Enumerator
None	Build normally.
TessellateWallEdges	Tessellate solid edges during contour simplification.
TessellateAreaEdges	Tessellate edges between areas during contour simplification.

Definition at line 12 of file ContourBuildFlags.cs.

◆ Direction

enum SharpNav.Direction

strong

A set of cardinal directions.

Enumerator
West	The west direction.
North	The north direction.
East	The east direction.
South	The south direction.

Definition at line 11 of file Direction.cs.

◆ EdgeFlags

enum SharpNav.EdgeFlags : byte

strong

An enum similar to Direction, but with the ability to store multiple directions.

Enumerator
None	No edges are selected.
West	The west edge is selected.
North	The north edge is selected.
East	The east edge is selected.
South	The south edge is selected.
All	All of the edges are selected.

Definition at line 12 of file EdgeFlags.cs.

◆ NodeFlags

enum SharpNav.NodeFlags

strong

Determine which list the node is in.

Enumerator
Open	Open list contains nodes to examine.
Closed	Closed list stores path.

Definition at line 12 of file NodeFlags.cs.

◆ RegionFlags

enum SharpNav.RegionFlags

strong

Flags that can be applied to a region.

Enumerator
Border	The border flag
VertexBorder	The vertex border flag
AreaBorder	The area border flag

Definition at line 13 of file Region.cs.

Classes

Enumerations

Enumeration Type Documentation

◆ ContourBuildFlags

◆ Direction

◆ EdgeFlags

◆ NodeFlags

◆ RegionFlags