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>

1: Coord<T>

2: Coord<T>

Implementations

impl<T: CoordNum> Triangle<T>

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

Instantiate Self from the raw content value

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

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

Returns a copy 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: 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: Copy + CoordNum> Copy for Triangle<T>

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

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