NavigationMeshBuildSettings Struct

    Namespace: Stride.Navigation
    Assembly: Stride.Navigation.dll

    Provides settings for the navigation mesh builder to control granularity and error margins 

    [DataContract]
[ObjectFactory(typeof(NavigationBuildSettingsFactory))]
public struct NavigationMeshBuildSettings
    Name Description
    Fields
    CellHeight

    The Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the vertical axis but longer build times
    CellSize

    The Width/Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the horizontal axes but longer build times
    DetailSamplingDistance

    Sets the sampling distance to use when generating the detail mesh. (For height detail only.)
    MaxDetailSamplingError

    The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.)
    MaxEdgeError

    The maximum distance a simplfied contour's border edges should deviate from the original raw contour.
    MaxEdgeLen

    The maximum allowed length for contour edges along the border of the mesh.
    MinRegionArea

    The minimum number of cells allowed to form isolated island areas
    RegionMergeArea

    Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
    TileSize

    Tile size used for Navigation mesh tiles, the final size of a tile is CellSize*TileSize
    Methods
    Equals(NavigationMeshBuildSettings)
    Equals(Object)
    GetHashCode()
    | Improve this Doc View Source

    Fields

    CellHeight

    The Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the vertical axis but longer build times

    [DataMemberRange(0.01, 4)]
public float CellHeight
    Field Value
    Type Description
    System.Single

    CellSize

    The Width/Height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the horizontal axes but longer build times

    [DataMemberRange(0.01, 4)]
public float CellSize
    Field Value
    Type Description
    System.Single

    DetailSamplingDistance

    Sets the sampling distance to use when generating the detail mesh. (For height detail only.)

    [DataMemberRange(1, 3)]
public float DetailSamplingDistance
    Field Value
    Type Description
    System.Single

    MaxDetailSamplingError

    The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.)

    [Display("Maximum Detail Sampling Error", null)]
[DataMemberRange(0, 3)]
public float MaxDetailSamplingError
    Field Value
    Type Description
    System.Single

    MaxEdgeError

    The maximum distance a simplfied contour's border edges should deviate from the original raw contour.

    [Display("Maximum Edge Error", null)]
[DataMemberRange(0.1, 4)]
public float MaxEdgeError
    Field Value
    Type Description
    System.Single

    MaxEdgeLen

    The maximum allowed length for contour edges along the border of the mesh.

    [Display("Maximum Edge Length", null)]
[DataMemberRange(0, 0)]
public float MaxEdgeLen
    Field Value
    Type Description
    System.Single

    MinRegionArea

    The minimum number of cells allowed to form isolated island areas

    [Display("Minimum Region Area", null)]
[DataMemberRange(0, 0)]
public int MinRegionArea
    Field Value
    Type Description
    System.Int32

    RegionMergeArea

    Any regions with a span count smaller than this value will, if possible, be merged with larger regions.

    [DataMemberRange(0, 0)]
public int RegionMergeArea
    Field Value
    Type Description
    System.Int32

    TileSize

    Tile size used for Navigation mesh tiles, the final size of a tile is CellSize*TileSize

    [DataMemberRange(8, 4096, 1, 8, 0)]
public int TileSize
    Field Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Methods

    Equals(NavigationMeshBuildSettings)

    public bool Equals(NavigationMeshBuildSettings other)
    Parameters
    Type Name Description
    NavigationMeshBuildSettings other
    Returns
    Type Description
    System.Boolean

    Equals(Object)

    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    GetHashCode()

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    Inherited Members

    System.ValueType.ToString()

    Extension Methods