Enum Orientation

pub enum Orientation {
    CounterClockWise,
    ClockWise,
    CoLinear,
}

Variants

CounterClockWise

ClockWise

CoLinear

Implementations

impl Orientation

pub fn new<T>(p1: &[T; 2], p2: &[T; 2], p3: &[T; 2]) -> Orientation

where T: PolygonScalar,

Determine the direction you have to turn if you walk from p1 to p2 to p3.

For fixed-precision types (i8,i16,i32,i64,etc), this function is guaranteed to work for any input and never cause any arithmetic overflows.

Polymorphism

This function works with both Points and Vectors. You should prefer to use Point::orient when possible.

Examples

let p1 = Point::new([ 0, 0 ]);
let p2 = Point::new([ 0, 1 ]); // One unit above p1.
// (0,0) -> (0,1) -> (0,2) == Orientation::CoLinear
assert!(Orientation::new(&p1, &p2, &Point::new([ 0, 2 ])).is_colinear());
// (0,0) -> (0,1) -> (-1,2) == Orientation::CounterClockWise
assert!(Orientation::new(&p1, &p2, &Point::new([ -1, 2 ])).is_ccw());
// (0,0) -> (0,1) -> (1,2) == Orientation::ClockWise
assert!(Orientation::new(&p1, &p2, &Point::new([ 1, 2 ])).is_cw());

pub fn along_vector<T>( p1: &[T; 2], vector: &Vector<T, 2>, p2: &[T; 2], ) -> Orientation

where T: PolygonScalar,

Locate p2 in relation to the line determined by the point p1 and the direction vector.

For fixed-precision types (i8,i16,i32,i64,etc), this function is guaranteed to work for any input and never cause any arithmetic overflows.

This function is identical to Orientation::new(p1, p1+v, p2) but will never cause arithmetic overflows even if p+v would overflow.

Examples

let v = Vector([ 1, 1 ]); // Vector pointing to the top-right corner.
let p1 = Point::new([ 5, 5 ]);
assert!(Orientation::along_vector(&p1, &v, &Point::new([ 6, 6 ])).is_colinear());
assert!(Orientation::along_vector(&p1, &v, &Point::new([ 7, 8 ])).is_ccw());
assert!(Orientation::along_vector(&p1, &v, &Point::new([ 8, 7 ])).is_cw());

pub fn along_perp_vector<T>( p1: &[T; 2], vector: &Vector<T, 2>, p2: &[T; 2], ) -> Orientation

where T: PolygonScalar,

pub fn is_colinear(self) -> bool

pub fn is_ccw(self) -> bool

pub fn is_cw(self) -> bool

pub fn then(self, other: Orientation) -> Orientation

pub fn break_ties(self, a: u32, b: u32, c: u32) -> SoS

pub fn sos(self, other: SoS) -> SoS

pub fn reverse(self) -> Orientation

pub fn ccw_cmp_around_with<T>( vector: &Vector<T, 2>, p1: &[T; 2], p2: &[T; 2], p3: &[T; 2], ) -> Ordering

where T: PolygonScalar,

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Orientation

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

Formats the value using the given formatter.

impl Ord for Orientation

fn cmp(&self, other: &Orientation) -> 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.

impl PartialEq for Orientation

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

fn partial_cmp(&self, other: &Orientation) -> 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 Copy for Orientation

impl Eq for Orientation

impl StructuralPartialEq for Orientation