Enum SeparationResult

#[non_exhaustive]
pub enum SeparationResult {
    Apart {
        axis: Vec3,
        distance: Scalar,
    },
    Overlapping,
}

Outcome of a separating-axis query.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Apart

A separating axis exists: the shapes are disjoint.

Fields

axis: Vec3

Unit direction that separates them.

distance: Scalar

Gap along that axis. The largest gap found, which is the shapes’ true separation distance for convex operands.

Overlapping

No separating axis exists: the shapes share at least one point.

No depth is reported. See the crate docs: penetration depth and contact extent are different measurements and this crate refuses to conflate them.

Trait Implementations

impl Clone for SeparationResult

fn clone(&self) -> SeparationResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SeparationResult

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

Formats the value using the given formatter.

impl PartialEq for SeparationResult

fn eq(&self, other: &SeparationResult) -> 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 SeparationResult

impl StructuralPartialEq for SeparationResult