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

Provides a way of building navigation mesh data in incremental steps.

Namespace: org.critterai.nmbuild
Assembly: cai-nmbuild (in cai-nmbuild.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public sealed class IncrementalBuilder
Public NotInheritable Class IncrementalBuilder
public ref class IncrementalBuilder sealed

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Build()()()()
Performs a single build step.
BuildAll()()()()
Performs all build steps.
Create(NMGenParams, NMGenAssetFlag, InputGeometry, ProcessorSet)
Creates a new builder for a single-tile mesh build.
Create(Int32, Int32, NMGenAssetFlag, TileSetDefinition, ProcessorSet)
Creates a new builder for a multi-tile mesh build.
GetMessages()()()()
Gets available build messages, or a zero length array if no messages are available.
GetMessagesFlat()()()()
Gets a new line delimited flattened version of all build messages.
IsFinished
True if the the build has finished. (Successfully or not.)
IsThreadSafe
True if the builder is safe to run on a separate thread from which it was created.
MessageCount
The number of messages generated by the build.
Result
The result of the build.
ResultOptions
The NMGen assets that will be included in the Result.
State
The current state of the builder.
TileX
The x-index of the tile within the tile grid. (x, z)
TileZ
The x-index of the tile within the tile grid. (x, z)
ToLabel(NMGenState)
Returns human friendly text for the specified state.
ToProgress(NMGenState)
Returns a progress value associated with the specified state.

Remarks

Processors will be called for processing after each step. (Post-processing) The assests available by default at each step will be as follows:

HeightfieldBuild: Heightfield
CompactFieldBuild: CompactHeightfield
RegionBuild: CompactHeightfield
ContourBuild: ContourSet and CompactHeightfield
PolyMeshBuild: PolyMesh and CompactHeightfield
DetailMeshBuild: PolyMeshDetail and CompactHeightfield

More assets will be avialable based on PreserveAssetsResultOptions requirements.

The detail mesh step will only occur if the ResultOptions settings require it.

Processors are allowed to replace assets. But they must never set the assets to an invalid state.

Each instance can be used to perform only a single build. (Single use.)

Inheritance Hierarchy

System..::..Object
  org.critterai.nmbuild..::..IncrementalBuilder

See Also