Struct Triangle

pub struct Triangle<T: CoordNum = f64>(pub Coord<T>, pub Coord<T>, pub Coord<T>);

A bounded 2D area whose three vertices are defined by Coords. The semantics and validity are that of the equivalent Polygon; in addition, the three vertices must not be collinear and they must be distinct.

Notes

Irrespective of input order the resulting geometry has ccw order and its vertices are yielded in ccw order by iterators

Tuple Fields

0: Coord<T>

👎Deprecated since 0.7.19: Use Triangle::new for construction and triangle.v1() to retrieve the value.

1: Coord<T>

👎Deprecated since 0.7.19: Use Triangle::new for construction and triangle.v2() to retrieve the value.

2: Coord<T>

👎Deprecated since 0.7.19: Use Triangle::new for construction and triangle.v3() to retrieve the value.

Implementations

impl<T: CoordNum> Triangle<T>

pub fn new(v1: Coord<T>, v2: Coord<T>, v3: Coord<T>) -> Self

Create a new Triangle, enforcing default (counter clockwise) winding order.

If the vertices are given in clockwise order, they will be reversed. Degenerate triangles (collinear or identical vertices) are stored as-is.

pub fn unchecked_winding(v1: Coord<T>, v2: Coord<T>, v3: Coord<T>) -> Self

Create a Triangle without normalising the winding order.

Use this when the caller has already verified CCW winding, or when the calling code does not depend on a particular winding order (e.g. inside tight loops where the orientation check would be wasteful).

Unlike Triangle::new, vertices are stored in the order given.

pub fn v1(&self) -> Coord<T>

Return the first vertex of this triangle.

pub fn v2(&self) -> Coord<T>

Return the second vertex of this triangle.

pub fn v3(&self) -> Coord<T>

Return the third vertex of this triangle.

pub fn to_array(&self) -> [Coord<T>; 3]

pub fn to_lines(&self) -> [Line<T>; 3]

pub fn to_polygon(self) -> Polygon<T>

Create a Polygon from the Triangle.

Examples

use geo_types::{coord, Triangle, polygon};

// Input is CW
let triangle = Triangle::new(
    coord! { x: 0., y: 0. },
    coord! { x: 10., y: 20. },
    coord! { x: 20., y: -10. },
);

// Output is CCW
assert_eq!(
    triangle.to_polygon(),
    polygon![
        (x: 20., y: -10.),
        (x: 10., y: 20.),
        (x: 0., y: 0.),
        (x: 20., y: -10.),
    ],
);

Trait Implementations

impl<T> AbsDiffEq for Triangle<T>

where T: CoordNum + AbsDiffEq<Epsilon = T>,

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{point, Triangle};

let a = Triangle::new((0.0, 0.0).into(), (10.0, 10.0).into(), (0.0, 5.0).into());
let b = Triangle::new((0.0, 0.0).into(), (10.01, 10.0).into(), (0.0, 5.0).into());

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Clone + CoordNum> Clone for Triangle<T>

fn clone(&self) -> Triangle<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: CoordNum> Debug for Triangle<T>

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

Formats the value using the given formatter.

impl<IC: Into<Coord<T>> + Copy, T: CoordNum> From<[IC; 3]> for Triangle<T>

fn from(array: [IC; 3]) -> Self

Converts to this type from the input type.

impl<T: CoordNum> From<Triangle<T>> for Geometry<T>

fn from(x: Triangle<T>) -> Self

Converts to this type from the input type.

impl<T: CoordNum> From<Triangle<T>> for Polygon<T>

fn from(t: Triangle<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + CoordNum> Hash for Triangle<T>

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<T: PartialEq + CoordNum> PartialEq for Triangle<T>

fn eq(&self, other: &Triangle<T>) -> 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<T> RTreeObject for Triangle<T>

where T: Float + RTreeNum,

type Envelope = AABB<Point<T>>

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the object’s dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object’s envelope.

impl<T> RelativeEq for Triangle<T>

where T: CoordNum + RelativeEq<Epsilon = T>,

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{point, Triangle};

let a = Triangle::new((0.0, 0.0).into(), (10.0, 10.0).into(), (0.0, 5.0).into());
let b = Triangle::new((0.0, 0.0).into(), (10.01, 10.0).into(), (0.0, 5.0).into());

approx::assert_relative_eq!(a, b, max_relative=0.1);
approx::assert_relative_ne!(a, b, max_relative=0.0001);

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: CoordNum> TryFrom<Geometry<T>> for Triangle<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> UlpsEq for Triangle<T>

where T: CoordNum + UlpsEq<Epsilon = T>,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Copy + CoordNum> Copy for Triangle<T>

impl<T: Eq + CoordNum> Eq for Triangle<T>

impl<T: CoordNum> StructuralPartialEq for Triangle<T>