Enum ProximityProjection 

pub enum ProximityProjection {
    Minimum3d,
    Horizontal,
    Vertical {
        footprint_offset_metres: f64,
        direction: VerticalDirection,
        surfaces: VerticalSurfaces,
    },
    PlanOverlap,
}

The direction in which a distance between two bodies is measured.

No projection’s distance bounds another’s from below, so the broad phase prunes each by its own box gap (crate::projected_candidate_pairs).

Variants

Minimum3d

Shortest distance between the two surfaces in space.

Horizontal

Plan distance between the two footprints: zero when they meet in plan.

Vertical

Gap between the two bodies’ vertical extents (bottom to top), for bodies above or below one another. The bodies are related when their footprints overlap with positive area or, with a positive footprint_offset_metres, when the counterpart’s footprint comes closer than the offset to the subject’s (the subject’s footprint grown by the offset), and when the counterpart lies in direction from the subject. Unrelated bodies have no distance in this projection.

surfaces other than VerticalSurfaces::Extents measure between two chosen surfaces instead (see VerticalSurfaces).

Fields

footprint_offset_metres: f64

direction: VerticalDirection

surfaces: VerticalSurfaces

PlanOverlap

Whether the footprints overlap with positive area: distance zero when they do, none when they do not.

Implementations

impl ProximityProjection

pub fn may_be_unrelated(&self) -> bool

Whether a pair may have no distance at all in this projection.

pub fn name(&self) -> &'static str

The projection’s spelling in evidence locators and messages.

Trait Implementations

impl Clone for ProximityProjection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProximityProjection

impl Debug for ProximityProjection

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

Formats the value using the given formatter.

impl Eq for ProximityProjection

impl Ord for ProximityProjection

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ProximityProjection

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ProximityProjection

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.