Kaim::GeneratorReport Class Reference
#include <generatorreport.h>
Class Description
The GeneratorReport class encapsulates a detailed report of all activities carried out during a call to the Generator::Generate(GeneratorInputOutput&) method.
This report may be useful to you for evaluating the data generated in your level design tool; it may also be useful to help Autodesk middleware Support diagnose problems that occur in your NavData generation.
You can retrieve an instance of this class by calling Generator::GetGeneratorReport() at any time after a successful NavData generation. You can interact with the retrieved instance programmatically in your application, or write the report to a text string by calling ToString().
Public Member Functions | |
| GeneratorReport () | |
Constructor & Destructor Documentation
|
inline |
For internal use: constructs a new GeneratorReport.
Member Data Documentation
| KyFloat32 Kaim::GeneratorReport::m_aggregateNavDataSeconds |
| KyUInt32 Kaim::GeneratorReport::m_clientInputLoadedCount |
The number of sectors for which LoadClientInput() was called.
| KyUInt32 Kaim::GeneratorReport::m_clientInputSavedCount |
The number of sectors for which SaveClientInput() was called.
| KyFloat32 Kaim::GeneratorReport::m_inputConsumptionSeconds |
The time taken to consume the input geometry, in seconds.
| KyFloat32 Kaim::GeneratorReport::m_loadInputTilesSeconds |
The time taken to load of InputTile files, in seconds. Relevant when runOptions.m_doEnableLimitedMemoryMode is true.
| KyUInt32 Kaim::GeneratorReport::m_navDataGeneratedCount |
The number of sectors for generated Regular NavData.
| KyFloat32 Kaim::GeneratorReport::m_navMeshFilteringSeconds |
The time taken to remove not reachable parts of the NavMesh, in seconds.
| KyUInt32 Kaim::GeneratorReport::m_patchSectorCount |
The number of patch sector.
| KyFloat32 Kaim::GeneratorReport::m_rawNavMeshGenerationSeconds |
The time taken to generate the RawNavMesh, in seconds. Does not include m_loadInputTilesSeconds.
| KyUInt32 Kaim::GeneratorReport::m_regularSectorCount |
The number of sector.
| KyUInt32 Kaim::GeneratorReport::m_sectorInputProduceCount |
The number of sectors for which ProduceInputs() was called.
| KyArray<GeneratorSectorReport> Kaim::GeneratorReport::m_sectorStatistics |
Maintains an array of objects that contain detailed statistics about the sectors for which NavData was generated.
Examples:
| KyFloat32 Kaim::GeneratorReport::m_tagVolumeIntegrationSeconds |
The time taken to integrate the generation TagVolumes, in seconds.
| KyFloat32 Kaim::GeneratorReport::m_totalGenerationSeconds |
The total time taken by the NavData generation process, in seconds.
The documentation for this class was generated from the following file:
- gwnavgeneration/generator/generatorreport.h