From 82bf647bc533c02c10f32dd3a975af67ed2063e7 Mon Sep 17 00:00:00 2001 From: Alain Emilia Anna Zscheile Date: Fri, 13 Dec 2024 15:23:46 +0100 Subject: [PATCH] doc(router/navmesh): document maybe_cw Doc Comment content taken from @mikolaj, Topola Matrix Chat. --- src/router/navmesh.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/router/navmesh.rs b/src/router/navmesh.rs index 29a1714..33e651d 100644 --- a/src/router/navmesh.rs +++ b/src/router/navmesh.rs @@ -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: #[derive(Debug, Clone)] pub struct NavvertexWeight { 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, }