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

Respresents a span within a CompactHeightfield object.

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 struct CompactSpan
Public Structure CompactSpan
public value class CompactSpan

Members

            
 All Members  Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Connections
The packed neighbor connection data for the span.
Floor
The height of the span's lower extent. (Measured from the heightfield's base.)
GetConnection(Int32)
Gets neighbor connection data for the specified direction.
GetDirOffsetX(Int32)
Gets the standard width offset for the specified direction.
GetDirOffsetZ(Int32)
Gets the standard depth offset for the specified direction.
Height
The height of the span's upper extent. (Measured from the span's floor.)
MaxHeight
The maximum for Height.
NotConnected
The value returned by GetConnection(Int32) if the specified direction is not connected.
Region
The id of the region the span belongs to.

Remarks

The span represents open, unobstructed space within a heightfield column.

See the CompactHeightfield documentation for a discussion of iterating spans and searching span connections.

Useful instances of this type can only by obtained from a CompactHeightfield object.

See Also