Struct ProximityRequest 

pub struct ProximityRequest { /* private fields */ }

A request to measure the proximity of two distinct objects.

Implementations

impl ProximityRequest

pub fn try_new( subject: ObjectId, counterpart: ObjectId, ) -> Result<Self, ProximityError>

A request in space (ProximityProjection::Minimum3d).

pub fn projected( subject: ObjectId, counterpart: ObjectId, projection: ProximityProjection, ) -> Result<Self, ProximityError>

A request measured in projection; a vertical offset must be finite and non-negative.

pub fn subject(&self) -> &ObjectId

pub fn counterpart(&self) -> &ObjectId

pub fn projection(&self) -> ProximityProjection

Trait Implementations

impl Clone for ProximityRequest

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 ProximityRequest

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

Formats the value using the given formatter.

impl Eq for ProximityRequest

impl Ord for ProximityRequest

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 ProximityRequest

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ProximityRequest

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.

impl StructuralPartialEq for ProximityRequest