Struct Triangle 

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

Available on crate feature geo-types only.

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> Triangle<T>

where T: CoordNum,

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

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 for Triangle<T>

where T: Clone + CoordNum,

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> Debug for Triangle<T>

where T: CoordNum,

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

Formats the value using the given formatter.

impl<IC, T> From<[IC; 3]> for Triangle<T>

where IC: Into<Coord<T>> + Copy, T: CoordNum,

fn from(array: [IC; 3]) -> Triangle<T>

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

impl<'a, T> GeometryTrait for &'a Triangle<T>

where T: CoordNum + 'a,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> GeometryTrait for Triangle<T>

where T: CoordNum,

type T = T

The coordinate type of this geometry

type PointType<'b> = Point<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = Rect<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = Triangle<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = Line<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Point<T>, LineString<T>, Polygon<T>, MultiPoint<T>, MultiLineString<T>, MultiPolygon<T>, GeometryCollection<T>, Rect<T>, Triangle<T>, Line<T>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<T> Hash for Triangle<T>

where T: Hash + CoordNum,

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

where __H: Hasher,

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 for Triangle<T>

where T: PartialEq + CoordNum,

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> ToWkt<T> for Triangle<T>

where T: CoordNum + Display,

Examples

use geo_types::{coord, Triangle};
use wkt::ToWkt;

let triangle: Triangle<f64> = Triangle::new(coord!(x: 0., y: 0.), coord!(x: 4., y: 0.), coord!(x: 2., y: 4.));

assert_eq!(triangle.wkt_string(), "POLYGON((0 0,4 0,2 4,0 0))");

fn to_wkt(&self) -> Wkt<T>

Converts the value of self to an Wkt struct.

fn write_wkt(&self, writer: impl Write) -> Result<(), Error>

Write a WKT string to a File, or anything else that implements Write.

fn wkt_string(&self) -> String

Serialize as a WKT string

impl<'a, T> TriangleTrait for &'a Triangle<T>

where T: CoordNum,

type CoordType<'b> = &'a Coord<<&'a Triangle<T> as GeometryTrait>::T> where &'a Triangle<T>: 'b

The type of each underlying coordinate, which implements CoordTrait

fn first(&self) -> <&'a Triangle<T> as TriangleTrait>::CoordType<'_>

Access the first coordinate in this Triangle

fn second(&self) -> <&'a Triangle<T> as TriangleTrait>::CoordType<'_>

Access the second coordinate in this Triangle

fn third(&self) -> <&'a Triangle<T> as TriangleTrait>::CoordType<'_>

Access the third coordinate in this Triangle

fn coords(&self) -> [Self::CoordType<'_>; 3]

Access the three underlying coordinates

impl<T> TriangleTrait for Triangle<T>

where T: CoordNum,

type CoordType<'a> = &'a Coord<<Triangle<T> as GeometryTrait>::T> where Triangle<T>: 'a

The type of each underlying coordinate, which implements CoordTrait

fn first(&self) -> <Triangle<T> as TriangleTrait>::CoordType<'_>

Access the first coordinate in this Triangle

fn second(&self) -> <Triangle<T> as TriangleTrait>::CoordType<'_>

Access the second coordinate in this Triangle

fn third(&self) -> <Triangle<T> as TriangleTrait>::CoordType<'_>

Access the third coordinate in this Triangle

fn coords(&self) -> [Self::CoordType<'_>; 3]

Access the three underlying coordinates

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

where T: CoordNum,

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<Triangle<T>, <Triangle<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<Wkt<T>> for Triangle<T>

where T: CoordNum,

Fallibly convert this WKT primitive into this geo_types primitive

type Error = Error

The type returned in the event of a conversion error.

fn try_from( wkt: Wkt<T>, ) -> Result<Triangle<T>, <Triangle<T> as TryFrom<Wkt<T>>>::Error>

Performs the conversion.

impl<T> TryFromWkt<T> for Triangle<T>

where T: CoordNum + FromStr + Default,

type Error = Error

fn try_from_wkt_str( wkt_str: &str, ) -> Result<Triangle<T>, <Triangle<T> as TryFromWkt<T>>::Error>

Examples

fn try_from_wkt_reader( wkt_reader: impl Read, ) -> Result<Triangle<T>, <Triangle<T> as TryFromWkt<T>>::Error>

Examples

impl<T> Copy for Triangle<T>

where T: Copy + CoordNum,

impl<T> Eq for Triangle<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for Triangle<T>

where T: CoordNum,