Struct ForcedWalk

#[non_exhaustive]
pub struct ForcedWalk {
    pub length: LengthInterval,
    pub shortest: f64,
    pub witness: Option<DVec2>,
    pub converged: bool,
    pub cells: usize,
}

The shortest walk from an origin to a target that enters a polygon.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

length: LengthInterval

Contains the length of the shortest walk that enters the polygon. Both ends are infinite when no walk from an origin to a target reaches the polygon.

shortest: f64

The shortest walk from any origin to any target, ignoring the polygon: length.lower is never below it, up to rounding. Infinite when no target is reachable from an origin.

witness: Option<DVec2>

A point of the polygon, in the free space, through which a walk of at most length.upper passes; None when no walk reaches the polygon.

converged: bool

Whether the interval is no wider than the tolerance asked for. When the cell budget runs out first it is still sound, only wider.

cells: usize

Cells examined.

Trait Implementations

impl Clone for ForcedWalk

fn clone(&self) -> ForcedWalk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForcedWalk

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

Formats the value using the given formatter.

impl PartialEq for ForcedWalk

fn eq(&self, other: &ForcedWalk) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ForcedWalk

impl StructuralPartialEq for ForcedWalk