Struct iron_shapes::edge::Edge

pub struct Edge<T> {
    pub start: Point<T>,
    pub end: Point<T>,
}

An edge (line segment) is represented by its starting point and end point.

Fields

start: Point<T>

Start-point of the edge.

end: Point<T>

End-point of the edge.

Implementations

impl<T: Copy> Edge<T>

pub fn new<C>(start: C, end: C) -> Self where
    C: Into<Point<T>>, 

Create a new Edge from two arguments that implement Into<Point>.

pub fn reversed(&self) -> Self

Return the same edge but with the two points swapped.

impl<T: PartialEq> Edge<T>

pub fn is_degenerate(&self) -> bool

Check if edge is degenerate. An edge is degenerate if start point and end point are equal.

pub fn is_rectilinear(&self) -> bool

Test if this edge is either horizontal or vertical.

pub fn is_horizontal(&self) -> bool

Test if this edge is horizontal.

pub fn is_vertical(&self) -> bool

Test if this edge is vertical.

impl<T: CoordinateType> Edge<T>

pub fn vector(&self) -> Vector<T>

Returns the vector from self.start to self.end.

pub fn side_of(&self, point: Point<T>) -> Side

Tells on which side of the edge a point is.

Panics

Panics if the edge is degenerate.

Returns Side::Left if the point is on the left side, Side::Right if the point is on the right side or Side::Center if the point lies exactly on the line.

pub fn contains_point(&self, point: Point<T>) -> ContainsResult

Test if point lies on the edge. Includes start and end points of edge.

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

Test if point lies on the line defined by the edge.

pub fn is_parallel(&self, other: &Edge<T>) -> bool

Test if two edges are parallel.

pub fn is_collinear(&self, other: &Edge<T>) -> bool where
    T: CoordinateType, 

Test if two edges are collinear, i.e. are on the same line.

pub fn is_coincident(&self, other: &Edge<T>) -> bool

Test edges for coincidence. Two edges are coincident if they are oriented the same way and share more than one point (implies that they must be parallel).

pub fn is_parallel_approx(&self, other: &Edge<T>, epsilon_squared: T) -> bool

Test if two edges are approximately parallel. To be used for float coordinates. Inspired by algorithm on page 241 of “Geometric Tools for Computer Graphics”.

pub fn is_collinear_approx(&self, other: &Edge<T>, epsilon_squared: T) -> bool

Test if two edges are approximately collinear, i.e. are on the same line. Inspired by algorithm on page 241 of “Geometric Tools for Computer Graphics”.

pub fn lines_intersect_approx(&self, other: &Edge<T>, epsilon_squared: T) -> bool

Test if lines defined by the edges intersect. If the lines are collinear they are also considered intersecting.

pub fn crossed_by_line(&self, other: &Edge<T>) -> ContainsResult

Test if this edge is crossed by the line defined by the other edge.

Returns WithinBounds if start and end point of this edge lie on different sides of the line defined by the other edge or OnBounds if at least one of the points lies on the line.

pub fn lines_intersect(&self, other: &Edge<T>) -> bool

Test if lines defined by the edges intersect. If the lines are collinear they are also considered intersecting.

pub fn edges_intersect(&self, other: &Edge<T>) -> ContainsResult

Test if two edges intersect. If the edges coincide, they also intersect.

impl<T: CoordinateType + NumCast> Edge<T>

pub fn line_contains_point_approx<F: Float + NumCast>(
    &self,
    point: Point<T>,
    tolerance: F
) -> bool

Test if point lies on the line defined by the edge.

pub fn line_intersection_approx<F: Float>(
    &self,
    other: &Edge<T>,
    tolerance: F
) -> LineIntersection<F, T>

Compute the intersection point of the lines defined by the two edges.

Degenerate lines don’t intersect by definition.

Returns LineIntersection::None iff the two lines don’t intersect. Returns LineIntersection::Collinear iff both lines are equal. Returns LineIntersection::Point(p,(a,b,c)) iff the lines intersect in exactly one point p. f is a value such that self.start + self.vector()*a/c == p and other.start + other.vector()*b/c == p.

Examples

use iron_shapes::point::Point;
use iron_shapes::edge::*;

let e1 = Edge::new((0, 0), (2, 2));
let e2 = Edge::new((0, 2), (2, 0));

assert_eq!(e1.line_intersection_approx(&e2, 1e-6),
    LineIntersection::Point(Point::new(1., 1.), (4, 4, 8)));

assert_eq!(Point::zero() + e1.vector().cast() * 0.5, Point::new(1., 1.));

pub fn edge_intersection_approx<F: Float>(
    &self,
    other: &Edge<T>,
    tolerance: F
) -> EdgeIntersection<F, T, Edge<T>>

Compute the intersection with another edge.

impl<T: CoordinateType + NumCast> Edge<T>

pub fn try_cast<Target: NumCast>(&self) -> Option<Edge<Target>> where
    Target: CoordinateType, 

Try to cast into other data type. When the conversion fails None is returned.

pub fn cast<Target>(&self) -> Edge<Target> where
    Target: CoordinateType + NumCast, 

Cast to other data type.

Panics

Panics when the conversion fails.

pub fn cast_to_float<Target>(&self) -> Edge<Target> where
    Target: CoordinateType + NumCast + Float, 

Cast to float.

Panics

Panics when the conversion fails.

pub fn distance_to_line<F: Float>(&self, point: Point<T>) -> F

Calculate the distance from the point to the line given by the edge.

Distance will be positive if the point lies on the right side of the edge and negative if the point is on the left side.

pub fn distance<F: Float>(&self, point: Point<T>) -> F

Calculate distance from point to the edge.

pub fn projection_approx<F: Float>(&self, point: Point<T>) -> Point<F>

Find the perpendicular projection of a point onto the line of the edge.

pub fn reflection_approx<F: Float>(&self, point: Point<T>) -> Point<F>

Find the mirror image of point.

pub fn distance_to_line_abs_approx<F: Float>(&self, point: Point<T>) -> F

Calculate the absolute distance from the point onto the unbounded line coincident with this edge.

pub fn contains_point_approx<F: Float>(
    &self,
    point: Point<T>,
    tolerance: F
) -> bool

Test if point lies approximately on the edge. Returns true if point is up to tolerance away from the edge and lies between start and end points (inclusive).

impl<T: CoordinateType + Integer> Edge<Ratio<T>>

pub fn line_intersection_rational(
    &self,
    other: Edge<Ratio<T>>
) -> LineIntersection<Ratio<T>, Ratio<T>>

Compute the intersection point of the lines defined by the two edges.

Degenerate lines don’t intersect by definition.

Returns LineIntersection::None iff the two lines don’t intersect. Returns LineIntersection::Collinear iff both lines are equal. Returns LineIntersection::Point(p,(a,b,c)) iff the lines intersect in exactly one point p. f is a value such that self.start + self.vector()*a/c == p and other.start + other.vector()*b/c == p.

Examples

extern crate num_rational;
use num_rational::Ratio;
use iron_shapes::point::Point;
use iron_shapes::edge_rational::*;

let r = |i| Ratio::from_integer(i);

let e1 = Edge::new((r(0), r(0)), (r(2), r(2)));
let e2 = Edge::new((r(0), r(2)), (r(2), r(0)));

assert_eq!(e1.line_intersection_rational(e2),
    LineIntersection::Point(Point::new(r(1), r(1)), (r(4), r(4), r(8))));

pub fn edge_intersection_rational(
    &self,
    other: &Edge<Ratio<T>>
) -> EdgeIntersection<Ratio<T>, Ratio<T>, Edge<Ratio<T>>>

Compute the intersection with another edge.

impl<T: CoordinateType + PrimInt + Debug> Edge<T>

pub fn line_intersection_rounded(&self, other: Edge<T>) -> LineIntersection<T, T>

Compute the intersection point of the lines defined by the two edges. Coordinates of intersection points are rounded towards zero.

Degenerate lines don’t intersect by definition.

Returns LineIntersection::None iff the two lines don’t intersect. Returns LineIntersection::Collinear iff both lines are equal. Returns LineIntersection::Point(p,(a,b,c)) iff the lines intersect in exactly one point p. f is a value such that self.start + self.vector()*a/c == p and other.start + other.vector()*b/c == p.

Examples

use iron_shapes::point::Point;
use iron_shapes::edge::*;

let e1 = Edge::new((0, 0), (2, 2));
let e2 = Edge::new((0, 2), (2, 0));

assert_eq!(e1.line_intersection_rounded(e2),
    LineIntersection::Point(Point::new(1, 1), (4, 4, 8)));

pub fn edge_intersection_rounded(
    &self,
    other: &Edge<T>
) -> EdgeIntersection<T, T, Edge<T>>

Compute the intersection with another edge. Coordinates of intersection points are rounded towards zero.

EdgeIntersection::EndPoint is returned if and only if the intersection lies exactly on an end point.

Trait Implementations

impl<T: Copy + PartialOrd> BoundingBox<T> for Edge<T>

fn bounding_box(&self) -> Rect<T>

Return the bounding box of this geometry.

impl<T: Clone> Clone for Edge<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Edge<T>

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

Formats the value using the given formatter.

impl<T: Copy> EdgeEndpoints<T> for Edge<T>

fn start(&self) -> Point<T>

Get the start point of the edge.

fn end(&self) -> Point<T>

Get the end point of the edge.

impl<T: CoordinateType> From<[Point<T>; 2]> for Edge<T>

fn from(points: [Point<T>; 2]) -> Self

Converts to this type from the input type.

impl<T: CoordinateType> From<(Point<T>, Point<T>)> for Edge<T>

fn from(points: (Point<T>, Point<T>)) -> Self

Converts to this type from the input type.

impl<T> From<Edge<T>> for Geometry<T>

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

Converts to this type from the input type.

impl<T: Hash> Hash for Edge<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, 

Feeds a slice of this type into the given Hasher.

impl<T: CoordinateType> Into<(Point<T>, Point<T>)> for &Edge<T>

fn into(self) -> (Point<T>, Point<T>)

Converts this type into the (usually inferred) input type.

impl<T: CoordinateType> Into<(Point<T>, Point<T>)> for Edge<T>

fn into(self) -> (Point<T>, Point<T>)

Converts this type into the (usually inferred) input type.

impl<T: CoordinateType> Into<Edge<T>> for &REdge<T>

fn into(self) -> Edge<T>

Converts this type into the (usually inferred) input type.

impl<T: CoordinateType> Into<Edge<T>> for REdge<T>

fn into(self) -> Edge<T>

Converts this type into the (usually inferred) input type.

impl<T: Copy> MapPointwise<T> for Edge<T>

fn transform<F: Fn(Point<T>) -> Point<T>>(&self, tf: F) -> Self

Point wise transformation.

impl<T: PartialEq> PartialEq<Edge<T>> for Edge<T>

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

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

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

This method tests for !=.

impl<T: Copy + PartialOrd> TryBoundingBox<T> for Edge<T>

fn try_bounding_box(&self) -> Option<Rect<T>>

Get bounding box of edge (always exists).

impl<T: Copy + NumCast, Dst: Copy + NumCast> TryCastCoord<T, Dst> for Edge<T>

type Output = Edge<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<Self::Output>

Try to cast to target data type.

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

Cast to target data type.

impl<T: CoordinateType> TryFrom<&Edge<T>> for REdge<T>

fn try_from(value: &Edge<T>) -> Result<Self, Self::Error>

Try to convert an edge into a rectilinear edge. Returns none if the edge is not rectilinear.

type Error = ()

The type returned in the event of a conversion error.

impl<T: Copy> Copy for Edge<T>

impl<T: Eq> Eq for Edge<T>

impl<T> StructuralEq for Edge<T>

impl<T> StructuralPartialEq for Edge<T>