Struct Triangle

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

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

where T: CoordNum,

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

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

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: &Triangle<T>, epsilon: <Triangle<T> as AbsDiffEq>::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() -> <Triangle<T> as AbsDiffEq>::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> 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,

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

The Centroid of a Triangle is the mean of its Points

Examples

use geo::Centroid;
use geo::{Triangle, coord, point};

let triangle = Triangle::new(
  coord!(x: 0.0f32, y: -1.0),
  coord!(x: 3.0, y: 0.0),
  coord!(x: 0.0, y: 1.0),
);

assert_eq!(
    point!(x: 1.0, y: 0.0),
    triangle.centroid(),
);

type Output = Point<T>

impl<T> ChamberlainDuquetteArea<T> for Triangle<T>

where T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

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<F: GeoFloat> ClosestPoint<F> for Triangle<F>

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<T> Contains<Coord<T>> for Triangle<T>

where T: GeoNum,

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

impl<T> Contains<Geometry<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, geometry: &Geometry<T>) -> bool

impl<T> Contains<GeometryCollection<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &GeometryCollection<T>) -> bool

impl<T> Contains<Line<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &Line<T>) -> bool

impl<T> Contains<LineString<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<MultiLineString<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &MultiLineString<T>) -> bool

impl<T> Contains<MultiPoint<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPoint<T>) -> bool

impl<T> Contains<MultiPolygon<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> bool

impl<T> Contains<Point<T>> for Triangle<T>

where T: GeoNum,

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

impl<T> Contains<Polygon<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &Polygon<T>) -> bool

impl<T> Contains<Rect<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &Rect<T>) -> bool

impl<F> Contains<Triangle<F>> for MultiPolygon<F>

where F: GeoFloat,

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

impl<T> Contains<Triangle<T>> for Geometry<T>

where T: GeoFloat,

fn contains(&self, triangle: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for GeometryCollection<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for Line<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for LineString<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for MultiLineString<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for MultiPoint<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for Point<T>

where T: CoordNum,

fn contains(&self, triangle: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains<Triangle<T>> for Rect<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> CoordinatePosition for Triangle<T>

where T: GeoNum,

type Scalar = T

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

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

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

fn coords_count(&'a self) -> usize

Return the number of coordinates in the Triangle.

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

type ExteriorIter = <Triangle<T> as CoordsIter<'a>>::Iter

type Scalar = T

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

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

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

Iterate over all exterior coordinates of a geometry.

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

where T: CoordFloat, Line<T>: EuclideanLength<T>, LineString<T>: EuclideanLength<T>,

type Output = Polygon<T>

fn densify(&self, max_distance: T) -> Self::Output

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 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 GeodesicArea<f64> for Triangle

fn geodesic_perimeter(&self) -> f64

Determine the perimeter of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_signed(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_unsigned(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter_area_signed(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

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,

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

where T: GeoFloat,

type Output = Point<T>

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

Calculates a representative point inside the Geometry

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

where Triangle<T>: Intersects<Coord<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 Polygon<T>

where Triangle<T>: Intersects<Polygon<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<'a, T: CoordNum + 'a> LinesIter<'a> for Triangle<T>

type Scalar = T

type Iter = <[Line<<Triangle<T> as LinesIter<'a>>::Scalar>; 3] as IntoIterator>::IntoIter

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

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

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

type Output = Triangle<NT>

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

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

fn try_map_coords<E>( &self, func: impl Fn(Coord<T>) -> Result<Coord<NT>, E>, ) -> Result<Self::Output, E>

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

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

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<T>)

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

fn try_map_coords_in_place<E>( &mut self, func: impl Fn(Coord<T>) -> Result<Coord<T>, E>, ) -> Result<(), E>

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

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

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

where T: CoordNum,

👎Deprecated since 0.21.0: use MapCoordsInPlace::map_coords_in_place instead which takes a Coord instead of an (x,y) tuple

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

Examples

#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

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> 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) -> <Triangle<T> as RTreeObject>::Envelope

Returns the object’s envelope.

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 GeometryCollection<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 MultiLineString<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 MultiPolygon<F>

fn relate(&self, other: &Triangle<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 Polygon<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<T> RelativeEq for Triangle<T>

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

fn relative_eq( &self, other: &Triangle<T>, epsilon: <Triangle<T> as AbsDiffEq>::Epsilon, max_relative: <Triangle<T> as AbsDiffEq>::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() -> <Triangle<T> as AbsDiffEq>::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> RemoveRepeatedPoints<T> for Triangle<T>

where T: CoordNum + FromPrimitive,

fn remove_repeated_points(&self) -> Self

Create a new geometry with (consecutive) repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove (consecutive) repeated points inplace.

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: CoordNum, NT: CoordNum, E> TryMapCoords<T, NT, E> for Triangle<T>

type Output = Triangle<NT>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

fn try_map_coords( &self, func: impl Fn((T, T)) -> Result<(NT, NT), E> + Copy, ) -> Result<Self::Output, E>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

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

impl<T: CoordNum, E> TryMapCoordsInplace<T, E> for Triangle<T>

fn try_map_coords_inplace( &mut self, func: impl Fn((T, T)) -> Result<(T, T), E>, ) -> Result<(), E>

👎Deprecated since 0.21.0: use MapCoordsInPlace::try_map_coords_in_place which takes a Coord instead of an (x,y) tuple

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

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: &Triangle<T>, epsilon: <Triangle<T> as AbsDiffEq>::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 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,