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

Represents a polygon mesh suitable for use in building a a navigation mesh.

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++ 
[SerializableAttribute]
public sealed class PolyMesh : ManagedObject, 
	ISerializable
<SerializableAttribute> _
Public NotInheritable Class PolyMesh _
	Inherits ManagedObject _
	Implements ISerializable
[SerializableAttribute]
public ref class PolyMesh sealed : public ManagedObject, 
	ISerializable

Members

            
 All Members  Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
BorderSize
The AABB border size applied during the build of the mesh. [Units: XZCellSize]
BoundsMax
The world space maximum bounds of the mesh's AABB.
BoundsMin
The world space minimum bounds of the mesh's AABB.
Build(BuildContext, ContourSet, Int32, Int32, Int32, Int32)
Builds polygon mesh from the provided contours.
Create(array<Byte>[]()[][])
Creates a polygon mesh from the data generated by the GetSerializedData(Boolean) method.
Create(Int32, Int32, Int32)
Constructs an object with all buffers allocated and ready to load with data. (See: Load(PolyMeshData))
Finalize()()()()
Destructor.
(Overrides Object..::..Finalize()()()().)
GetData(Boolean)
Gets the data from the mesh buffers.
GetData(PolyMeshData)
Loads the data from the mesh buffers into the data object.
GetObjectData(SerializationInfo, StreamingContext)
Gets serialization data for the object.
GetSerializedData(Boolean)
Gets a serialized version of the mesh that can be used to recreate it later.
IsDisposed
True if the object has been disposed and should no longer be used.
(Overrides ManagedObject..::..IsDisposed.)
Load(PolyMeshData)
Loads the data into the mesh buffers, overwriting existing content.
MaxPolys
The maximum number of polygons the polygon buffer can hold.
MaxVerts
The maximum number of vertices the vertex buffer can hold.
MaxVertsPerPoly
The maximum number of vertices per polygon.
NullIndex
Represents an index that does not point to anything.
PolyCount
The number of polygons defined by the mesh.
RequestDisposal()()()()
Frees all resources and marks the object as disposed.
(Overrides ManagedObject..::..RequestDisposal()()()().)
VertCount
The number of vertices in the vertex array.
WalkableHeight
The minimum floor to 'ceiling' height used to build the polygon mesh. [Units: World]
WalkableRadius
The radius used to erode the walkable area of the mesh. [Units: World]
WalkableStep
The maximum traversable ledge height used to build the polygon mesh. [Units: World]
XZCellSize
The xz-plane size of the cells that form the mesh field.
YCellSize
The y-axis size of the cells that form the mesh field.

Remarks

Warning: The serializable attribute and interface will be removed in v0.5. Use GetSerializedData(Boolean) instead.

Represents a mesh of potentially overlapping convex polygons of between three and MaxVertsPerPoly vertices. The mesh exists within the context of an axis-aligned bounding box (AABB) with vertices laid out in an evenly spaced grid based on xz-plane and y-axis cells.

This class is moslty opaque. The PolyMeshData class provides the ability to inspect and update the content.

This class is not compatible with Unity serialization. The GetSerializedData(Boolean) method can be used for serialization within Unity.

Behavior is undefined if used after disposal.

Inheritance Hierarchy

System..::..Object
  org.critterai.interop..::..ManagedObject
    org.critterai.nmgen..::..PolyMesh

See Also