Skip to content

Add documentation for #187 #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bulba03 wants to merge 1 commit into from
Closed

Add documentation for #187 #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions crates/bevy_landmass/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ Note the `Archipelago` can be created later, even if the agents/islands already
have an `ArchipelagoRef` to it. Agents/islands will be added once the
`Archipelago` exists.

## ⚠️ Important: Mesh Orientation and Normals

When converting a mesh to a `NavigationMesh`, **ensure that**:
- The mesh is defined in **clockwise** vertex order.
- Normals are facing **inward** (towards the interior of the mesh).

#### Why does this matter?
- Most 3D editors default to **counter-clockwise** mesh orientation (normals facing outward).
- Incorrect orientation can cause navigation algorithms to fail (e.g., agents may get stuck or choose invalid paths).

#### How to Check/Fix Orientation?
- **Blender**: Enable normal display (`Overlay -> Normals`). Red normals indicate inward-facing direction.
## Example

```rust
Expand Down
4 changes: 4 additions & 0 deletions crates/bevy_landmass/src/nav_mesh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ pub enum ConvertMeshError {
/// Converts a Bevy Mesh to a landmass NavigationMesh. This is done naively -
/// each triangle forms a single polygon in the navigation mesh, which can cause
/// strange paths to form (agents may take turns inside if wide open regions).
///
/// ## Note: The input mesh must be in **clockwise** orientation,
/// ## with normals facing **inward** (towards the interior of the mesh).
///
/// This function is provided as a convenience, and a better method for
/// generating navigation meshes should be used.
pub fn bevy_mesh_to_landmass_nav_mesh<CS: CoordinateSystem>(
Expand Down