Struct libreda_db::layout::prelude::SimpleRPolygon
source · pub struct SimpleRPolygon<T> { /* private fields */ }
Expand description
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§
source§impl<T> SimpleRPolygon<T>
impl<T> SimpleRPolygon<T>
sourcepub fn empty() -> SimpleRPolygon<T>
pub fn empty() -> SimpleRPolygon<T>
Create empty polygon without any vertices.
sourcepub fn num_points(&self) -> usize
👎Deprecated: use len() instead
pub fn num_points(&self) -> usize
Get the number of vertices.
source§impl<T> SimpleRPolygon<T>
impl<T> SimpleRPolygon<T>
sourcepub fn reversed(self) -> SimpleRPolygon<T>
pub fn reversed(self) -> SimpleRPolygon<T>
Reverse the order of vertices.
source§impl<T> SimpleRPolygon<T>where
T: Copy,
impl<T> SimpleRPolygon<T>where
T: Copy,
sourcepub fn points(&self) -> impl DoubleEndedIterator + ExactSizeIterator + Clone
pub fn points(&self) -> impl DoubleEndedIterator + ExactSizeIterator + Clone
Iterate over the points.
sourcepub fn edges(&self) -> impl Iterator<Item = REdge<T>>
pub fn edges(&self) -> impl Iterator<Item = REdge<T>>
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)),
]);
sourcepub fn into_edges(self) -> impl Iterator<Item = REdge<T>>
pub fn into_edges(self) -> impl Iterator<Item = REdge<T>>
Get all exterior edges of the polygon.
In contrast to SimpleRPolygon::edges
this method takes ownership 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)),
]);
source§impl<T> SimpleRPolygon<T>
impl<T> SimpleRPolygon<T>
sourcepub fn try_new<I, Points, P>(points: I) -> Option<SimpleRPolygon<T>>where
I: IntoIterator<Item = P, IntoIter = Points>,
Points: DoubleEndedIterator<Item = P> + ExactSizeIterator + Clone,
P: Copy + Into<Point<T>>,
pub fn try_new<I, Points, P>(points: I) -> Option<SimpleRPolygon<T>>where
I: IntoIterator<Item = P, IntoIter = Points>,
Points: DoubleEndedIterator<Item = P> + ExactSizeIterator + Clone,
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());
source§impl<T> SimpleRPolygon<T>where
T: CoordinateType,
impl<T> SimpleRPolygon<T>where
T: CoordinateType,
sourcepub fn transformed(&self, tf: &SimpleTransform<T>) -> SimpleRPolygon<T>
pub fn transformed(&self, tf: &SimpleTransform<T>) -> SimpleRPolygon<T>
Apply the transformation to this rectilinear polygon.
sourcepub fn to_simple_polygon(&self) -> SimplePolygon<T>
pub fn to_simple_polygon(&self) -> SimplePolygon<T>
Convert to a SimplePolygon
.
sourcepub fn convex_hull(&self) -> SimplePolygon<T>where
T: Ord,
pub fn convex_hull(&self) -> SimplePolygon<T>where
T: Ord,
Get the convex hull of the polygon.
Implements Andrew’s Monotone Chain algorithm. See: http://geomalgorithms.com/a10-_hull-1.html
sourcepub fn lower_left_vertex(&self) -> Point<T>
pub fn lower_left_vertex(&self) -> Point<T>
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));
sourcepub fn orientation(&self) -> Orientation
pub fn orientation(&self) -> Orientation
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);
source§impl<T> SimpleRPolygon<T>where
T: Copy + PartialOrd,
impl<T> SimpleRPolygon<T>where
T: Copy + PartialOrd,
source§impl<T> SimpleRPolygon<T>where
T: PartialOrd,
impl<T> SimpleRPolygon<T>where
T: PartialOrd,
sourcepub fn normalize(&mut self)
pub fn normalize(&mut self)
Rotate the vertices to get the lexicographically smallest polygon. Does not change the orientation.
sourcepub fn normalized(self) -> SimpleRPolygon<T>
pub fn normalized(self) -> SimpleRPolygon<T>
Rotate the vertices to get the lexicographically smallest polygon. Does not change the orientation.
source§impl<T> SimpleRPolygon<T>where
T: PartialEq,
impl<T> SimpleRPolygon<T>where
T: PartialEq,
sourcepub fn normalized_eq(&self, other: &SimpleRPolygon<T>) -> bool
pub fn normalized_eq(&self, other: &SimpleRPolygon<T>) -> bool
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.
Trait Implementations§
source§impl<T> Clone for SimpleRPolygon<T>where
T: Clone,
impl<T> Clone for SimpleRPolygon<T>where
T: Clone,
source§fn clone(&self) -> SimpleRPolygon<T>
fn clone(&self) -> SimpleRPolygon<T>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<T> Debug for SimpleRPolygon<T>where
T: Debug,
impl<T> Debug for SimpleRPolygon<T>where
T: Debug,
source§impl<'de, T> Deserialize<'de> for SimpleRPolygon<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for SimpleRPolygon<T>where
T: Deserialize<'de>,
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<SimpleRPolygon<T>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<SimpleRPolygon<T>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl<T> DoubledOrientedArea<T> for SimpleRPolygon<T>where
T: CoordinateType,
impl<T> DoubledOrientedArea<T> for SimpleRPolygon<T>where
T: CoordinateType,
source§fn area_doubled_oriented(&self) -> T
fn area_doubled_oriented(&self) -> T
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);
source§impl<T> From<Rect<T>> for SimpleRPolygon<T>where
T: CoordinateType,
impl<T> From<Rect<T>> for SimpleRPolygon<T>where
T: CoordinateType,
source§fn from(r: Rect<T>) -> SimpleRPolygon<T>
fn from(r: Rect<T>) -> SimpleRPolygon<T>
source§impl<T> From<SimpleRPolygon<T>> for Geometry<T>
impl<T> From<SimpleRPolygon<T>> for Geometry<T>
source§fn from(x: SimpleRPolygon<T>) -> Geometry<T>
fn from(x: SimpleRPolygon<T>) -> Geometry<T>
source§impl<T> Hash for SimpleRPolygon<T>where
T: Hash,
impl<T> Hash for SimpleRPolygon<T>where
T: Hash,
source§impl<T> PartialEq for SimpleRPolygon<T>where
T: PartialEq,
impl<T> PartialEq for SimpleRPolygon<T>where
T: PartialEq,
source§fn eq(&self, other: &SimpleRPolygon<T>) -> bool
fn eq(&self, other: &SimpleRPolygon<T>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<T> Serialize for SimpleRPolygon<T>where
T: Serialize,
impl<T> Serialize for SimpleRPolygon<T>where
T: Serialize,
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
source§impl<T> TryBoundingBox<T> for SimpleRPolygon<T>where
T: Copy + PartialOrd,
impl<T> TryBoundingBox<T> for SimpleRPolygon<T>where
T: Copy + PartialOrd,
source§fn try_bounding_box(&self) -> Option<Rect<T>>
fn try_bounding_box(&self) -> Option<Rect<T>>
source§impl<T, Dst> TryCastCoord<T, Dst> for SimpleRPolygon<T>
impl<T, Dst> TryCastCoord<T, Dst> for SimpleRPolygon<T>
§type Output = SimpleRPolygon<Dst>
type Output = SimpleRPolygon<Dst>
source§fn try_cast(
&self,
) -> Option<<SimpleRPolygon<T> as TryCastCoord<T, Dst>>::Output>
fn try_cast( &self, ) -> Option<<SimpleRPolygon<T> as TryCastCoord<T, Dst>>::Output>
source§impl<T> WindingNumber<T> for SimpleRPolygon<T>where
T: CoordinateType,
impl<T> WindingNumber<T> for SimpleRPolygon<T>where
T: CoordinateType,
source§fn winding_number(&self, point: Point<T>) -> isize
fn winding_number(&self, point: Point<T>) -> isize
Calculate the winding number of the polygon around this point.
TODO: Define how point on edges and vertices is handled.
impl<T> Eq for SimpleRPolygon<T>where
T: Eq,
impl<T> StructuralPartialEq for SimpleRPolygon<T>
Auto Trait Implementations§
impl<T> Freeze for SimpleRPolygon<T>
impl<T> RefUnwindSafe for SimpleRPolygon<T>where
T: RefUnwindSafe,
impl<T> Send for SimpleRPolygon<T>where
T: Send,
impl<T> Sync for SimpleRPolygon<T>where
T: Sync,
impl<T> Unpin for SimpleRPolygon<T>where
T: Unpin,
impl<T> UnwindSafe for SimpleRPolygon<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more