Bevy Rerecast

https://docs.rs/bevy_rerecast/latest
Admin
Bevy Rerecast is a Rust port of the Recast navigation mesh generator, providing a Bevy game engine...
Tokens:63,842
Snippets:1,047
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Run Editor

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Commands to install and launch the standalone navmesh editor.

```bash
cargo install bevy_rerecast_editor
```

```bash
bevy_rerecast_editor
```

--------------------------------

### get(&self, key: K) -> Option<&V>

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=

Returns a reference to the value corresponding to the key.

```APIDOC
## pub fn get(&self, key: K) -> Option<&V>

### Description
Returns a reference to the value corresponding to the key.
```

--------------------------------

### Iterating and Inspecting Spans

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactHeightfield.html

Example demonstrating how to traverse the grid, calculate world-space coordinates, and inspect span neighbors.

```rust
// Where chf is an instance of a CompactHeightfield.

let cs = chf.cell_size;
let ch = chf.cell_height;

for z in 0..chf.height {
    for x in 0..chf.width {
        // Deriving the minimum corner of the grid location.
        let fx = chf.aabb.min.x + x as f32 * cs;
        let fz = chf.aabb.min.z + z as f32 * cs;
        println!("Corners: {fx},  {fz}");

        // Get the cell for the grid location then iterate
        // up the column.
        let c = chf.cell_at(x, z);
        for i in c.index_range() {
            let s = &chf.spans[i];

            // Deriving the minimum (floor) of the span.
            let fy = chf.aabb.min.y + (s.y + 1) as f32 * ch;
            println!("Span floor: {fy}");

            // Testing the area assignment of the span.
            if chf.areas[i] == AreaType::DEFAULT_WALKABLE {
                // The span is in the default 'walkable area'.
            } else if chf.areas[i] == AreaType::NOT_WALKABLE {
                // The surface is not considered walkable.
                // E.g. It was filtered out during the build processes.
            } else {
                // Do something. (Only applicable for custom build
                // build processes.)
            }

            // Iterating the connected axis-neighbor spans.
            for dir in 0..4 {
                if let Some(con) = s.con(dir) {
                    // There is a neighbor in this direction.
                    let (_nx, _ny, ni) = chf.con_indices(x as i32, z as i32, dir, con);
                    let ns = &chf.spans[ni];
                    // Do something with the neighbor span.
                    println!("Neighbor span: {ns:?}");
                }
            }
        }
    }
}
```

--------------------------------

### Polygon and neighbor data structure example

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.PolygonNavmesh.html

Illustrates how polygon indices and neighbor connections are represented within the mesh data.

```text
vertices_per_polygon = 6
For the entry:
- polygons: (1, 3, 4, 8, NO_INDEX, NO_INDEX)
- polygon_neighbors: (18, NO_CONNECTION , 21, NO_CONNECTION, NO_CONNECTION, NO_CONNECTION)

(1, 3, 4, 8) defines a polygon with 4 vertices.
Edge 1->3 is shared with polygon 18.
Edge 4->8 is shared with polygon 21.
Edges 3->4 and 4->8 are border edges not shared with any other polygon.
```

--------------------------------

### Iterate DetailNavmesh Triangles

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.DetailNavmesh.html

Example demonstrating how to iterate through sub-meshes and their associated triangles to access vertex data.

```rust
// Where dmesh is a DetailNavmesh

// Iterate the sub-meshes. (One for each source polygon.)
for mesh in &dmesh.meshes {
    let verts =
        &dmesh.vertices[mesh.base_vertex_index as usize..][..mesh.vertex_count as usize];
    let tris =
        &dmesh.triangles[mesh.base_triangle_index as usize..][..mesh.triangle_count as usize];

    // Iterate the sub-meshes. (One for each source polygon.)
    for mesh in &dmesh.meshes {
        let verts =
            &dmesh.vertices[mesh.base_vertex_index as usize..][..mesh.vertex_count as usize];
        let tris =
            &dmesh.triangles[mesh.base_triangle_index as usize..][..mesh.triangle_count as usize];

        // Iterate the sub-mesh's triangles.
        for tri in tris {
            let a = verts[tri[0] as usize];
            let b = verts[tri[1] as usize];
            let c = verts[tri[2] as usize];

            // Do something with the vertex.
            println!("Vertex A: {a}");
            println!("Vertex B: {b}");
            println!("Vertex C: {c}");
        }
    }
}
```

--------------------------------

### Iterating PolygonNavmesh Polygons

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.PolygonNavmesh.html

Example demonstrating how to iterate through polygons and their vertices, including converting grid-based coordinates to world space.

```rust
// Where mesh is a reference to a PolygonNavmesh.
let nvp = mesh.max_vertices_per_polygon as usize;
let cs = mesh.cell_size;
let ch = mesh.cell_height;
let orig = mesh.aabb.min;

for i in 0..mesh.polygon_count() {
    let p = &mesh.polygons[i * nvp..];

    // Iterate the vertices.
    for j in 0..nvp {
        if p[j] == PolygonNavmesh::NO_INDEX {
            // End of vertices.
            break;
        }

        if p[j + nvp] == PolygonNavmesh::NO_CONNECTION {
            // The edge beginning with this vertex is a solid border.
        } else {
            // The edge beginning with this vertex connects to
            // polygon p[j + nvp].
        }

        // Convert to world space.
        let v = &mesh.vertices[p[j] as usize];
        let world_vertex = Vec3 {
            x: orig.x + v.x as f32 * cs,
            y: orig.y + v.y as f32 * ch,
            z: orig.z + v.z as f32 * cs,
        };
        // Do something with the vertices.
        println!("Vertex: {world_vertex}");
    }
}
```

--------------------------------

### Convert ASCII Case

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.AreaType.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples of converting byte values to their ASCII uppercase or lowercase equivalents.

```rust
let lowercase_a = 97u8;

assert_eq!(65, lowercase_a.to_ascii_uppercase());
```

```rust
let uppercase_a = 65u8;

assert_eq!(97, uppercase_a.to_ascii_lowercase());
```

--------------------------------

### CompactSpan Height Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactSpan.html

Methods to get and set the height of the span.

```rust
pub fn height(&self) -> u8
```

```rust
pub fn set_height(&mut self, height: u8)
```

--------------------------------

### Iterate Heightfield spans

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Heightfield.html

Example demonstrating how to traverse the grid columns and iterate through the linked list of spans within each column.

```rust
// Where hf is a heightfield.

let orig = hf.aabb.min;
let cs = hf.cell_size;
let ch = hf.cell_height;

let w = hf.width as usize;
let h = hf.height as usize;

for z in 0..h {
    for x in 0..w {
        // Deriving the minimum corner of the grid location.
        let fx = orig.x + x as f32 * cs;
        let fz = orig.z + z as f32 * cs;
        // The base span in the column. (May be null.)
        let mut s_iter = hf.spans[x + z * w];
        while let Some(s) = s_iter {
            let s = &hf.allocated_spans[s];
            // Detriving the minium and maximum world position of the span.
            let fymin = orig[1] + s.min as f32 * ch;
            let fymax = orig[1] + s.max as f32 * ch;
            // Do other things with the span before moving up the column.
            s_iter = s.next;
        }
    }
}
```

--------------------------------

### Get value from SlotMap

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=std%3A%3Avec

Retrieves an immutable reference to a value by its key.

```rust
let mut sm = SlotMap::new();
let key = sm.insert("bar");
assert_eq!(sm.get(key), Some(&"bar"));
sm.remove(key);
assert_eq!(sm.get(key), None);
```

--------------------------------

### ConfigBuilder::build

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=u32+-%3E+bool

Constructs a new Config instance from the current builder state.

```APIDOC
## pub fn build(self) -> Config

### Description
Builds a `Config` object from the current configuration settings stored in the builder.

### Returns
- **Config** - The resulting configuration object.
```

--------------------------------

### Initialize Navmesh Plugins

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Register the core navigation mesh plugins within your Bevy application.

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(NavmeshPlugins::default());
```

--------------------------------

### ConfigBuilder::default

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html

Creates a new ConfigBuilder with default settings.

```APIDOC
### pub fn default() -> ConfigBuilder

Returns the default value for the ConfigBuilder.
```

--------------------------------

### Get value by key

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves a reference to the value associated with the given key.

```rust
let mut sm = SlotMap::new();
let key = sm.insert("bar");
assert_eq!(sm.get(key), Some(&"bar"));
sm.remove(key);
assert_eq!(sm.get(key), None);
```

--------------------------------

### field_at(index: usize)

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/struct.NavmeshSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets a reference to the value of the field with index `index` as a `&dyn PartialReflect`.

```APIDOC
## fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

### Description
Retrieves a reference to a struct field by its index.

### Parameters
- **index** (usize) - The index of the field to retrieve.
```

--------------------------------

### Configure Backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast

Add a backend plugin like Mesh3dBackendPlugin to translate scene entities into navmesh obstacles.

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;
use bevy_rerecast::Mesh3dBackendPlugin;

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(NavmeshPlugins::default())
    .add_plugins(Mesh3dBackendPlugin::default());
```

--------------------------------

### ConfigBuilder::build

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html

Consumes the builder and returns a configured Config instance.

```APIDOC
### pub fn build(self) -> Config

Builds a `Config` from the current configuration.
```

--------------------------------

### field(name: &str)

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/struct.NavmeshSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets a reference to the value of the field named `name` as a `&dyn PartialReflect`.

```APIDOC
## fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

### Description
Retrieves a reference to a struct field by its name.

### Parameters
- **name** (&str) - The name of the field to retrieve.
```

--------------------------------

### Get mutable reference by key

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves a mutable reference to the value associated with the given key.

```rust
let mut sm = SlotMap::new();
let key = sm.insert(3.5);
if let Some(x) = sm.get_mut(key) {
    *x += 3.0;
}
assert_eq!(sm[key], 6.5);
```

--------------------------------

### DetailNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html?search=

Creates a new instance of the DetailNavmeshGizmo component to visualize a specific navmesh.

```APIDOC
## pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo

### Description
Creates a new `DetailNavmeshGizmo` component. This component is used to visualize the specified navmesh once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset identifier for the navmesh to be visualized.
```

--------------------------------

### DetailNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html

Creates a new DetailNavmeshGizmo component to visualize a specific navmesh.

```APIDOC
## pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo

### Description
Creates a new `DetailNavmeshGizmo` visualizing the given navmesh once its done generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to visualize.
```

--------------------------------

### Get SlotMap capacity

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves the total number of elements the collection can hold without reallocating.

```rust
let sm: SlotMap<_, f64> = SlotMap::with_capacity(10);
assert_eq!(sm.capacity(), 10);
```

--------------------------------

### DetailNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html?search=std%3A%3Avec

Creates a new DetailNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo

### Description
Creates a new `DetailNavmeshGizmo` component that will visualize the specified `Navmesh` asset once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to be visualized.
```

--------------------------------

### DetailNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new DetailNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo

### Description
Creates a new `DetailNavmeshGizmo` visualizing the given navmesh once its done generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to visualize.
```

--------------------------------

### Observe Navmesh Readiness

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Handle the completion of asynchronous navmesh generation using an observer.

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;

fn on_navmesh_ready(trigger: On<NavmeshReady>, navmeshes: Res<Assets<Navmesh>>) {
    let asset_id = trigger.event().0;

    // We can now safely fetch the navmesh from our assets:
    let navmesh = navmeshes.get(asset_id).unwrap();
}
```

--------------------------------

### DetailNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html?search=u32+-%3E+bool

Creates a new DetailNavmeshGizmo component to visualize a navmesh once it has finished generating.

```APIDOC
## fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo

### Description
Creates a new `DetailNavmeshGizmo` component. This component is used to visualize a `DetailNavmesh` once the generation process is complete.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to be visualized.
```

--------------------------------

### Get value unchecked

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves a reference without performing version or bounds checks. Only safe if the key is known to exist.

```rust
let mut sm = SlotMap::new();
let key = sm.insert("bar");
assert_eq!(unsafe { sm.get_unchecked(key) }, &"bar");
sm.remove(key);
// sm.get_unchecked(key) is now dangerous!
```

--------------------------------

### Create a new DetailNavmeshGizmo

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.DetailNavmeshGizmo.html?search=u32+-%3E+bool

Constructor method for creating a new instance of the gizmo component.

```rust
pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> DetailNavmeshGizmo
```

--------------------------------

### CloneToUninit Implementation

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.SpanKey.html?search=

Experimental nightly API for performing copy-assignment to uninitialized memory.

```rust
impl<T> CloneToUninit for T
where T: Clone,
```

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Get disjoint mutable references

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves mutable references to multiple values simultaneously. All provided keys must be valid and distinct.

```rust
let mut sm = SlotMap::new();
let ka = sm.insert("butter");
let kb = sm.insert("apples");
let kc = sm.insert("charlie");
sm.remove(kc); // Make key c invalid.
assert_eq!(sm.get_disjoint_mut([ka, kb, kc]), None); // Has invalid key.
assert_eq!(sm.get_disjoint_mut([ka, ka]), None); // Not disjoint.
let [a, b] = sm.get_disjoint_mut([ka, kb]).unwrap();
std::mem::swap(a, b);
assert_eq!(sm[ka], "apples");
assert_eq!(sm[kb], "butter");
```

--------------------------------

### Test Triangle Flags

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.DetailNavmesh.html

Example of how to check if a specific edge in a triangle is an external edge using bitwise operations on the triangle flags.

```rust
if (((flags >> 2) & 0x3) != 0) { // Edge BC is an external edge. }
```

--------------------------------

### Register Navmesh Backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Add a backend plugin to translate Bevy scene entities into navmesh obstacles.

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;
use bevy_rerecast::Mesh3dBackendPlugin;

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(NavmeshPlugins::default())
    .add_plugins(Mesh3dBackendPlugin::default());
```

--------------------------------

### Configure Remote Editor Support

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Enable Bevy Remote Protocol (BRP) to allow the external editor to communicate with the running game.

```rust
use bevy::prelude::*;
use bevy::remote::{RemotePlugin, http::RemoteHttpPlugin};
use bevy_rerecast::prelude::*;
use bevy_rerecast::Mesh3dBackendPlugin;

App::new()
    .add_plugins(DefaultPlugins)
    // Enable BRP
    .add_plugins((RemotePlugin::default(), RemoteHttpPlugin::default()))
    // Enable Rerecast
    .add_plugins(NavmeshPlugins::default())
    // Also add some backend, for example the `Mesh3dBackendPlugin`
    .add_plugins(Mesh3dBackendPlugin::default());
```

--------------------------------

### Get disjoint mutable references unchecked

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=std%3A%3Avec

Retrieves multiple mutable references without safety checks. Keys must be valid and disjoint.

```rust
let mut sm = SlotMap::new();
let ka = sm.insert("butter");
let kb = sm.insert("apples");
let [a, b] = unsafe { sm.get_disjoint_unchecked_mut([ka, kb]) };
std::mem::swap(a, b);
assert_eq!(sm[ka], "apples");
assert_eq!(sm[kb], "butter");
```

--------------------------------

### Get disjoint mutable references

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Access multiple mutable references simultaneously. Ensure all keys are valid and distinct to avoid undefined behavior.

```rust
let mut sm = SlotMap::new();
let ka = sm.insert("butter");
let kb = sm.insert("apples");
let [a, b] = unsafe { sm.get_disjoint_unchecked_mut([ka, kb]) };
std::mem::swap(a, b);
assert_eq!(sm[ka], "apples");
assert_eq!(sm[kb], "butter");
```

--------------------------------

### ConfigBuilder::build

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=

Constructs a Config object from the current state of the builder.

```APIDOC
## pub fn build(self) -> Config

### Description
Builds a `Config` instance from the current configuration settings stored in the builder.

### Signature
`pub fn build(self) -> Config`
```

--------------------------------

### Get mutable reference unchecked

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html

Retrieves a mutable reference without performing version or bounds checks. Only safe if the key is known to exist.

```rust
let mut sm = SlotMap::new();
let key = sm.insert("foo");
unsafe { *sm.get_unchecked_mut(key) = "bar" };
assert_eq!(sm[key], "bar");
sm.remove(key);
// sm.get_unchecked_mut(key) is now dangerous!
```

--------------------------------

### Bundle Creation

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.NavmeshGizmoConfig.html?search=

Unsafe method to create a bundle from components.

```rust
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>, C: Sized,
```

--------------------------------

### NavmeshApp::set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html?search=std%3A%3Avec

Trait extension for registering a physics backend to the Bevy App.

```APIDOC
## NavmeshApp::set_navmesh_backend

### Description
This trait extension allows for the registration of a specific physics backend (such as the Avian backend) to the Bevy `App`, ensuring the navmesh generator uses the correct collision geometry.

### Usage
```rust
use avian_rerecast::prelude::*;

App::new()
    .add_plugins(AvianBackendPlugin::default());
```
```

--------------------------------

### Observe Navmesh Readiness

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast

Handle the NavmeshReady trigger to access the generated navmesh asset.

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;

fn on_navmesh_ready(trigger: On<NavmeshReady>, navmeshes: Res<Assets<Navmesh>>) {
    let asset_id = trigger.event().0;

    // We can now safely fetch the navmesh from our assets:
    let navmesh = navmeshes.get(asset_id).unwrap();
}
```

--------------------------------

### generate

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshGenerator.html?search=std%3A%3Avec

Queues a new navmesh generation task. The generation occurs asynchronously, and obstacles present in the current PostUpdate frame are utilized.

```APIDOC
## pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>

### Description
Queue a navmesh generation task. When you call this method, a new navmesh will be generated asynchronously. Calling it multiple times will queue multiple navmeshes to be generated. Obstacles existing this frame at `PostUpdate` will be used to generate the navmesh.

### Parameters
- **settings** (NavmeshSettings) - The configuration settings for the navmesh generation.

### Returns
- **Handle<Navmesh>** - A handle to the navmesh being generated.
```

--------------------------------

### Template::build_template

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactCell.html?search=std%3A%3Avec

Uses a template and context to produce an output value.

```APIDOC
### fn build_template(&self, _context: &mut TemplateContext<'_, '_>) -> Result<<T as Template>::Output, BevyError>

Uses this template and the given entity context to produce a `Template::Output`.
```

--------------------------------

### NavmeshSettings::from_agent_3d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html?search=std%3A%3Avec

Creates a new NavmeshSettings instance configured for a 3D agent using the specified radius and height.

```APIDOC
### pub fn from_agent_3d(radius: f32, height: f32) -> NavmeshSettings

Creates a new `NavmeshSettings` instance from a 3D agent’s radius and height.
```

--------------------------------

### NavmeshSettings::from_agent_3d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html

Creates a new NavmeshSettings instance configured for a 3D agent using the specified radius and height.

```APIDOC
## pub fn from_agent_3d(radius: f32, height: f32) -> NavmeshSettings

### Description
Creates a new `NavmeshSettings` instance from a 3D agent’s radius and height.

### Parameters
- **radius** (f32) - The radius of the agent.
- **height** (f32) - The height of the agent.
```

--------------------------------

### NavmeshSettings::from_agent_3d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new NavmeshSettings instance configured for a 3D agent using the specified radius and height.

```APIDOC
## fn from_agent_3d(radius: f32, height: f32) -> NavmeshSettings

### Description
Creates a new `NavmeshSettings` instance from a 3D agent’s radius and height.

### Parameters
- **radius** (f32) - The radius of the agent.
- **height** (f32) - The height of the agent.

### Returns
- **NavmeshSettings** - A configured instance of NavmeshSettings.
```

--------------------------------

### into_compact

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Heightfield.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Builds a compact heightfield from the current heightfield instance.

```APIDOC
### pub fn into_compact(self, walkable_height: u16, walkable_climb: u16) -> Result<CompactHeightfield, CompactHeightfieldError>

Builds a compact heightfield from a heightfield. Returns an error if the heightfield has too many layers.
```

--------------------------------

### Enable Remote Editor

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast

Configure Bevy's remote plugins to allow communication with the external navmesh editor.

```rust
use bevy::prelude::*;
use bevy::remote::{RemotePlugin, http::RemoteHttpPlugin};
use bevy_rerecast::prelude::*;
use bevy_rerecast::Mesh3dBackendPlugin;

App::new()
    .add_plugins(DefaultPlugins)
    // Enable BRP
    .add_plugins((RemotePlugin::default(), RemoteHttpPlugin::default()))
    // Enable Rerecast
    .add_plugins(NavmeshPlugins::default())
    // Also add some backend, for example the `Mesh3dBackendPlugin`
    .add_plugins(Mesh3dBackendPlugin::default());
```

--------------------------------

### Create a new PolygonNavmeshGizmo

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html

Constructor for creating a new instance of the gizmo component.

```rust
pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/trait._.html

Sets the backend system for generating navmesh obstacles. This method replaces any existing backend and requires a system that takes NavmeshSettings as input and returns a TriMesh.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. Only one backend can be set at a time, and calling this will replace any existing backend.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) - Required - A Bevy system that accepts NavmeshSettings as input and returns a TriMesh representing the geometry for all obstacles in the scene.

### Returns
- **&mut App** - Returns a mutable reference to the App instance for method chaining.
```

--------------------------------

### ConfigBuilder::default

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=u32+-%3E+bool

Creates a new ConfigBuilder with default values.

```APIDOC
## pub fn default() -> ConfigBuilder

### Description
Returns the default value for the `ConfigBuilder` type.

### Returns
- **ConfigBuilder** - A new instance initialized with default settings.
```

--------------------------------

### ConfigBuilder::default

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ConfigBuilder with default values.

```APIDOC
## pub fn default() -> ConfigBuilder

### Description
Returns the default value for the `ConfigBuilder` type.
```

--------------------------------

### Integrate Avian Physics Backend

Source: https://docs.rs/bevy_rerecast/latest/src/bevy_rerecast/lib.rs.html?search=std%3A%3Avec

Add the Avian backend crate and register the plugin to use physics colliders for navmesh generation.

```bash
cargo add avian_rerecast
```

```rust
use bevy::prelude::*;
use bevy_rerecast::prelude::*;
use avian_rerecast::prelude::*;

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(NavmeshPlugins::default())
    .add_plugins(AvianBackendPlugin::default());
```

--------------------------------

### ConfigBuilder::build

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=std%3A%3Avec

Consumes the builder to produce a final Config instance.

```APIDOC
## pub fn build(self) -> Config

### Description
Builds a `Config` from the current configuration state held by the builder.

### Returns
- **Config** - The constructed configuration object.
```

--------------------------------

### ConfigBuilder::build

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Consumes the builder to produce a final Config instance.

```APIDOC
## pub fn build(self) -> Config

### Description
Builds a `Config` from the current configuration settings stored in the builder.

### Returns
- **Config** - The constructed configuration object.
```

--------------------------------

### ConfigBuilder::default

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=

Creates a new instance of ConfigBuilder with default values.

```APIDOC
## pub fn default() -> ConfigBuilder

### Description
Returns the default value for the `ConfigBuilder` type.

### Signature
`pub fn default() -> ConfigBuilder`
```

--------------------------------

### PolygonNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html?search=u32+-%3E+bool

Creates a new instance of the PolygonNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo

### Description
Creates a new `PolygonNavmeshGizmo` component. This component, when added to an entity, will visualize the specified `Navmesh` asset once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset identifier or handle for the navmesh to be visualized.
```

--------------------------------

### PolygonNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of the PolygonNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo

### Description
Creates a new `PolygonNavmeshGizmo` component that will visualize the specified `Navmesh` asset once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID or handle of the navmesh to be visualized.
```

--------------------------------

### PolygonNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html?search=std%3A%3Avec

Creates a new instance of the PolygonNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo

### Description
Creates a new `PolygonNavmeshGizmo` component. This component is used to visualize the specified `Navmesh` asset once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to be visualized.
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/trait._.html?search=

Sets the backend system for generating navmesh obstacles. The provided system must accept NavmeshSettings as input and return a TriMesh representing the scene geometry.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. Only one backend can be set at a time, and calling this will replace any existing backend. The backend system is expected to return a single TriMesh containing the geometry for all obstacles in the scene in global units.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) - Required - A Bevy system that takes NavmeshSettings as input and returns a TriMesh.

### Returns
- **&mut App** - Returns a mutable reference to the App instance for method chaining.
```

--------------------------------

### generate

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/generator/struct.NavmeshGenerator.html?search=std%3A%3Avec

Queues a new navmesh generation task asynchronously. Obstacles present in the current frame at PostUpdate are utilized for the generation process.

```APIDOC
## pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>

### Description
Queues a navmesh generation task. When you call this method, a new navmesh will be generated asynchronously. Calling it multiple times will queue multiple navmeshes to be generated. Obstacles existing this frame at `PostUpdate` will be used to generate the navmesh.

### Parameters
- **settings** (NavmeshSettings) - Required - The configuration settings for the navmesh generation.

### Returns
- **Handle<Navmesh>** - A handle to the navmesh being generated.
```

--------------------------------

### generate

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/generator/struct.NavmeshGenerator.html?search=

Queues a new navmesh generation task asynchronously. Obstacles present in the current frame at PostUpdate are used for generation.

```APIDOC
## pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>

### Description
Queue a navmesh generation task. When you call this method, a new navmesh will be generated asynchronously. Calling it multiple times will queue multiple navmeshes to be generated. Obstacles existing this frame at `PostUpdate` will be used to generate the navmesh.

### Parameters
- **settings** (NavmeshSettings) - Required - The configuration settings for the navmesh generation.
```

--------------------------------

### generate

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshGenerator.html?search=

Queues a new navmesh generation task asynchronously. Obstacles present in the current frame at PostUpdate are used for generation.

```APIDOC
## pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>

### Description
Queue a navmesh generation task. When you call this method, a new navmesh will be generated asynchronously. Calling it multiple times will queue multiple navmeshes to be generated. Obstacles existing this frame at `PostUpdate` will be used to generate the navmesh.

### Parameters
- **settings** (NavmeshSettings) - The configuration settings for the navmesh generation.
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/trait._.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Sets the backend system for generating navmesh obstacles. This method replaces any existing backend and expects a system that returns a TriMesh.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. Only one backend can be set at a time. Setting a backend will replace any existing backend. By default, no backend is set.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) - Required - A system that takes NavmeshSettings as input and returns a TriMesh representing the geometry for all obstacles in the scene.

### Returns
- **&mut App** - Returns a mutable reference to the App instance for method chaining.
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/trait._.html?search=u32+-%3E+bool

Sets the backend system for generating navmesh obstacles. This method replaces any existing backend and expects a system that returns a TriMesh.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. Only one backend can be set at a time, and calling this will replace any existing backend.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M>) - Required - A system that takes NavmeshSettings as input and returns a TriMesh representing the geometry for all obstacles in the scene.

### Returns
- **&mut App** - Returns a mutable reference to the App instance for method chaining.
```

--------------------------------

### NavmeshSettings::from_agent_2d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html

Creates a new NavmeshSettings instance configured for a 2D agent using the specified radius and height.

```APIDOC
## pub fn from_agent_2d(radius: f32, height: f32) -> NavmeshSettings

### Description
Creates a new `NavmeshSettings` instance from a 2D agent’s radius and height.

### Parameters
- **radius** (f32) - The radius of the agent.
- **height** (f32) - The height of the agent.
```

--------------------------------

### NavmeshSettings::from_agent_2d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new NavmeshSettings instance configured for a 2D agent using the specified radius and height.

```APIDOC
## fn from_agent_2d(radius: f32, height: f32) -> NavmeshSettings

### Description
Creates a new `NavmeshSettings` instance from a 2D agent’s radius and height.

### Parameters
- **radius** (f32) - The radius of the agent.
- **height** (f32) - The height of the agent.

### Returns
- **NavmeshSettings** - A configured instance of NavmeshSettings.
```

--------------------------------

### NavmeshSettings::from_agent_2d

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/struct.NavmeshSettings.html?search=std%3A%3Avec

Creates a new NavmeshSettings instance configured for a 2D agent using the specified radius and height.

```APIDOC
### pub fn from_agent_2d(radius: f32, height: f32) -> NavmeshSettings

Creates a new `NavmeshSettings` instance from a 2D agent’s radius and height.
```

--------------------------------

### generate

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/generator/struct.NavmeshGenerator.html

Queues a new navmesh generation task asynchronously. Obstacles present in the current frame at PostUpdate are used for the generation.

```APIDOC
## pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>

### Description
Queue a navmesh generation task. When you call this method, a new navmesh will be generated asynchronously. Calling it multiple times will queue multiple navmeshes to be generated.

### Parameters
- **settings** (NavmeshSettings) - The configuration settings for the navmesh generation.

### Returns
- **Handle<Navmesh>** - A handle to the navmesh being generated.
```

--------------------------------

### into_compact

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Heightfield.html?search=u32+-%3E+bool

Builds a compact heightfield from a heightfield.

```APIDOC
## pub fn into_compact(self, walkable_height: u16, walkable_climb: u16) -> Result<CompactHeightfield, CompactHeightfieldError>

### Description
Builds a compact heightfield from a heightfield.

### Errors
Returns an error if the heightfield has too many layers.
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/prelude/trait._.html?search=std%3A%3Avec

Sets the backend for generating navmesh obstacles. Only one backend can be set at a time, and setting a new one will replace any existing backend.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. The provided system is expected to return a single `TriMesh` containing the geometry for all obstacles in the scene in global units.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) - Required - The system responsible for generating the navmesh geometry.

### Returns
- **&mut App** - Returns a mutable reference to the App instance for method chaining.
```

--------------------------------

### Template::build_template

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=

Uses the template and the provided TemplateContext to produce an output value.

```APIDOC
## fn build_template(&self, _context: &mut TemplateContext<'_, '_>) -> Result<<T as Template>::Output, BevyError>

### Description
Uses this template and the given entity context to produce a Template::Output.

### Parameters
- **_context** (TemplateContext) - Required - The context used to build the template.
```

--------------------------------

### PolygonNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html

Creates a new PolygonNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo

### Description
Creates a new `PolygonNavmeshGizmo` component. This component is used to visualize the specified `Navmesh` asset once it has finished generating.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to be visualized.
```

--------------------------------

### PolygonNavmeshGizmo::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/debug/struct.PolygonNavmeshGizmo.html?search=

Creates a new PolygonNavmeshGizmo component to visualize a specific navmesh asset.

```APIDOC
## pub fn new(navmesh: impl Into<AssetId<Navmesh>>) -> PolygonNavmeshGizmo

### Description
Creates a new `PolygonNavmeshGizmo` visualizing the given navmesh once its generation is complete.

### Parameters
- **navmesh** (impl Into<AssetId<Navmesh>>) - Required - The asset ID of the navmesh to visualize.
```

--------------------------------

### Aabb3d::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Aabb3d.html?search=u32+-%3E+bool

Constructs a new Aabb3d instance from a center point and half-size dimensions.

```APIDOC
## pub fn new(center: impl Into<Vec3>, half_size: impl Into<Vec3>) -> Aabb3d

### Description
Constructs an AABB from its center and half-size.

### Parameters
- **center** (impl Into<Vec3>) - Required - The center point of the AABB.
- **half_size** (impl Into<Vec3>) - Required - The half-size dimensions of the AABB.

### Returns
- **Aabb3d** - A new instance of the Aabb3d struct.
```

--------------------------------

### Aabb3d::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Aabb3d.html?search=std%3A%3Avec

Constructs a new Aabb3d instance from a center point and half-size dimensions.

```APIDOC
## pub fn new(center: impl Into<Vec3>, half_size: impl Into<Vec3>) -> Aabb3d

### Description
Constructs an AABB from its center and half-size.

### Parameters
- **center** (impl Into<Vec3>) - The center point of the bounding box.
- **half_size** (impl Into<Vec3>) - The half-extent of the bounding box along each axis.

### Returns
- **Aabb3d** - A new instance of the Aabb3d struct.
```

--------------------------------

### CompactCell Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactCell.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods available for interacting with a CompactCell instance.

```APIDOC
## pub fn index(&self) -> u32
Returns the index of the first span in the column.

## pub fn count(&self) -> u8
Returns the number of spans in the column.

## pub fn set_index(&mut self, index: u32)
Sets the index of the first span in the column.

## pub fn set_count(&mut self, count: u8)
Sets the number of spans in the column.

## pub fn inc_count(&mut self)
Increments the number of spans in the column by 1.

## pub fn index_range(&self) -> Range<usize>
Returns a range over the indices of spans in the cell column.
```

--------------------------------

### Navmesh Generation Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/generator/struct.NavmeshGenerator.html?search=u32+-%3E+bool

Methods for queuing navmesh generation and regeneration tasks.

```rust
pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>
```

```rust
pub fn regenerate( &mut self, id: &Handle<Navmesh>, settings: NavmeshSettings, ) -> bool
```

--------------------------------

### Aabb3d::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Aabb3d.html?search=

Constructs a new Aabb3d instance using a center point and half-size dimensions.

```APIDOC
## Aabb3d::new(center, half_size)

### Description
Constructs an AABB from its center and half-size.

### Parameters
- **center** (impl Into<Vec3>) - The center point of the box.
- **half_size** (impl Into<Vec3>) - The half-size dimensions of the box.

### Returns
- **Aabb3d** - A new instance of the Aabb3d struct.
```

--------------------------------

### Aabb3d::new

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Aabb3d.html

Constructs a new Aabb3d instance using a center point and the half-size dimensions.

```APIDOC
## Aabb3d::new(center, half_size)

### Description
Constructs an AABB from its center and half-size.

### Parameters
- **center** (impl Into<Vec3>) - The center point of the bounding box.
- **half_size** (impl Into<Vec3>) - The half-extent dimensions of the bounding box.

### Returns
- **Aabb3d** - A new instance of the Aabb3d struct.
```

--------------------------------

### CompactSpan Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactSpan.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for managing neighbor connections and span height within a CompactSpan.

```rust
pub fn set_con(&mut self, direction: u8, neighbor: impl Into<Option<u8>>)
```

```rust
pub fn con(&self, direction: u8) -> Option<u8>
```

```rust
pub fn height(&self) -> u8
```

```rust
pub fn set_height(&mut self, height: u8)
```

--------------------------------

### Type Information Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.ConfigBuilder.html?search=std%3A%3Avec

Methods for retrieving type path, module information, and compile-time type info.

```APIDOC
## type_path() -> &'static str

### Description
Returns the fully qualified path of the underlying type.

## short_type_path() -> &'static str

### Description
Returns a short, pretty-print enabled path to the type.

## type_info() -> &'static TypeInfo

### Description
Returns the compile-time info for the underlying type.
```

--------------------------------

### set_navmesh_backend

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/trait.NavmeshApp.html?search=

Sets the backend for generating navmesh obstacles. This method replaces any existing backend and expects a system that returns a TriMesh representing the scene's obstacle geometry.

```APIDOC
## fn set_navmesh_backend<M>(&mut self, system: impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) -> &mut App

### Description
Sets the backend for generating navmesh obstacles. Only one backend can be set at a time, and calling this will replace any existing backend. The provided system must return a `TriMesh` containing the geometry for all obstacles in the scene in global units.

### Parameters
- **system** (impl IntoSystem<In<NavmeshSettings>, TriMesh, M> + 'static) - Required - A Bevy system that takes `NavmeshSettings` as input and returns a `TriMesh`.

### Returns
- **&mut App** - Returns a mutable reference to the `App` instance for method chaining.
```

--------------------------------

### CompactSpan Neighbor Connection Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactSpan.html

Methods to set and retrieve neighbor connection data for a specific direction.

```rust
pub fn set_con(&mut self, direction: u8, neighbor: impl Into<Option<u8>>)
```

```rust
pub fn con(&self, direction: u8) -> Option<u8>
```

--------------------------------

### pub fn keys(&self) -> Keys<'_, K, V>

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=

Returns an iterator visiting all keys in an arbitrary order.

```APIDOC
## pub fn keys(&self) -> Keys<'_, K, V>

### Description
Returns an iterator visiting all keys in an arbitrary order. The iterator element type is K.
```

--------------------------------

### pub fn keys(&self) -> Keys<'_, K, V>

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.Spans.html?search=u32+-%3E+bool

Returns an iterator visiting all keys in an arbitrary order.

```APIDOC
## pub fn keys(&self) -> Keys<'_, K, V>

### Description
An iterator visiting all keys in an arbitrary order. The iterator element type is `K`.
```

--------------------------------

### Add bevy_rerecast dependency

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/index.html

Add the crate to your project using cargo.

```bash
cargo add bevy_rerecast
```

--------------------------------

### CompactSpan Methods

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/rerecast/struct.CompactSpan.html?search=std%3A%3Avec

Methods available for interacting with a CompactSpan instance to manage neighbor connections and height data.

```APIDOC
## pub fn set_con(&mut self, direction: u8, neighbor: impl Into<Option<u8>>)

### Description
Sets the neighbor connection data for the given direction. If the neighbor is not connected, pass None.

## pub fn con(&self, direction: u8) -> Option<u8>

### Description
Returns the neighbor connection data for the specified direction. Returns None if no connection exists.

## pub fn height(&self) -> u8

### Description
Returns the height of the span.

## pub fn set_height(&mut self, height: u8)

### Description
Sets the height of the span.
```

--------------------------------

### Generate Navmesh

Source: https://docs.rs/bevy_rerecast/latest/bevy_rerecast/generator/struct.NavmeshGenerator.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Queues a new navmesh generation task asynchronously using the provided settings.

```rust
pub fn generate(&mut self, settings: NavmeshSettings) -> Handle<Navmesh>
```
Tokens:
Raw