Dungeon Architect  17.0.0
Public Member Functions | Properties | List of all members
SharpNav.Cell Class Reference

A cell is a column of voxels represented in Spans. More...

Public Member Functions

 Cell (int height)
 Initializes a new instance of the Cell class. More...
 
void AddSpan (Span span)
 Adds a Span to the cell. More...
 

Properties

int Height [get]
 Gets the height of the cell in number of voxels. More...
 
int SpanCount [get]
 Gets the number of spans in the cell. More...
 
int WalkableSpanCount [get]
 Gets the number of spans that are in walkable Areas. More...
 
ReadOnlyCollection< Span > Spans [get]
 Gets a readonly list of all the Spans contained in the cell. More...
 
Span? this[int location] [get]
 Gets the Span that contains the specified voxel. More...
 

Detailed Description

A cell is a column of voxels represented in Spans.

Definition at line 13 of file Cell.cs.

Constructor & Destructor Documentation

◆ Cell()

SharpNav.Cell.Cell ( int  height)

Initializes a new instance of the Cell class.

Parameters
heightThe number of voxels in the column.

Definition at line 22 of file Cell.cs.

Member Function Documentation

◆ AddSpan()

void SharpNav.Cell.AddSpan ( Span  span)

Adds a Span to the cell.

Parameters
spanA span.
Exceptions
ArgumentExceptionThrown if an invalid span is provided.

Definition at line 121 of file Cell.cs.

Property Documentation

◆ Height

int SharpNav.Cell.Height
get

Gets the height of the cell in number of voxels.

Definition at line 31 of file Cell.cs.

◆ SpanCount

int SharpNav.Cell.SpanCount
get

Gets the number of spans in the cell.

Definition at line 42 of file Cell.cs.

◆ Spans

ReadOnlyCollection<Span> SharpNav.Cell.Spans
get

Gets a readonly list of all the Spans contained in the cell.

A readonly list of spans.

Definition at line 70 of file Cell.cs.

◆ this[int location]

Span? SharpNav.Cell.this[int location]
get

Gets the Span that contains the specified voxel.

Parameters
locationThe voxel to search for.
Returns
The span containing the voxel. Null if the voxel is empty.

Definition at line 96 of file Cell.cs.

◆ WalkableSpanCount

int SharpNav.Cell.WalkableSpanCount
get

Gets the number of spans that are in walkable Areas.

Definition at line 53 of file Cell.cs.

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