Struct de_types::path::Path

pub struct Path {
    length: f32,
    waypoints: Vec<Vec2>,
}

A path on the map defined by a sequence of way points. Start and target position are included.

Fields

length: f32

waypoints: Vec<Vec2>

Implementations

impl Path

pub fn straight<P: Into<Vec2>>(from: P, to: P) -> Self

Creates a path on line from -> to.

pub fn new(length: f32, waypoints: Vec<Vec2>) -> Self

Creates a new path.

Panics

May panic if sum of distances of waypoints is not equal to provided length.

pub fn length(&self) -> f32

Returns the length of the path in meters.

pub fn waypoints(&self) -> &[Vec2]

Returns a sequence of the remaining path way points. The last way point corresponds to the start of the path and vice versa.

pub fn truncated(self, amount: f32) -> Option<Self>

Returns a path shortened by amount from the end. Returns None amount is longer than the path.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.