[This is preliminary documentation and is subject to change.]

A heightfield representing obstructed space.

Namespace: org.critterai.nmgen
Assembly: cai-nmgen (in cai-nmgen.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public sealed class Heightfield : IManagedObject
Public NotInheritable Class Heightfield _
	Implements IManagedObject
public ref class Heightfield sealed : IManagedObject

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
AddTriangle(BuildContext, array<Vector3>[]()[][], Byte, Int32)
Voxelizes a triangle into the heightfield.
AddTriangles(BuildContext, TriangleMesh, array<Byte>[]()[][], Int32)
Voxelizes the triangles in the provided mesh into the heightfield.
AddTriangles(BuildContext, ChunkyTriMesh, Vector3, Vector3, Int32)
Voxelizes the triangles from the provided ChunkyTriMesh into the heightfield.
AddTriangles(BuildContext, array<Vector3>[]()[][], array<Byte>[]()[][], Int32, Int32)
Voxelizes the provided triangles into the heightfield.
AddTriangles(BuildContext, array<Vector3>[]()[][], array<UInt16>[]()[][], array<Byte>[]()[][], Int32)
Voxelizes the provided triangles into the heightfield.
BoundsMax
The maximum bounds of the heightfield in world space.
BoundsMin
The minimum bounds of the heightfield in world space.
Create(Int32, Int32, Vector3, Vector3, Single, Single)
Creates a new heightfield object.
Depth
The depth of the heighfield. (Along the z-axis in cell units.)
Finalize()()()()
Destructor
(Overrides Object..::..Finalize()()()().)
GetSpanBuffer()()()()
Gets an buffer that is sized to fit the maximum number of spans within a column of the field.
GetSpanCount()()()()
The number of spans in the field.
GetSpans(Int32, Int32, array<HeightfieldSpan>[]()[][])
Gets the spans within the specified column.
IsDisposed
True if the object has been disposed and should no longer be used.
MarkLedgeSpansNotWalkable(BuildContext, Int32, Int32)
Marks spans that are ledges as not-walkable.
MarkLowHeightSpansNotWalkable(BuildContext, Int32)
Marks walkable spans as not walkable if the clearence above the span is less than the specified height.
MarkLowObstaclesWalkable(BuildContext, Int32)
Marks non-walkable spans as walkable if their maximum is within walkableStep of a walkable neighbor.
RequestDisposal()()()()
Frees all resources and marks object as disposed.
ResourceType
The type of unmanaged resources within the object.
Width
The width of the heightfield. (Along the x-axis in cell units.)
XZCellSize
The width/depth size of each cell. (On the xz-plane.)
YCellSize
The height increments for span data. (On the y-axis.)

Remarks

When used in the context of a heighfield, the term voxel refers to an area XZCellSize in width, XZCellSize in depth, and YCellSize in height.

Behavior is undefined if used after disposal.

Inheritance Hierarchy

System..::..Object
  org.critterai.nmgen..::..Heightfield

See Also