Struct geo::Triangle

pub struct Triangle<T>(pub Coordinate<T>, pub Coordinate<T>, pub Coordinate<T>)
 where
    T: CoordNum;

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

Implementations

impl<T> Triangle<T> where
    T: CoordNum, 

pub fn to_array(&self) -> [Coordinate<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::{Coordinate, Triangle, polygon};

let triangle = Triangle(
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 20. },
    Coordinate { 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<T, Epsilon = T> + CoordNum,
    <T as AbsDiffEq<T>>::Epsilon: Copy, 

type Epsilon = T

Used for specifying relative comparisons.

pub fn default_epsilon() -> <Triangle<T> as AbsDiffEq<Triangle<T>>>::Epsilon

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

pub fn abs_diff_eq(
    &self,
    other: &Triangle<T>,
    epsilon: <Triangle<T> as AbsDiffEq<Triangle<T>>>::Epsilon
) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{point, Triangle};

let a = Triangle((0.0, 0.0).into(), (10.0, 10.0).into(), (0.0, 5.0).into());
let b = Triangle((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);

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

The inverse of [AbsDiffEq::abs_diff_eq].

impl<T> Area<T> for Triangle<T> where
    T: CoordFloat, 

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T> BoundingRect<T> for Triangle<T> where
    T: CoordNum, 

type Output = Rect<T>

fn bounding_rect(&self) -> Self::Output

Return the bounding rectangle of a geometry

impl<T> Centroid for Triangle<T> where
    T: GeoFloat, 

type Output = Point<T>

fn centroid(&self) -> Self::Output

See: https://en.wikipedia.org/wiki/Centroid

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Contains<Coordinate<T>> for Triangle<T> where
    T: GeoNum, 

fn contains(&self, coord: &Coordinate<T>) -> bool

impl<T> Contains<Point<T>> for Triangle<T> where
    T: GeoNum, 

fn contains(&self, point: &Point<T>) -> bool

impl<F> Contains<Triangle<F>> for MultiPolygon<F> where
    F: GeoFloat, 

fn contains(&self, rhs: &Triangle<F>) -> bool

impl<T> CoordinatePosition for Triangle<T> where
    T: GeoNum, 

type Scalar = T

fn calculate_coordinate_position(
    &self,
    coord: &Coordinate<T>,
    is_inside: &mut bool,
    boundary_count: &mut usize
)

fn coordinate_position(&self, coord: &Coordinate<Self::Scalar>) -> CoordPos

impl<'a, T: CoordNum + 'a> CoordsIter<'a> for Triangle<T>

type Iter = Chain<Chain<Once<Coordinate<T>>, Once<Coordinate<T>>>, Once<Coordinate<T>>>

type ExteriorIter = Self::Iter

type Scalar = T

fn coords_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior coordinates of a geometry.

fn coords_count(&'a self) -> usize

Return the number of coordinates in the Triangle.

fn exterior_coords_iter(&'a self) -> Self::ExteriorIter

Iterate over all exterior coordinates of a geometry.

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

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

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

Formats the value using the given formatter.

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

impl<T> EuclideanDistance<T, Point<T>> for Triangle<T> where
    T: GeoFloat, 

fn euclidean_distance(&self, point: &Point<T>) -> T

Returns the distance between two geometries

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<C: GeoNum> HasDimensions for Triangle<C>

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

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

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T, G> Intersects<G> for Triangle<T> where
    T: CoordNum,
    Polygon<T>: Intersects<G>, 

fn intersects(&self, rhs: &G) -> bool

impl<T> Intersects<Triangle<T>> for Coordinate<T> where
    Triangle<T>: Intersects<Coordinate<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T> Intersects<Triangle<T>> for Line<T> where
    Triangle<T>: Intersects<Line<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T> Intersects<Triangle<T>> for Rect<T> where
    Triangle<T>: Intersects<Rect<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T> Intersects<Triangle<T>> for Polygon<T> where
    Triangle<T>: Intersects<Polygon<T>>,
    T: CoordNum, 

fn intersects(&self, rhs: &Triangle<T>) -> bool

impl<T: CoordNum, NT: CoordNum> MapCoords<T, NT> for Triangle<T>

type Output = Triangle<NT>

fn map_coords(&self, func: impl Fn(&(T, T)) -> (NT, NT) + Copy) -> Self::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

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

fn map_coords_inplace(&mut self, func: impl Fn(&(T, T)) -> (T, T))

Apply a function to all the coordinates in a geometric object, in place

impl<T> PartialEq<Triangle<T>> for Triangle<T> where
    T: PartialEq<T> + CoordNum, 

pub fn eq(&self, other: &Triangle<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Triangle<T>) -> bool

This method tests for !=.

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for Triangle<F>

fn relate(&self, other: &GeometryCollection<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Line<F>> for Triangle<F>

fn relate(&self, other: &Line<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Triangle<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiLineString<F>> for Triangle<F>

fn relate(&self, other: &MultiLineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiPoint<F>> for Triangle<F>

fn relate(&self, other: &MultiPoint<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiPolygon<F>> for Triangle<F>

fn relate(&self, other: &MultiPolygon<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Point<F>> for Triangle<F>

fn relate(&self, other: &Point<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Polygon<F>> for Triangle<F>

fn relate(&self, other: &Polygon<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Rect<F>> for Triangle<F>

fn relate(&self, other: &Rect<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for Point<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for Line<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for LineString<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for Polygon<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for MultiPoint<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for MultiLineString<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for MultiPolygon<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for Rect<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for Triangle<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for GeometryCollection<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

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

pub fn default_max_relative(
) -> <Triangle<T> as AbsDiffEq<Triangle<T>>>::Epsilon

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

pub fn relative_eq(
    &self,
    other: &Triangle<T>,
    epsilon: <Triangle<T> as AbsDiffEq<Triangle<T>>>::Epsilon,
    max_relative: <Triangle<T> as AbsDiffEq<Triangle<T>>>::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{point, Triangle};

let a = Triangle((0.0, 0.0).into(), (10.0, 10.0).into(), (0.0, 5.0).into());
let b = Triangle((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);

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

The inverse of [RelativeEq::relative_eq].

impl<T> StructuralEq for Triangle<T> where
    T: CoordNum, 

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

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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<Triangle<T>, <Triangle<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T: CoordNum, NT: CoordNum> TryMapCoords<T, NT> for Triangle<T>

type Output = Triangle<NT>

fn try_map_coords(
    &self,
    func: impl Fn(&(T, T)) -> Result<(NT, NT), Box<dyn Error + Send + Sync>>
) -> Result<Self::Output, Box<dyn Error + Send + Sync>>

Map a fallible function over all the coordinates in a geometry, returning a Result