Crate rerecast

Rust port of Recast, the industry-standard navigation mesh generator used by Unreal, Unity, Godot, and other game engines.

This crate contains low-level API. See the rerecast repo for instructions for high-level engine integrations

Structs

Aabb2d

A 2D axis-aligned bounding box

Aabb3d

A 3D axis-aligned bounding box

AreaType

An identifier for the area type of a span. The values 0 (AreaType::NOT_WALKABLE) and u8::MAX (AreaType::DEFAULT_WALKABLE) are reserved. The rest can be used for custom area types to e.g. assign different costs to different areas. When two spans are merged, the area type of the merged span is the maximum of the two area types.

BuildContoursFlags

Contour build flags used in CompactHeightfield::build_contours

CompactCell

Provides information on the content of a cell column in a CompactHeightfield.

CompactHeightfield

A compact, static heightfield representing unobstructed space.

CompactSpan

Represents a span of unobstructed space within a compact heightfield.

Config

Specifies a configuration to use when performing Recast builds. Usually built using ConfigBuilder.

ConfigBuilder

A builder for Config. The config has lots of interdependent configurations, so this builder provides a convenient way to set all the necessary parameters.

Contour

Represents a simple, non-overlapping contour in field space.

ContourSet

Represents a group of related contours. All contours within the set share the minimum bounds and cell sizes of the set.

ConvexVolume

A convex volume that marks an area within a CompactHeightfield as belonging to a specific AreaType through CompactHeightfield::mark_convex_poly_area.

DetailNavmesh

Contains triangle meshes that represent detailed height data associated with the polygons in its associated polygon mesh object.

Heightfield

A dynamic heightfield representing obstructed space.

HeightfieldBuilder

A builder for Heightfields.

PolygonNavmesh

Represents a polygon mesh suitable for use in building a navigation mesh.

RegionId

A region in a CompactHeightfield.

RegionVertexId

Flags used by Contour::vertices

Span

A span in the heightfield. This represents a single cell in a vertical column that is not occupied.

SpanKey

A key for a span in Spans.

Spans

A collection of spans.

SubMesh

A sub-mesh in DetailNavmesh::meshes

TriMesh

A mesh used as input for Heightfield rasterization.

Enums

HeightfieldBuilderError

Errors that can occur when building a Heightfield with HeightfieldBuilder::build.