Struct iron_shapes::simple_rpolygon::SimpleRPolygon [−][src]
A SimpleRPolygon
is a rectilinear polygon. It does not contain holes but can be self-intersecting.
The vertices are stored in an implicit format (one coordinate of two neighbour vertices is always the same
for rectilinear polygons). This reduces memory usage but has the drawback that edges must
alternate between horizontal and vertical. Vertices between two edges of the same orientation will
be dropped.
Implementations
impl<T: CoordinateType> SimpleRPolygon<T>
[src]
pub fn try_new<P>(points: Vec<P>) -> Option<Self> where
P: Copy + Into<Point<T>>,
[src]
P: Copy + Into<Point<T>>,
Create new rectilinear polygon from points.
Returns None
if the polygon defined by the points is not rectilinear.
use iron_shapes::simple_rpolygon::SimpleRPolygon; let poly1 = SimpleRPolygon::try_new(vec![(0, 0), (1, 0), (1, 1), (0, 1)]); assert!(poly1.is_some()); // A triangle cannot be rectilinear. let poly1 = SimpleRPolygon::try_new(vec![(0, 0), (1, 0), (1, 1)]); assert!(poly1.is_none());
pub fn empty() -> Self
[src]
Create empty polygon without any vertices.
pub fn num_points(&self) -> usize
[src]
Get the number of vertices.
pub fn points(&self) -> impl Iterator<Item = Point<T>> + '_
[src]
Iterate over the points.
pub fn convex_hull(&self) -> SimplePolygon<T> where
T: Ord,
[src]
T: Ord,
Get the convex hull of the polygon.
Implements Andrew's Monotone Chain algorithm. See: http://geomalgorithms.com/a10-_hull-1.html
pub fn edges(&self) -> impl Iterator<Item = REdge<T>> + '_
[src]
Get all exterior edges of the polygon.
Examples
use iron_shapes::simple_rpolygon::SimpleRPolygon; use iron_shapes::redge::REdge; let coords = vec![(0, 0), (1, 0), (1, 1), (0, 1)]; let poly = SimpleRPolygon::try_new(coords).unwrap(); let edges: Vec<_> = poly.edges().collect(); assert_eq!(edges, vec![ REdge::new((0, 0), (1, 0)), REdge::new((1, 0), (1, 1)), REdge::new((1, 1), (0, 1)), REdge::new((0, 1), (0, 0)), ]);
pub fn lower_left_vertex(&self) -> Point<T>
[src]
Get the vertex with lowest x-coordinate. Prefer lower y-coordinates to break ties.
Examples
use iron_shapes::simple_rpolygon::SimpleRPolygon; use iron_shapes::point::Point; let coords = vec![(0, 0), (1, 0), (1, 1), (0, 1)]; let poly = SimpleRPolygon::try_new(coords).unwrap(); assert_eq!(poly.lower_left_vertex(), Point::new(0, 0));
pub fn orientation(&self) -> Orientation
[src]
Get the orientation of the polygon, i.e. check if it is wound clock-wise or counter-clock-wise.
Examples
use iron_shapes::simple_rpolygon::SimpleRPolygon; use iron_shapes::point::Point; use iron_shapes::types::Orientation; let coords = vec![(0, 0), (1, 0), (1, 1), (0, 1)]; let poly = SimpleRPolygon::try_new(coords).unwrap(); assert_eq!(poly.orientation(), Orientation::CounterClockWise);
Trait Implementations
impl<T: Clone> Clone for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn clone(&self) -> SimpleRPolygon<T>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Debug> Debug for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: CoordinateType> DoubledOrientedArea<T> for SimpleRPolygon<T>
[src]
fn area_doubled_oriented(&self) -> T
[src]
Calculates the doubled oriented area.
Using doubled area allows to compute in the integers because the area of a polygon with integer coordinates is either integer or half-integer.
The area will be positive if the vertices are listed counter-clockwise, negative otherwise.
Complexity: O(n)
Examples
use iron_shapes::traits::DoubledOrientedArea; use iron_shapes::simple_rpolygon::SimpleRPolygon; let coords = vec![(0, 0), (1, 0), (1, 1), (0, 1)]; let poly = SimpleRPolygon::try_new(coords).unwrap(); assert_eq!(poly.area_doubled_oriented(), 2);
impl<T: Eq> Eq for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: CoordinateType> From<Rect<T>> for SimpleRPolygon<T>
[src]
impl<T: Hash> Hash for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T> PartialEq<SimpleRPolygon<T>> for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn eq(&self, rhs: &Self) -> bool
[src]
Equality test for simple polygons.
Two polygons are equal iff a cyclic shift on their vertices can be applied such that the both lists of vertices match exactly.
Complexity: O(n^2)
TODO: Normalized ordering of vertices for faster comparison.
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T> StructuralEq for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> TryBoundingBox<T> for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn try_bounding_box(&self) -> Option<Rect<T>>
[src]
impl<T: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for SimpleRPolygon<T>
[src]
type Output = SimpleRPolygon<Dst>
Output type of the cast. This is likely the same geometrical type just with other coordinate types. Read more
fn try_cast(&self) -> Option<Self::Output>
[src]
fn cast(&self) -> Self::Output
[src]
impl<T> WindingNumber<T> for SimpleRPolygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
fn winding_number(&self, point: Point<T>) -> isize
[src]
Calculate the winding number of the polygon around this point.
TODO: Define how point on edges and vertices is handled.
See: http://geomalgorithms.com/a03-_inclusion.html
fn contains_point_non_oriented(&self, point: Point<T>) -> bool
[src]
fn contains_point(&self, point: Point<T>) -> bool
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for SimpleRPolygon<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for SimpleRPolygon<T> where
T: Send,
T: Send,
impl<T> Sync for SimpleRPolygon<T> where
T: Sync,
T: Sync,
impl<T> Unpin for SimpleRPolygon<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for SimpleRPolygon<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> TextType for T where
T: Clone + Eq + Debug + Hash,
[src]
T: Clone + Eq + Debug + Hash,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,