Struct de_pathing::path::ScheduledPath

pub struct ScheduledPath {
    path: Path,
    current: usize,
}

A path on the map which may be followed by an object or a group of objects.

Fields

path: Path

current: usize

Implementations

impl ScheduledPath

pub(crate) fn new(path: Path) -> Self

Creates a new path schedule.

Panics

May panic if path has less than two points.

pub fn destination(&self) -> Vec2

Returns the final point of the path schedule.

pub fn advance(&mut self, position: Vec2, amount: f32) -> Vec2

Advances the path schedule by a given distance and returns the corresponding point on the path.

Arguments

• position - position of the object(s) tracking this path. It is used as a base for the path advancement.

• amount - advancement distance in meters. The advancement is computed in the mode which tries to keep the object withing amount meters from the scheduled path.

  Advancement along current path line segment is multiplied by a factor larger than one.

fn projection(&self, position: Vec2) -> (Vec2, f32)

Returns a point and segment fraction on current segment of the path closest to a given position.

This method cannot be called if only one (last) point remains to be reached.

Panics

Panics if it is called when only last point remains.

Trait Implementations

impl Component for ScheduledPath

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].