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

Contains triangle meshes that represent detailed height data associated with the polygons in its associated PolyMesh 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++ 
[SerializableAttribute]
public sealed class PolyMeshDetail : IManagedObject, 
	ISerializable
<SerializableAttribute> _
Public NotInheritable Class PolyMeshDetail _
	Implements IManagedObject, ISerializable
[SerializableAttribute]
public ref class PolyMeshDetail sealed : IManagedObject, 
	ISerializable

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Build(BuildContext, PolyMesh, CompactHeightfield, Single, Single)
Builds a detail mesh from the provided polygon mesh.
Create(array<Byte>[]()[][])
Constructs a detail 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(PolyMeshDetailData))
Finalize()()()()
Destructor.
(Overrides Object..::..Finalize()()()().)
GetData(Boolean)
Gets the data from the mesh buffers.
GetData(PolyMeshDetailData)
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.
Load(PolyMeshDetailData)
Loads the data into the mesh buffers, overwriting existing content.
MaxMeshes
The maximum number of sub-meshes the mesh buffers can hold.
MaxTris
The maximum number of triangls the triangle buffers can hold.
MaxVerts
The maximum number of vertices the vertex buffer can hold.
MeshCount
The number of sub-meshes in the detail mesh.
RequestDisposal()()()()
Frees all resources and marks the object as disposed.
ResourceType
The type of unmanaged resources within the object.
TriCount
The total number of triangles in the detail mesh.
VertCount
The total number of vertices in the detail mesh.

Remarks

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

The detail mesh is made up of triangle sub-meshes which provide extra height detail for each polygon in its assoicated polygon mesh.

This class is moslty opaque. The PolyMeshDetailData 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 manual serialization within Unity.

Behavior is undefined if used after disposal.

Inheritance Hierarchy

System..::..Object
  org.critterai.nmgen..::..PolyMeshDetail

See Also