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

Public Member Functions
	Heightfield (BBox3 b, NavMeshGenerationSettings settings)
	Initializes a new instance of the Heightfield class. More...

	Heightfield (BBox3 b, float cellSize, float cellHeight)
	Initializes a new instance of the Heightfield class. More...

void	FilterLowHangingWalkableObstacles (int walkableClimb)
	Filters the heightmap to allow two neighboring spans have a small difference in maximum height (such as stairs) to be walkable. More...

void	FilterWalkableLowHeightSpans (int walkableHeight)
	If two spans have little vertical space in between them, then span is considered unwalkable More...

void	FilterLedgeSpans (int walkableHeight, int walkableClimb)
	A ledge is unwalkable because the difference between the maximum height of two spans is too large of a drop (i.e. greater than walkableClimb). More...

void	RasterizeTrianglesIndexedWithAreas (Vector3[] verts, int[] inds, Area[] areas)
	Rasterizes several triangles at once from an indexed array with per-triangle area flags. More...

void	RasterizeTrianglesIndexedWithAreas (Vector3[] verts, int[] inds, int vertOffset, int vertStride, int indexOffset, int triCount, Area[] areas)
	Rasterizes several triangles at once from an indexed array with per-triangle area flags. More...

void	RasterizeTrianglesIndexedWithAreas (float[] verts, int[] inds, Area[] areas)
	Rasterizes several triangles at once from an indexed array with per-triangle area flags. More...

void	RasterizeTrianglesIndexedWithAreas (float[] verts, int[] inds, int floatOffset, int floatStride, int indexOffset, int triCount, Area[] areas)
	Rasterizes several triangles at once from an indexed array with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (Triangle3[] tris, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (Triangle3[] tris, int triOffset, int triCount, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (Vector3[] verts, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (Vector3[] verts, int vertOffset, int vertStride, int triCount, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (float[] verts, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesWithAreas (float[] verts, int floatOffset, int floatStride, int triCount, Area[] areas)
	Rasterizes several triangles at once with per-triangle area flags. More...

void	RasterizeTrianglesIndexed (Vector3[] verts, int[] inds)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (Vector3[] verts, int[] inds, Area area)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (Vector3[] verts, int[] inds, int vertOffset, int vertStride, int indexOffset, int triCount)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (Vector3[] verts, int[] inds, int vertOffset, int vertStride, int indexOffset, int triCount, Area area)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (float[] verts, int[] inds)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (float[] verts, int[] inds, Area area)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (float[] verts, int[] inds, int floatOffset, int floatStride, int indexOffset, int triCount)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTrianglesIndexed (float[] verts, int[] inds, int floatOffset, int floatStride, int indexOffset, int triCount, Area area)
	Rasterizes several triangles at once from an indexed array. More...

void	RasterizeTriangles (IEnumerable< Triangle3 > tris)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (IEnumerable< Triangle3 > tris, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Triangle3[] tris)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Triangle3[] tris, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Triangle3[] tris, int triOffset, int triCount)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Triangle3[] tris, int triOffset, int triCount, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Vector3[] verts)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Vector3[] verts, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Vector3[] verts, int vertOffset, int vertStride, int triCount)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (Vector3[] verts, int vertOffset, int vertStride, int triCount, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (float[] verts)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (float[] verts, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (float[] verts, int floatOffset, int floatStride, int triCount)
	Rasterizes several triangles at once. More...

void	RasterizeTriangles (float[] verts, int floatOffset, int floatStride, int triCount, Area area)
	Rasterizes several triangles at once. More...

void	RasterizeTriangle (ref Triangle3 tri)
	Rasterizes a triangle using conservative voxelization. More...

void	RasterizeTriangle (ref Triangle3 tri, Area area)
	Rasterizes a triangle using conservative voxelization. More...

void	RasterizeTriangle (float ax, float ay, float az, float bx, float by, float bz, float cx, float cy, float cz)
	Rasterizes a triangle using conservative voxelization. More...

void	RasterizeTriangle (float ax, float ay, float az, float bx, float by, float bz, float cx, float cy, float cz, Area area)
	Rasterizes a triangle using conservative voxelization. More...

void	RasterizeTriangle (ref Vector3 a, ref Vector3 b, ref Vector3 c)
	Rasterizes a triangle using conservative voxelization. More...

void	RasterizeTriangle (ref Vector3 a, ref Vector3 b, ref Vector3 c, Area area)
	Rasterizes a triangle using conservative voxelization. More...

Properties
BBox3	Bounds `[get]`
	Gets the bounding box of the heightfield. More...

Vector3	Minimum `[get]`
	Gets the world-space minimum. More...

Vector3	Maximum `[get]`
	Gets the world-space maximum. More...

int	Width `[get]`
	Gets the number of cells in the X direction. More...

int	Height `[get]`
	Gets the number of cells in the Y (up) direction. More...

int	Length `[get]`
	Gets the number of cells in the Z direction. More...

Vector3	CellSize `[get]`
	Gets the size of a cell (voxel). More...

float	CellSizeXZ `[get]`
	Gets the size of a cell on the X and Z axes. More...

float	CellHeight `[get]`
	Gets the size of a cell on the Y axis. More...

int	SpanCount `[get]`
	Gets the total number of spans. More...

Cell	this[int x, int y] `[get]`
	Gets the Cell at the specified coordinate. More...

Cell	this[int i] `[get]`
	Gets the Cell at the specified index. More...

Span	this[SpanReference spanRef] `[get]`
	Gets the Span at the reference. More...

Detailed Description

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

<content> This file contains various methods to rasterize objects into voxel data. </content>

Definition at line 22 of file Heightfield.cs.

Constructor & Destructor Documentation

◆ Heightfield() [1/2]

SharpNav.Heightfield.Heightfield	(	BBox3	b,
		NavMeshGenerationSettings	settings
	)

Initializes a new instance of the Heightfield class.

Parameters

b	The world-space bounds.
settings	The settings to build with.

Definition at line 36 of file Heightfield.cs.

◆ Heightfield() [2/2]

SharpNav.Heightfield.Heightfield	(	BBox3	b,
		float	cellSize,
		float	cellHeight
	)

Initializes a new instance of the Heightfield class.

Parameters

b	The world-space bounds.
cellSize	The world-space size of each cell in the XZ plane.
cellHeight	The world-space height of each cell.

Definition at line 47 of file Heightfield.cs.

Member Function Documentation

◆ FilterLedgeSpans()

void SharpNav.Heightfield.FilterLedgeSpans	(	int	walkableHeight,
		int	walkableClimb
	)

A ledge is unwalkable because the difference between the maximum height of two spans is too large of a drop (i.e. greater than walkableClimb).

Parameters

walkableHeight	The maximum walkable height to filter.
walkableClimb	The maximum walkable climb to filter.

Definition at line 321 of file Heightfield.cs.

◆ FilterLowHangingWalkableObstacles()

void SharpNav.Heightfield.FilterLowHangingWalkableObstacles ( int walkableClimb )

Filters the heightmap to allow two neighboring spans have a small difference in maximum height (such as stairs) to be walkable.

This filter may override the results of FilterLedgeSpans.

Parameters

walkableClimb The maximum difference in height to filter.

Definition at line 250 of file Heightfield.cs.

◆ FilterWalkableLowHeightSpans()

void SharpNav.Heightfield.FilterWalkableLowHeightSpans ( int walkableHeight )

If two spans have little vertical space in between them, then span is considered unwalkable

Parameters

walkableHeight The clearance.

Definition at line 293 of file Heightfield.cs.

◆ RasterizeTriangle() [1/6]

void SharpNav.Heightfield.RasterizeTriangle	(	float	ax,
		float	ay,
		float	az,
		float	bx,
		float	by,
		float	bz,
		float	cx,
		float	cy,
		float	cz
	)

Rasterizes a triangle using conservative voxelization.

Parameters

ax	The X component of the first vertex of the triangle.
ay	The Y component of the first vertex of the triangle.
az	The Z component of the first vertex of the triangle.
bx	The X component of the second vertex of the triangle.
by	The Y component of the second vertex of the triangle.
bz	The Z component of the second vertex of the triangle.
cx	The X component of the third vertex of the triangle.
cy	The Y component of the third vertex of the triangle.
cz	The Z component of the third vertex of the triangle.

Definition at line 784 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangle() [2/6]

void SharpNav.Heightfield.RasterizeTriangle	(	float	ax,
		float	ay,
		float	az,
		float	bx,
		float	by,
		float	bz,
		float	cx,
		float	cy,
		float	cz,
		Area	area
	)

Rasterizes a triangle using conservative voxelization.

Parameters

ax	The X component of the first vertex of the triangle.
ay	The Y component of the first vertex of the triangle.
az	The Z component of the first vertex of the triangle.
bx	The X component of the second vertex of the triangle.
by	The Y component of the second vertex of the triangle.
bz	The Z component of the second vertex of the triangle.
cx	The X component of the third vertex of the triangle.
cy	The Y component of the third vertex of the triangle.
cz	The Z component of the third vertex of the triangle.
area	The area flags for the triangle.

Definition at line 802 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangle() [3/6]

void SharpNav.Heightfield.RasterizeTriangle ( ref Triangle3 tri )

Rasterizes a triangle using conservative voxelization.

Parameters

tri	The triangle as a Triangle3 struct.

Definition at line 757 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangle() [4/6]

void SharpNav.Heightfield.RasterizeTriangle	(	ref Triangle3	tri,
		Area	area
	)

Rasterizes a triangle using conservative voxelization.

Parameters

tri	The triangle as a Triangle3 struct.
area	The area flags for the triangle.

Definition at line 767 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangle() [5/6]

void SharpNav.Heightfield.RasterizeTriangle	(	ref Vector3	a,
		ref Vector3	b,
		ref Vector3	c
	)

Rasterizes a triangle using conservative voxelization.

Parameters

a	The first vertex of the triangle.
b	The second vertex of the triangle.
c	The third vertex of the triangle.

Definition at line 825 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangle() [6/6]

void SharpNav.Heightfield.RasterizeTriangle	(	ref Vector3	a,
		ref Vector3	b,
		ref Vector3	c,
		Area	area
	)

Rasterizes a triangle using conservative voxelization.

Parameters

a	The first vertex of the triangle.
b	The second vertex of the triangle.
c	The third vertex of the triangle.
area	The area flags for the triangle.

Definition at line 837 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [1/14]

void SharpNav.Heightfield.RasterizeTriangles ( float[] verts )

Rasterizes several triangles at once.

If the length of the array is not a multiple of 9, the extra floats at the end will be skipped.

Parameters

verts An array of vertices.

Definition at line 669 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [2/14]

void SharpNav.Heightfield.RasterizeTriangles	(	float[]	verts,
		Area	area
	)

Rasterizes several triangles at once.

If the length of the array is not a multiple of 9, the extra floats at the end will be skipped.

Parameters

verts	An array of vertices.
area	The area flags for all of the triangles.

Definition at line 682 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [3/14]

void SharpNav.Heightfield.RasterizeTriangles	(	float[]	verts,
		int	floatOffset,
		int	floatStride,
		int	triCount
	)

Rasterizes several triangles at once.

Parameters

verts	An array of vertices.
floatOffset	An offset into the array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
triCount	The number of triangles to rasterize.

Definition at line 694 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [4/14]

void SharpNav.Heightfield.RasterizeTriangles	(	float[]	verts,
		int	floatOffset,
		int	floatStride,
		int	triCount,
		Area	area
	)

Rasterizes several triangles at once.

Parameters

verts	An array of vertices.
floatOffset	An offset into the array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
triCount	The number of triangles to rasterize.
area	The area flags for all of the triangles.

Definition at line 707 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [5/14]

void SharpNav.Heightfield.RasterizeTriangles ( IEnumerable< Triangle3 > tris )

Rasterizes several triangles at once.

Parameters

tris	A collection of triangles.

Definition at line 475 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [6/14]

void SharpNav.Heightfield.RasterizeTriangles	(	IEnumerable< Triangle3 >	tris,
		Area	area
	)

Rasterizes several triangles at once.

Parameters

tris	A collection of triangles.
area	The area flags for all of the triangles.

Definition at line 485 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [7/14]

void SharpNav.Heightfield.RasterizeTriangles ( Triangle3[] tris )

Rasterizes several triangles at once.

Parameters

tris	An array of triangles.

Definition at line 503 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [8/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Triangle3[]	tris,
		Area	area
	)

Rasterizes several triangles at once.

Parameters

tris	An array of triangles.
area	The area flags for all of the triangles.

Definition at line 513 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [9/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Triangle3[]	tris,
		int	triOffset,
		int	triCount
	)

Rasterizes several triangles at once.

Parameters

tris	An array of triangles.
triOffset	An offset into the array.
triCount	The number of triangles to rasterize, starting from the offset.

Definition at line 524 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [10/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Triangle3[]	tris,
		int	triOffset,
		int	triCount,
		Area	area
	)

Rasterizes several triangles at once.

Parameters

tris	An array of triangles.
triOffset	An offset into the array.
triCount	The number of triangles to rasterize, starting from the offset.
area	The area flags for all of the triangles.

Definition at line 536 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [11/14]

void SharpNav.Heightfield.RasterizeTriangles ( Vector3[] verts )

Rasterizes several triangles at once.

If the length of the array is not a multiple of 3, the extra vertices at the end will be skipped.

Parameters

verts An array of vertices.

Definition at line 595 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [12/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Vector3[]	verts,
		Area	area
	)

Rasterizes several triangles at once.

If the length of the array is not a multiple of 3, the extra vertices at the end will be skipped.

Parameters

verts	An array of vertices.
area	The area flags for all of the triangles.

Definition at line 608 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [13/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Vector3[]	verts,
		int	vertOffset,
		int	vertStride,
		int	triCount
	)

Rasterizes several triangles at once.

Parameters

verts	An array of vertices.
vertOffset	An offset into the array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (1 Vector3 per vertex).
triCount	The number of triangles to rasterize, starting from the offset.

Definition at line 620 of file Heightfield.Rasterization.cs.

◆ RasterizeTriangles() [14/14]

void SharpNav.Heightfield.RasterizeTriangles	(	Vector3[]	verts,
		int	vertOffset,
		int	vertStride,
		int	triCount,
		Area	area
	)

Rasterizes several triangles at once.

Parameters

verts	An array of vertices.
vertOffset	An offset into the array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (1 Vector3 per vertex).
triCount	The number of triangles to rasterize, starting from the offset.
area	The area flags for all of the triangles.

Definition at line 633 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [1/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	float[]	verts,
		int[]	inds
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.

Definition at line 386 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [2/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	float[]	verts,
		int[]	inds,
		Area	area
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
area	The area flags for all the triangles.

Definition at line 397 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [3/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	float[]	verts,
		int[]	inds,
		int	floatOffset,
		int	floatStride,
		int	indexOffset,
		int	triCount
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
floatOffset	An offset into the vertex array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.

Definition at line 411 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [4/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	float[]	verts,
		int[]	inds,
		int	floatOffset,
		int	floatStride,
		int	indexOffset,
		int	triCount,
		Area	area
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
floatOffset	An offset into the vertex array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.
area	The area flags for all of the triangles.

Definition at line 426 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [5/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	Vector3[]	verts,
		int[]	inds
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.

Definition at line 310 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [6/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	Vector3[]	verts,
		int[]	inds,
		Area	area
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
area	The area flags for all the triangles.

Definition at line 321 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [7/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	Vector3[]	verts,
		int[]	inds,
		int	vertOffset,
		int	vertStride,
		int	indexOffset,
		int	triCount
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
vertOffset	An offset into the vertex array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (one Vector3 per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.

Definition at line 335 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexed() [8/8]

void SharpNav.Heightfield.RasterizeTrianglesIndexed	(	Vector3[]	verts,
		int[]	inds,
		int	vertOffset,
		int	vertStride,
		int	indexOffset,
		int	triCount,
		Area	area
	)

Rasterizes several triangles at once from an indexed array.

Parameters

verts	An array of vertices.
inds	An array of indices.
vertOffset	An offset into the vertex array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (one Vector3 per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.
area	The area flags for all of the triangles.

Definition at line 350 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexedWithAreas() [1/4]

void SharpNav.Heightfield.RasterizeTrianglesIndexedWithAreas	(	float[]	verts,
		int[]	inds,
		Area[]	areas
	)

Rasterizes several triangles at once from an indexed array with per-triangle area flags.

Parameters

verts	An array of vertices.
inds	An array of indices.
areas	An array of area flags, one for each triangle.

Definition at line 86 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexedWithAreas() [2/4]

void SharpNav.Heightfield.RasterizeTrianglesIndexedWithAreas	(	float[]	verts,
		int[]	inds,
		int	floatOffset,
		int	floatStride,
		int	indexOffset,
		int	triCount,
		Area[]	areas
	)

Rasterizes several triangles at once from an indexed array with per-triangle area flags.

Parameters

verts	An array of vertices.
inds	An array of indices.
floatOffset	An offset into the vertex array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.
areas	An array of area flags, one for each triangle.

Definition at line 101 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexedWithAreas() [3/4]

void SharpNav.Heightfield.RasterizeTrianglesIndexedWithAreas	(	Vector3[]	verts,
		int[]	inds,
		Area[]	areas
	)

Rasterizes several triangles at once from an indexed array with per-triangle area flags.

Parameters

verts	An array of vertices.
inds	An array of indices.
areas	An array of area flags, one for each triangle.

Definition at line 31 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesIndexedWithAreas() [4/4]

void SharpNav.Heightfield.RasterizeTrianglesIndexedWithAreas	(	Vector3[]	verts,
		int[]	inds,
		int	vertOffset,
		int	vertStride,
		int	indexOffset,
		int	triCount,
		Area[]	areas
	)

Rasterizes several triangles at once from an indexed array with per-triangle area flags.

Parameters

verts	An array of vertices.
inds	An array of indices.
vertOffset	An offset into the vertex array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (one Vector3 per vertex).
indexOffset	An offset into the index array.
triCount	The number of triangles to rasterize.
areas	An array of area flags, one for each triangle.

Definition at line 46 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [1/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	float[]	verts,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

If the length of the array is not a multiple of 9, the extra floats at the end will be skipped.

Parameters

verts	An array of vertices.
areas	An array of area flags, one for each triangle.

Definition at line 246 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [2/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	float[]	verts,
		int	floatOffset,
		int	floatStride,
		int	triCount,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

Parameters

verts	An array of vertices.
floatOffset	An offset into the array.
floatStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (3 floats per vertex).
triCount	The number of triangles to rasterize.
areas	An array of area flags, one for each triangle.

Definition at line 259 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [3/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	Triangle3[]	tris,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

Parameters

tris	An array of triangles.
areas	An array of area flags, one for each triangle.

Definition at line 154 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [4/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	Triangle3[]	tris,
		int	triOffset,
		int	triCount,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

Parameters

tris	An array of triangles.
triOffset	An offset into the array.
triCount	The number of triangles to rasterize, starting from the offset.
areas	An array of area flags, one for each triangle.

Definition at line 166 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [5/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	Vector3[]	verts,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

If the length of the array is not a multiple of 3, the extra vertices at the end will be skipped.

Parameters

verts	An array of vertices.
areas	An array of area flags, one for each triangle.

Definition at line 197 of file Heightfield.Rasterization.cs.

◆ RasterizeTrianglesWithAreas() [6/6]

void SharpNav.Heightfield.RasterizeTrianglesWithAreas	(	Vector3[]	verts,
		int	vertOffset,
		int	vertStride,
		int	triCount,
		Area[]	areas
	)

Rasterizes several triangles at once with per-triangle area flags.

Parameters

verts	An array of vertices.
vertOffset	An offset into the array.
vertStride	The number of array elements that make up a vertex. A value of 0 is interpreted as tightly-packed data (1 Vector3 per vertex).
triCount	The number of triangles to rasterize, starting from the offset.
areas	An array of area flags, one for each triangle.

Definition at line 210 of file Heightfield.Rasterization.cs.

Property Documentation

◆ Bounds

BBox3 SharpNav.Heightfield.Bounds

get

Gets the bounding box of the heightfield.

Definition at line 79 of file Heightfield.cs.

◆ CellHeight

float SharpNav.Heightfield.CellHeight

get

Gets the size of a cell on the Y axis.

Definition at line 173 of file Heightfield.cs.

◆ CellSize

Vector3 SharpNav.Heightfield.CellSize

get

Gets the size of a cell (voxel).

The size of the cell.

Definition at line 151 of file Heightfield.cs.

◆ CellSizeXZ

float SharpNav.Heightfield.CellSizeXZ

get

Gets the size of a cell on the X and Z axes.

Definition at line 162 of file Heightfield.cs.

◆ Height

int SharpNav.Heightfield.Height

get

Gets the number of cells in the Y (up) direction.

The height.

Definition at line 127 of file Heightfield.cs.

◆ Length

int SharpNav.Heightfield.Length

get

Gets the number of cells in the Z direction.

The length.

Definition at line 139 of file Heightfield.cs.

◆ Maximum

Vector3 SharpNav.Heightfield.Maximum

get

Gets the world-space maximum.

The maximum.

Definition at line 103 of file Heightfield.cs.

◆ Minimum

Vector3 SharpNav.Heightfield.Minimum

get

Gets the world-space minimum.

The minimum.

Definition at line 91 of file Heightfield.cs.

◆ SpanCount

int SharpNav.Heightfield.SpanCount

get

Gets the total number of spans.

Definition at line 184 of file Heightfield.cs.

◆ this[int i]

Cell SharpNav.Heightfield.this[int i]

get

Gets the Cell at the specified index.

Parameters

i	The index.

Returns: The cell at index i.

Definition at line 218 of file Heightfield.cs.

◆ this[int x, int y]

Cell SharpNav.Heightfield.this[int x, int y]

get

Gets the Cell at the specified coordinate.

Parameters

x	The x coordinate.
y	The y coordinate.

Returns: The cell at [x, y].

Definition at line 202 of file Heightfield.cs.

◆ this[SpanReference spanRef]

Span SharpNav.Heightfield.this[SpanReference spanRef]

get

Gets the Span at the reference.

Parameters

spanRef A reference to a span.

Returns: The span at the reference.

Definition at line 234 of file Heightfield.cs.

◆ Width

int SharpNav.Heightfield.Width

get

Gets the number of cells in the X direction.

The width.

Definition at line 115 of file Heightfield.cs.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Heightfield() [1/2]

◆ Heightfield() [2/2]

Member Function Documentation

◆ FilterLedgeSpans()

◆ FilterLowHangingWalkableObstacles()

◆ FilterWalkableLowHeightSpans()

◆ RasterizeTriangle() [1/6]

◆ RasterizeTriangle() [2/6]

◆ RasterizeTriangle() [3/6]

◆ RasterizeTriangle() [4/6]

◆ RasterizeTriangle() [5/6]

◆ RasterizeTriangle() [6/6]

◆ RasterizeTriangles() [1/14]

◆ RasterizeTriangles() [2/14]

◆ RasterizeTriangles() [3/14]

◆ RasterizeTriangles() [4/14]

◆ RasterizeTriangles() [5/14]

◆ RasterizeTriangles() [6/14]

◆ RasterizeTriangles() [7/14]

◆ RasterizeTriangles() [8/14]

◆ RasterizeTriangles() [9/14]

◆ RasterizeTriangles() [10/14]

◆ RasterizeTriangles() [11/14]

◆ RasterizeTriangles() [12/14]

◆ RasterizeTriangles() [13/14]

◆ RasterizeTriangles() [14/14]

◆ RasterizeTrianglesIndexed() [1/8]

◆ RasterizeTrianglesIndexed() [2/8]

◆ RasterizeTrianglesIndexed() [3/8]

◆ RasterizeTrianglesIndexed() [4/8]

◆ RasterizeTrianglesIndexed() [5/8]

◆ RasterizeTrianglesIndexed() [6/8]

◆ RasterizeTrianglesIndexed() [7/8]

◆ RasterizeTrianglesIndexed() [8/8]

◆ RasterizeTrianglesIndexedWithAreas() [1/4]

◆ RasterizeTrianglesIndexedWithAreas() [2/4]

◆ RasterizeTrianglesIndexedWithAreas() [3/4]

◆ RasterizeTrianglesIndexedWithAreas() [4/4]

◆ RasterizeTrianglesWithAreas() [1/6]

◆ RasterizeTrianglesWithAreas() [2/6]

◆ RasterizeTrianglesWithAreas() [3/6]

◆ RasterizeTrianglesWithAreas() [4/6]

◆ RasterizeTrianglesWithAreas() [5/6]

◆ RasterizeTrianglesWithAreas() [6/6]

Property Documentation

◆ Bounds

◆ CellHeight

◆ CellSize

◆ CellSizeXZ

◆ Height

◆ Length

◆ Maximum

◆ Minimum

◆ SpanCount

◆ this[int i]

◆ this[int x, int y]

◆ this[SpanReference spanRef]

◆ Width