Struct de_pathing::PathQueryProps

pub struct PathQueryProps {
    distance: f32,
    max_distance: f32,
}

Fields

distance: f32

max_distance: f32

Implementations

impl PathQueryProps

pub fn new(distance: f32, max_distance: f32) -> Self

Create new query properties. When possible, a path whose end is between distance and max_distance from the target will be searched for. Paths whose end is closer to the target are preferred.

Arguments

• distance - desired path finishes this distance from the target. If the target is already closer than distance an empty path is desired (rather than a path going away from the target).

• max_distance - when all points up to max_distance from the target are unreachable, it is desired that no path is found. This value must be equal or greater than distance.

Panics

• May panic if distance is not a finite non-negative number.

• May panic if max_distance is not a positive infinity or a finite non-negative number.

• May panic if distance is greater than max_distance.

pub fn exact() -> Self

Crate new query properties with both distance and max distance equal to 0. See Self::new.

pub fn distance(&self) -> f32

pub fn max_distance(&self) -> f32

Trait Implementations

impl Clone for PathQueryProps

fn clone(&self) -> PathQueryProps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PathQueryProps