gnxlxnxx/dubins_path
1
0
Fork 0
mirror of https://github.com/gnxlxnxx/dubins_path synced 2026-07-27 15:13:02 +02:00
Code Issues Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
gnxlxnxx
2020-06-23 20:35:14 +02:00
parent 666ff6748a
commit 5e63a6f586
1 changed files with 1 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib.rs
+1 -30
View File
@@ -1,40 +1,11 @@
//! This Crate calculates Dubins Paths //! This Crate calculates Dubins Paths
//! //!
//!
//! eg rsr path:
//!
//! -----
//! /- \
//! /-/ \
//! /-- / \
//! /- | |
//! /-- | |
//! /- | |
//! /-- \ /
//! /- \ X goal
//! /-- \ /
//! /- -----
//! /--
//! /-
//! -----
//! / \
//! / \
//! / \
//! | |
//! start X |
//! | |
//! \ /
//! \ /
//! \ /
//! -----
//!
//!
//! The start point is (0,0) facing in positive y-direction //! The start point is (0,0) facing in positive y-direction
//! //!
//! The arguments to get a path are //! The arguments to get a path are
//! //!
//! - radius: the minimum radius you can drive or respectively the radius you want to drive (f64) //! - radius: the minimum radius you can drive or respectively the radius you want to drive (f64)
//! - end_point: the point you want to end up (Point) //! - end_point: the point you want to end up at (Point)
//! - end_angle: the angle you want to have in the end (Angle) //! - end_angle: the angle you want to have in the end (Angle)
//! //!
//! The paths can be categorized into two subsections: //! The paths can be categorized into two subsections: