Dungeon Architect: SharpNav.NavMeshGenerationSettings Class Reference

Dungeon Architect 17.0.0

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

Public Member Functions
	NavMeshGenerationSettings ()
	Prevents a default instance of the NavMeshGenerationSettings class from being created. Use Default instead. More...

Properties
static NavMeshGenerationSettings	Default `[get]`
	Gets the "default" generation settings for a model where 1 unit represents 1 meter. More...

float	CellSize `[get, set]`
	Gets or sets the size of a cell in the X and Z axes in world units. More...

float	CellHeight `[get, set]`
	Gets or sets the height of a cell in world units. More...

float	MaxClimb `[get, set]`
	Gets or sets the maximum climb height. More...

float	AgentHeight `[get, set]`
	Gets or sets the height of the agents traversing the NavMesh. More...

float	AgentRadius `[get, set]`
	Gets or sets the radius of the agents traversing the NavMesh. More...

int	MinRegionSize `[get, set]`
	Gets or sets the minimum number of spans that can form a region. Any less than this, and they will be merged with another region. More...

int	MergedRegionSize `[get, set]`
	Gets or sets the size of the merged regions More...

int	MaxEdgeLength `[get, set]`
	Gets or sets the maximum edge length allowed More...

float	MaxEdgeError `[get, set]`
	Gets or sets the maximum error allowed More...

ContourBuildFlags	ContourFlags `[get, set]`
	Gets or sets the flags that determine how the ContourSet is generated. More...

int	VertsPerPoly `[get, set]`
	Gets or sets the number of vertices a polygon can have. More...

int	SampleDistance `[get, set]`
	Gets or sets the sampling distance for the PolyMeshDetail More...

int	MaxSampleError `[get, set]`
	Gets or sets the maximium error allowed in sampling for the PolyMeshDetail More...

bool	BuildBoundingVolumeTree `[get, set]`
	Gets or sets a value indicating whether a bounding volume tree is generated for the mesh. More...

int	VoxelAgentHeight `[get]`
	Gets the height of the agents traversing the NavMesh in voxel (cell) units. More...

int	VoxelMaxClimb `[get]`
	Gets the maximum clim height in voxel (cell) units. More...

int	VoxelAgentRadius `[get]`
	Gets the radius of the agents traversing the NavMesh in voxel (cell) units. More...

Detailed Description

Contains all the settings necessary to convert a mesh to a navmesh.

Definition at line 9 of file NavMeshGenerationSettings.cs.

Constructor & Destructor Documentation

◆ NavMeshGenerationSettings()

SharpNav.NavMeshGenerationSettings.NavMeshGenerationSettings ( )

Prevents a default instance of the NavMeshGenerationSettings class from being created. Use Default instead.

Definition at line 15 of file NavMeshGenerationSettings.cs.

Property Documentation

◆ AgentHeight

float SharpNav.NavMeshGenerationSettings.AgentHeight

getset

Gets or sets the height of the agents traversing the NavMesh.

Definition at line 67 of file NavMeshGenerationSettings.cs.

◆ AgentRadius

float SharpNav.NavMeshGenerationSettings.AgentRadius

getset

Gets or sets the radius of the agents traversing the NavMesh.

Definition at line 72 of file NavMeshGenerationSettings.cs.

◆ BuildBoundingVolumeTree

bool SharpNav.NavMeshGenerationSettings.BuildBoundingVolumeTree

getset

Gets or sets a value indicating whether a bounding volume tree is generated for the mesh.

Definition at line 118 of file NavMeshGenerationSettings.cs.

◆ CellHeight

float SharpNav.NavMeshGenerationSettings.CellHeight

getset

Gets or sets the height of a cell in world units.

Definition at line 57 of file NavMeshGenerationSettings.cs.

◆ CellSize

float SharpNav.NavMeshGenerationSettings.CellSize

getset

Gets or sets the size of a cell in the X and Z axes in world units.

Definition at line 52 of file NavMeshGenerationSettings.cs.

◆ ContourFlags

ContourBuildFlags SharpNav.NavMeshGenerationSettings.ContourFlags

getset

Gets or sets the flags that determine how the ContourSet is generated.

Definition at line 98 of file NavMeshGenerationSettings.cs.

◆ Default

NavMeshGenerationSettings SharpNav.NavMeshGenerationSettings.Default

staticget

Gets the "default" generation settings for a model where 1 unit represents 1 meter.

Definition at line 23 of file NavMeshGenerationSettings.cs.

◆ MaxClimb

float SharpNav.NavMeshGenerationSettings.MaxClimb

getset

Gets or sets the maximum climb height.

Definition at line 62 of file NavMeshGenerationSettings.cs.

◆ MaxEdgeError

float SharpNav.NavMeshGenerationSettings.MaxEdgeError

getset

Gets or sets the maximum error allowed

Definition at line 93 of file NavMeshGenerationSettings.cs.

◆ MaxEdgeLength

int SharpNav.NavMeshGenerationSettings.MaxEdgeLength

getset

Gets or sets the maximum edge length allowed

Definition at line 88 of file NavMeshGenerationSettings.cs.

◆ MaxSampleError

int SharpNav.NavMeshGenerationSettings.MaxSampleError

getset

Gets or sets the maximium error allowed in sampling for the PolyMeshDetail

Definition at line 113 of file NavMeshGenerationSettings.cs.

◆ MergedRegionSize

int SharpNav.NavMeshGenerationSettings.MergedRegionSize

getset

Gets or sets the size of the merged regions

Definition at line 83 of file NavMeshGenerationSettings.cs.

◆ MinRegionSize

int SharpNav.NavMeshGenerationSettings.MinRegionSize

getset

Gets or sets the minimum number of spans that can form a region. Any less than this, and they will be merged with another region.

Definition at line 78 of file NavMeshGenerationSettings.cs.

◆ SampleDistance

int SharpNav.NavMeshGenerationSettings.SampleDistance

getset

Gets or sets the sampling distance for the PolyMeshDetail

Definition at line 108 of file NavMeshGenerationSettings.cs.

◆ VertsPerPoly

int SharpNav.NavMeshGenerationSettings.VertsPerPoly

getset

Gets or sets the number of vertices a polygon can have.

Definition at line 103 of file NavMeshGenerationSettings.cs.

◆ VoxelAgentHeight

int SharpNav.NavMeshGenerationSettings.VoxelAgentHeight

get

Gets the height of the agents traversing the NavMesh in voxel (cell) units.

Definition at line 123 of file NavMeshGenerationSettings.cs.

◆ VoxelAgentRadius

int SharpNav.NavMeshGenerationSettings.VoxelAgentRadius

get

Gets the radius of the agents traversing the NavMesh in voxel (cell) units.

Definition at line 145 of file NavMeshGenerationSettings.cs.

◆ VoxelMaxClimb

int SharpNav.NavMeshGenerationSettings.VoxelMaxClimb

get

Gets the maximum clim height in voxel (cell) units.

Definition at line 134 of file NavMeshGenerationSettings.cs.

The documentation for this class was generated from the following file:

C:/gamedev/unity/DA20.1X/Assets/CodeRespawn/DungeonArchitect/ThirdParty/SharpNav/NavMeshGenerationSettings.cs