Skip to main content

GoalDistance

Struct GoalDistance 

Source
pub struct GoalDistance<K> { /* private fields */ }
Expand description

How far a piece would walk from a tile to the nearest of some goals, with one flow_field per movement kind K, built on first use and kept. Stepping onto a goal’s own tile is free and always allowed: a goal is often a tile another piece stands on.

Implementations§

Source§

impl<K: Ord + Copy> GoalDistance<K>

Source

pub fn new(width: u16, height: u16, goals: Vec<Pos>) -> Self

The goals goals on a width × height grid. Goals outside it are left out of every walk.

Source

pub fn goals(&self) -> &[Pos]

The goals, as given.

Source

pub fn distance( &mut self, kind: K, from: Pos, cost: impl Fn(Pos) -> Option<u32>, ) -> Option<u32>

How far a piece of movement kind kind would walk from from to the nearest goal, where entering a tile costs cost(tile) (None: it can’t be entered) and entering a goal costs 0. None with no goals, or no walk. 0 on a goal.

The first call for a kind builds its field with cost; later calls read it and never call cost, so cost must answer the same for every call with one kind. Make a new GoalDistance when the costs change.

Trait Implementations§

Source§

impl<K: Clone> Clone for GoalDistance<K>

Source§

fn clone(&self) -> GoalDistance<K>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug> Debug for GoalDistance<K>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<K: Eq> Eq for GoalDistance<K>

Source§

impl<K: PartialEq> PartialEq for GoalDistance<K>

Source§

fn eq(&self, other: &GoalDistance<K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<K: PartialEq> StructuralPartialEq for GoalDistance<K>

Auto Trait Implementations§

§

impl<K> Freeze for GoalDistance<K>

§

impl<K> RefUnwindSafe for GoalDistance<K>
where K: RefUnwindSafe,

§

impl<K> Send for GoalDistance<K>
where K: Send,

§

impl<K> Sync for GoalDistance<K>
where K: Sync,

§

impl<K> Unpin for GoalDistance<K>

§

impl<K> UnsafeUnpin for GoalDistance<K>

§

impl<K> UnwindSafe for GoalDistance<K>
where K: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.