rcConfig Struct Reference

#include <Recast.h>

Public Attributes
int	width
	The width of the field along the x-axis. [Limit: >= 0] [Units: vx].
int	height
	The height of the field along the z-axis. [Limit: >= 0] [Units: vx].
int	tileSize
	The width/height size of tile's on the xz-plane. [Limit: >= 0] [Units: vx].
rcBorderSize	borderSize
	The size of the non-navigable border around the heightfield.
rcReal	cs
	The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu].
rcReal	ch
	The y-axis cell size to use for fields. [Limit: > 0] [Units: wu].
rcReal	bmin [3]
	The minimum bounds of the field's AABB. [(x, y, z)] [Units: wu].
rcReal	bmax [3]
	The maximum bounds of the field's AABB. [(x, y, z)] [Units: wu].
rcReal	walkableSlopeAngle
	The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees].
int	walkableHeight
int	walkableClimb
	Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx].
int	walkableRadius
rcReal	maxStepFromWalkableSlope
	Maximum step height in relation to cs and walkableSlopeAngle [Limit: >=0] [Units: wu].
int	maxEdgeLen
	The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx].
rcReal	maxSimplificationError
rcReal	simplificationElevationRatio
int	minRegionArea
	The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx].
int	mergeRegionArea
int	regionChunkSize
	Size of region chunk [Units: vx].
int	regionPartitioning
	Region partitioning method: creating poly mesh.
int	maxVertsPerPoly
rcReal	detailSampleDist
rcReal	detailSampleMaxError

Detailed Description

Specifies a configuration to use when performing Recast builds.

Member Data Documentation

bmax

rcReal rcConfig::bmax[3]

The maximum bounds of the field's AABB. [(x, y, z)] [Units: wu].

bmin

rcReal rcConfig::bmin[3]

The minimum bounds of the field's AABB. [(x, y, z)] [Units: wu].

borderSize

rcBorderSize rcConfig::borderSize

The size of the non-navigable border around the heightfield.

ch

rcReal rcConfig::ch

The y-axis cell size to use for fields. [Limit: > 0] [Units: wu].

cs

rcReal rcConfig::cs

The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu].

detailSampleDist

rcReal rcConfig::detailSampleDist

Sets the sampling distance to use when generating the detail mesh. (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]

detailSampleMaxError

rcReal rcConfig::detailSampleMaxError

The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.) [Limit: >=0] [Units: wu]

height

int rcConfig::height

The height of the field along the z-axis. [Limit: >= 0] [Units: vx].

maxEdgeLen

int rcConfig::maxEdgeLen

The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx].

maxSimplificationError

rcReal rcConfig::maxSimplificationError

The maximum distance a simplified contour's border edges should deviate the original raw contour. [Limit: >=0] [Units: wu]

maxStepFromWalkableSlope

rcReal rcConfig::maxStepFromWalkableSlope

Maximum step height in relation to cs and walkableSlopeAngle [Limit: >=0] [Units: wu].

maxVertsPerPoly

int rcConfig::maxVertsPerPoly

The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. [Limit: >= 3]

mergeRegionArea

int rcConfig::mergeRegionArea

Any regions with a span count smaller than this value will, if possible, be merged with larger regions. [Limit: >=0] [Units: vx]

minRegionArea

int rcConfig::minRegionArea

The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx].

regionChunkSize

int rcConfig::regionChunkSize

Size of region chunk [Units: vx].

regionPartitioning

int rcConfig::regionPartitioning

Region partitioning method: creating poly mesh.

simplificationElevationRatio

rcReal rcConfig::simplificationElevationRatio

When simplifying contours, how much is the vertical error taken into account when comparing with MaxSimplificationError. [Limit: >=0] Use 0 to deactivate (Recast behavior), use 1 as a typical value.

tileSize

int rcConfig::tileSize

The width/height size of tile's on the xz-plane. [Limit: >= 0] [Units: vx].

walkableClimb

int rcConfig::walkableClimb

Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx].

walkableHeight

int rcConfig::walkableHeight

Minimum floor to 'ceiling' height that will still allow the floor area to be considered walkable. [Limit: >= 3] [Units: vx]

walkableRadius

int rcConfig::walkableRadius

The distance to erode/shrink the walkable area of the heightfield away from obstructions. [Limit: >=0] [Units: vx]

walkableSlopeAngle

rcReal rcConfig::walkableSlopeAngle

The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees].

width

int rcConfig::width

The width of the field along the x-axis. [Limit: >= 0] [Units: vx].

---

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

• Engine/Source/Runtime/Navmesh/Public/Recast/Recast.h