Dungeon Architect  17.0.0
SharpNav.ContourSet Class Reference

A set of contours around the regions of a CompactHeightfield, used as the edges of a PolyMesh. More...

Inheritance diagram for SharpNav.ContourSet:

Public Member Functions

 ContourSet (IEnumerable< Contour > contours, BBox3 bounds, int width, int height)
 Initializes a new instance of the ContourSet class. More...
 
bool Contains (Contour item)
 Checks if a specified ContourSet is contained in the ContourSet. More...
 
void CopyTo (Contour[] array, int arrayIndex)
 Copies the Contours in the set to an array. More...
 
IEnumerator< ContourGetEnumerator ()
 Returns an enumerator that iterates through the entire ContourSet. More...
 

Properties

int Count [get]
 Gets the number of Contours in the set. More...
 
BBox3 Bounds [get]
 Gets the world-space bounding box of the set. More...
 
int Width [get]
 Gets the width of the set, not including the border size specified in CompactHeightfield. More...
 
int Height [get]
 Gets the height of the set, not including the border size specified in CompactHeightfield. More...
 

Detailed Description

A set of contours around the regions of a CompactHeightfield, used as the edges of a PolyMesh.

Definition at line 18 of file ContourSet.cs.

Constructor & Destructor Documentation

◆ ContourSet()

SharpNav.ContourSet.ContourSet ( IEnumerable< Contour contours,
BBox3  bounds,
int  width,
int  height 
)

Initializes a new instance of the ContourSet class.

Parameters
contoursA collection of Contours.
boundsThe bounding box that contains all of the Contours.
widthThe width, in voxel units, of the world.
heightThe height, in voxel units, of the world.

Definition at line 32 of file ContourSet.cs.

Member Function Documentation

◆ Contains()

bool SharpNav.ContourSet.Contains ( Contour  item)

Checks if a specified ContourSet is contained in the ContourSet.

Parameters
itemA contour.
Returns
A value indicating whether the set contains the specified contour.

Definition at line 97 of file ContourSet.cs.

◆ CopyTo()

void SharpNav.ContourSet.CopyTo ( Contour[]  array,
int  arrayIndex 
)

Copies the Contours in the set to an array.

Parameters
arrayThe array to copy to.
arrayIndexThe zero-based index in array at which copying begins.

Definition at line 107 of file ContourSet.cs.

◆ GetEnumerator()

IEnumerator<Contour> SharpNav.ContourSet.GetEnumerator ( )

Returns an enumerator that iterates through the entire ContourSet.

Returns
An enumerator.

Definition at line 116 of file ContourSet.cs.

Property Documentation

◆ Bounds

BBox3 SharpNav.ContourSet.Bounds
get

Gets the world-space bounding box of the set.

Definition at line 54 of file ContourSet.cs.

◆ Count

int SharpNav.ContourSet.Count
get

Gets the number of Contours in the set.

Definition at line 43 of file ContourSet.cs.

◆ Height

int SharpNav.ContourSet.Height
get

Gets the height of the set, not including the border size specified in CompactHeightfield.

Definition at line 76 of file ContourSet.cs.

◆ Width

int SharpNav.ContourSet.Width
get

Gets the width of the set, not including the border size specified in CompactHeightfield.

Definition at line 65 of file ContourSet.cs.


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