Enum PolylinePointLocation

pub enum PolylinePointLocation {
    OnVertex(usize),
    OnEdge(usize, usize, [f32; 2]),
}

Location of a point on a polyline.

This enum represents where a point lies on a polygon’s boundary. It’s used by the intersection algorithms to precisely describe intersection points.

Variants

• OnVertex(i) - The point is exactly on vertex i of the polygon
• OnEdge(i, j, bcoords) - The point lies on the edge between vertices i and j, with barycentric coordinates bcoords where bcoords[0] + bcoords[1] = 1.0

Examples

let polygon = vec![
    Point2::origin(),
    Point2::new(2.0, 0.0),
    Point2::new(2.0, 2.0),
    Point2::new(0.0, 2.0),
];

// A point on vertex 0
let loc1 = PolylinePointLocation::OnVertex(0);
let pt1 = loc1.to_point(&polygon);
assert_eq!(pt1, Point2::origin());

// A point halfway along the edge from vertex 0 to vertex 1
let loc2 = PolylinePointLocation::OnEdge(0, 1, [0.5, 0.5]);
let pt2 = loc2.to_point(&polygon);
assert_eq!(pt2, Point2::new(1.0, 0.0));

Variants

OnVertex(usize)

Point on a vertex.

OnEdge(usize, usize, [f32; 2])

Point on an edge.

Implementations

impl PolylinePointLocation

pub fn to_point(self, pts: &[Point2<f32>]) -> Point2<f32>

Computes the point corresponding to this location.

Given a polygon (as a slice of points), this method converts the location into an actual 2D point coordinate.

Arguments

• pts - The vertices of the polygon

Examples

let polygon = vec![
    Point2::origin(),
    Point2::new(4.0, 0.0),
    Point2::new(4.0, 4.0),
];

let loc = PolylinePointLocation::OnEdge(0, 1, [0.75, 0.25]);
let point = loc.to_point(&polygon);
assert_eq!(point, Point2::new(1.0, 0.0)); // 75% of vertex 0 + 25% of vertex 1

Trait Implementations

impl Clone for PolylinePointLocation

fn clone(&self) -> PolylinePointLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolylinePointLocation

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

Formats the value using the given formatter.

impl PartialEq for PolylinePointLocation

fn eq(&self, other: &PolylinePointLocation) -> 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 Copy for PolylinePointLocation

impl StructuralPartialEq for PolylinePointLocation