Struct ForcedWalkRequest 

pub struct ForcedWalkRequest { /* private fields */ }

The shortest walk from a point to the nearest of several targets that enters an object’s plan footprint (touching it counts).

A lower bound beyond the upper bound of the plain walk’s length proves that no shortest walk enters the object. With Self::with_avoided every walk keeps out of the named objects, as for a NearestTargetRequest.

Implementations

impl ForcedWalkRequest

pub fn try_new( origin: MetricPoint, targets: Vec<MetricPoint>, through: ObjectId, profile: MobilityProfile, tolerance_metres: f64, ) -> Result<Self, MetricRoutingError>

Creates a request; tolerance_metres is how narrow the bracket should become.

Errors

MetricRoutingError::NoTargets for no target, MetricRoutingError::InvalidTolerance for a negative or non-finite tolerance.

pub fn with_avoided(self, avoided: Vec<ObjectId>) -> Self

The same request, walking around avoided (sorted, deduplicated).

pub fn with_connectors(self, connectors: ConnectorRouting) -> Self

The same request, climbing through connectors between levels.

pub fn origin(&self) -> &MetricPoint

Where every walk starts.

pub fn targets(&self) -> &[MetricPoint]

The targets, in request order.

pub fn through(&self) -> &ObjectId

The object every walk measured enters.

pub fn profile(&self) -> MobilityProfile

Mobility envelope.

pub fn tolerance_metres(&self) -> f64

Requested bracket width in metres.

pub fn avoided(&self) -> &[ObjectId]

The objects every walk keeps out of, sorted.

pub fn connectors(&self) -> Option<&ConnectorRouting>

The connectors a walk may climb through.

Trait Implementations

impl Clone for ForcedWalkRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForcedWalkRequest

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

Formats the value using the given formatter.

impl PartialEq for ForcedWalkRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ForcedWalkRequest