berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc(router/navmesh): document maybe_cw 

Doc Comment content taken from @mikolaj, Topola Matrix Chat.
This commit is contained in:
Alain Emilia Anna Zscheile 2024-12-13 15:23:46 +01:00
parent 07f5398ef0
commit 82bf647bc5
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/router/navmesh.rs
View File

@ -114,10 +114,18 @@ impl HasPosition for TrianvertexWeight {
} }
} }
/// The name "navvertex" is a shortening of "navigation vertex". /// The names "navvertex" and "navmesh vertex" are equivalent to "navigation vertex".
///
/// See the following blog post for more information and a visualization of the navmesh
/// during autorouting: <https://topola.dev/blog/2024/07/20/junejuly-2024-development-update/#advanced-debug-visualization>
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct NavvertexWeight { pub struct NavvertexWeight {
pub node: BinavvertexNodeIndex, pub node: BinavvertexNodeIndex,
/// There are two navvertices for each navigable node:
/// one is clockwise (`Some(true)`), the other counterclockwise (`Some(false)`).
/// The origin and destination nodes however have
/// only one corresponding navmesh vertex each (`None`).
pub maybe_cw: Option<bool>, pub maybe_cw: Option<bool>,
} }