Struct spade::PointProjection

pub struct PointProjection<S> { /* private fields */ }

Indicates a point’s projected position relative to an edge.

This struct is usually the result of calling DirectedEdgeHandle::project_point, refer to its documentation for more information.

Implementations

impl<S: SpadeNum> PointProjection<S>

pub fn is_before_edge(&self) -> bool

Returns true if a point’s projection is located before an edge.

See DirectedEdgeHandle::project_point for more information

pub fn is_behind_edge(&self) -> bool

Returns true if a point’s projection is located behind an edge.

See DirectedEdgeHandle::project_point for more information

pub fn is_on_edge(&self) -> bool

Returns true if a point’s projection is located on an edge.

See DirectedEdgeHandle::project_point for more information

pub fn reversed(&self) -> Self

Returns the inverse of this point projection.

The inverse projection projects the same point on the reversed edge used by the original projection.

This method can return an incorrect projection due to rounding issues if the projected point is close to one of the original edge’s vertices.

impl<S: SpadeNum + Float> PointProjection<S>

pub fn relative_position(&self) -> S

Returns the relative position of the point used to create this projection relative to the edge used when creating this projection.

This method will return a value between 0.0 and 1.0 (linearly interpolated) if the projected point lies between self.from and self.to, a value close to zero (due to rounding errors) if the projected point is equal to self.from and a value smaller than zero if the projected point lies “before” self.from. Analogously, a value close to 1. or greater than 1. is returned if the projected point is equal to or lies behind self.to.

Trait Implementations

impl<S: Clone> Clone for PointProjection<S>

fn clone(&self) -> PointProjection<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for PointProjection<S>

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

Formats the value using the given formatter.

impl<S: Hash> Hash for PointProjection<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: Ord> Ord for PointProjection<S>

fn cmp(&self, other: &PointProjection<S>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq for PointProjection<S>

fn eq(&self, other: &PointProjection<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<S: PartialOrd> PartialOrd for PointProjection<S>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: Copy> Copy for PointProjection<S>

impl<S: Eq> Eq for PointProjection<S>

impl<S> StructuralEq for PointProjection<S>

impl<S> StructuralPartialEq for PointProjection<S>