Struct geo_types::geometry::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.

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};

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

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

Trait Implementations

impl<T> AbsDiffEq<Triangle<T>> for Triangle<T>where
    T: AbsDiffEq<Epsilon = T> + CoordNum,
    T::Epsilon: Copy,

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 copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Triangle<T>where
    T: Deserialize<'de> + CoordNum,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn eq(&self, other: &Triangle<T>) -> 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<T> RelativeEq<Triangle<T>> for Triangle<T>where
    T: AbsDiffEq<Epsilon = T> + CoordNum + RelativeEq,

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> Serialize for Triangle<T>where
    T: Serialize + CoordNum,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

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

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