Kaim::GeneratorAdvancedParameters Class Reference
Related help topics: #include <generatoradvancedparameters.h>
Class Description
The GeneratorAdvancedParameters class is used by the GeneratorParameters class to maintain a set of configuration parameters that control detailed technical aspects of the NavData generation process.
Public Member Functions | |
| void | InitBlobFieldMapping (BlobFieldsMapping &mapping) |
| bool | operator!= (const GeneratorAdvancedParameters &other) const |
| bool | operator== (const GeneratorAdvancedParameters &other) const |
| void | SetDefaultValues () |
Member Function Documentation
| void Kaim::GeneratorAdvancedParameters::InitBlobFieldMapping | ( | BlobFieldsMapping & | mapping | ) |
For internal use.
|
inline |
- Returns
- true if at least one data value in this object does not match the value in the specified instance of GeneratorAdvancedParameters.
| bool Kaim::GeneratorAdvancedParameters::operator== | ( | const GeneratorAdvancedParameters & | other | ) | const |
- Returns
- true if all data values in this object match the values in the specified instance of GeneratorAdvancedParameters.
| void Kaim::GeneratorAdvancedParameters::SetDefaultValues | ( | ) |
Clears all information maintained by this object.
Member Data Documentation
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_altitudeToleranceSamplingStep |
This parameter determines the resolution used to sample the NavMesh and compare it to the original raster.
Lower values typically result in NavData with more triangles that matches the altitude of the original terrain mesh more closely, but may increase generation time.
Note that the sampling step is internally snapped to an integer value to make sure that m_altitudeToleranceSamplingStep is in fact a multiple of the original rasterization pixel size (see GeneratorParameters::m_rasterPrecision). Therefore, any value less than twice the pixel size will be clamped to the pixel size, values between 2.0f and 3.0f times the pixel size will be clamped to twice the pixel size, etc.
units: meters
default value: 0.30f
| bool Kaim::GeneratorAdvancedParameters::m_backFaceTrianglesWalkable |
Determines whether or not back-face triangles (i.e.
triangles whose points go in counter-clockwise order when seen from above) are flagged as non walkable
default value: true
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_distanceFromHoles |
The distance used to move the navMesh borders from the the holes, so that characters do not "fall" in the hole at runtime.
A negative value means that we used the half of #m_entityRadius for that (default behavior). If a non-negative value is set, it will be used. Unless m_forceNoErosionFromHoles is true, m_distanceFromHoles guarantees that the NavMesh border is at least m_distanceFromHoles.
units: meters
default value: -1.f
| bool Kaim::GeneratorAdvancedParameters::m_forceNoErosionFromHoles |
If set to true, the NavMesh will not be eroded from cliffs.
This means that the NavMesh will overhang the cliffs modifying m_distanceFromHoles behavior.
default value: false
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_inwardBorderTolerance |
Determines the tolerance used when simplifying the outlines of the navMesh.
This simplification reduces the number of triangles in the NavMesh (and thereby, reduces its memory size) by trimming off or smoothing over small irregularities along the border.
This parameter defines the 2d distance that the NavMesh border may be shifted toward the interior or exterior from the original border got from rasterization.
units: meters
default value: 0.4f
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_minNavigableSurface |
Sets the minimum surface area that any isolated area of NavMesh may occupy.
Any NavMesh with a total surface area smaller than this value is discarded Unless a SeedPoint was placed in this region. If you want to ignore seedpoints when performing surface filtering, consider using m_noiseReductionSurface.
units: square meters
default value: 10.0f
| KyUInt32 Kaim::GeneratorAdvancedParameters::m_navRasterDistanceMapMetric |
Determines the distance map metric that will be used to compute the navRaster from the rasterized geometry.
The metric is used to estimate the distance of every pixel from an obstacle or a hole. This metric has an influence on the overall quality and accuracy of the NavMesh, particularly at corners. -DISTANCE_MAP_MANHATTAN_METRIC uses standard Manhattan distance: http://en.wikipedia.org/wiki/Manhattan_distance which is a more accurate estimate than theDISTANCE_MAP_CHESSBOARD_METRIC but which tends to create some "Diamond" patterns around square obstacles. -DISTANCE_MAP_CHESSBOARD_METRIC (aka Chebychev) uses http://en.wikipedia.org/wiki/Chessboard_distance to estimate the distance. It is less accurate but creates more "regular" features (i.e. less triangles in the final NavMesh).
accepted values: An element from the NavRasterDistanceMapMetric enumeration.
default value: DISTANCE_MAP_MANHATTAN_METRIC
| KyUInt32 Kaim::GeneratorAdvancedParameters::m_navTagMinPixelArea |
This parameter is used for filtering noise that might appear when using NavTags.
In certain cases, small areas with heterogeneous NavTags can result in very small NavFloors of a few isolated pixels.
In order to avoid this side effect, a filtering is performed and areas smaller than m_navTagMinPixelArea that are isolated in the middle of different NavTag will be merged to that region. If 0, no filtering will be performed.
units: pixels
default value: 6 pixels
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_navTagRasterMergeTolerance |
Sets the vertical tolerance used to select the NavTag to be applied to a raster pixel.
When multiple triangles with different NavTags are merged into the same block in the raster, this parameter controls the vertical distance that is checked to determine the best NavTag to apply. If set to0.0f, the NavTag of the uppermost triangle is always selected. For any other positive value, the NavTag::operator< is used to determine the "Winning" NavTag among all the triangles that contribute to a pixel within the tolerance range. This parameter is used mostly to avoid Z-fighting where triangle with different NavTags overlap.
units: meters
default value: 0.1f
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_noiseReductionSurface |
Sets the minimum surface area that any isolated area of NavMesh may occupy to no be considered as noise and discarded during the generation process.
Seedpoints will be ignored when considering such surfaces.
If you want to explicitely keep some small isolated area by placing seedpoints, consider using m_minNavigableSurface instead.
units: square meters
default value: 0.1f
| KyFloat32 Kaim::GeneratorAdvancedParameters::m_superSmoothExtraTolerance |
This parameter can be used to get very clean (but also less precise) NavMesh.
This value is added to the radius during the erosion of the pixels and also to m_inwardBorderTolerance during the boundary simplification process.
units: meters
default value: 0.0f
The documentation for this class was generated from the following file:
- gwnavgeneration/generator/generatoradvancedparameters.h