Struct NavigationMeshBuildSettings

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

Inherited Members

ValueType.ToString()

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

float

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

float

DetailSamplingDistance

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

[DataMemberRange(1, 3)]
public float DetailSamplingDistance

Field Value

float

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

float

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

float

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

float

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

int

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

int

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

int

Methods

Equals(NavigationMeshBuildSettings)

public bool Equals(NavigationMeshBuildSettings other)

Parameters

other NavigationMeshBuildSettings

Returns

bool

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.