UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
rcCompactHeightfield Struct Reference

#include <Recast.h>

Public Attributes

int width
 The width of the heightfield. (Along the x-axis in cell units.)
 
int height
 The height of the heightfield. (Along the z-axis in cell units.)
 
int spanCount
 The number of spans in the heightfield.
 
int walkableHeight
 The walkable height used during the build of the field. (See: rcConfig::walkableHeight)
 
int walkableClimb
 The walkable climb used during the build of the field. (See: rcConfig::walkableClimb)
 
rcBorderSize borderSize
 The AABB border size used during the build of the field. (See: rcConfig::borderSize) //@UE.
 
unsigned short maxDistance
 The maximum distance value of any span within the field.
 
unsigned short maxRegions
 The maximum region id of any span within the field.
 
rcReal bmin [3]
 The minimum bounds in world space. [(x, y, z)].
 
rcReal bmax [3]
 The maximum bounds in world space. [(x, y, z)].
 
rcReal cs
 The size of each cell. (On the xz-plane.)
 
rcReal ch
 The height of each cell. (The minimum increment along the y-axis.)
 
rcCompactCellcells
 Array of cells. [Size: width*height].
 
rcCompactSpanspans
 Array of spans. [Size: spanCount].
 
unsigned shortdist
 Array containing border distance data. [Size: spanCount].
 
unsigned charareas
 Array containing area id data. [Size: spanCount].
 

Detailed Description

A compact, static heightfield representing unobstructed space.

Member Data Documentation

◆ areas

unsigned char* rcCompactHeightfield::areas

Array containing area id data. [Size: spanCount].

◆ bmax

rcReal rcCompactHeightfield::bmax[3]

The maximum bounds in world space. [(x, y, z)].

◆ bmin

rcReal rcCompactHeightfield::bmin[3]

The minimum bounds in world space. [(x, y, z)].

◆ borderSize

rcBorderSize rcCompactHeightfield::borderSize

The AABB border size used during the build of the field. (See: rcConfig::borderSize) //@UE.

◆ cells

rcCompactCell* rcCompactHeightfield::cells

Array of cells. [Size: width*height].

◆ ch

rcReal rcCompactHeightfield::ch

The height of each cell. (The minimum increment along the y-axis.)

◆ cs

rcReal rcCompactHeightfield::cs

The size of each cell. (On the xz-plane.)

◆ dist

unsigned short* rcCompactHeightfield::dist

Array containing border distance data. [Size: spanCount].

◆ height

int rcCompactHeightfield::height

The height of the heightfield. (Along the z-axis in cell units.)

◆ maxDistance

unsigned short rcCompactHeightfield::maxDistance

The maximum distance value of any span within the field.

◆ maxRegions

unsigned short rcCompactHeightfield::maxRegions

The maximum region id of any span within the field.

◆ spanCount

int rcCompactHeightfield::spanCount

The number of spans in the heightfield.

◆ spans

rcCompactSpan* rcCompactHeightfield::spans

Array of spans. [Size: spanCount].

◆ walkableClimb

int rcCompactHeightfield::walkableClimb

The walkable climb used during the build of the field. (See: rcConfig::walkableClimb)

◆ walkableHeight

int rcCompactHeightfield::walkableHeight

The walkable height used during the build of the field. (See: rcConfig::walkableHeight)

◆ width

int rcCompactHeightfield::width

The width of the heightfield. (Along the x-axis in cell units.)


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