Struct libreda_pnr::db::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
sourceimpl<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
pub fn num_points(&self) -> usize
Get the number of vertices.
sourceimpl<T> SimpleRPolygon<T> where
T: Clone,
impl<T> SimpleRPolygon<T> where
T: Clone,
sourcepub fn reversed(&self) -> SimpleRPolygon<T>
pub fn reversed(&self) -> SimpleRPolygon<T>
Create a copy of this polygon whose vertices are ordered in reversed order.
sourceimpl<T> SimpleRPolygon<T> where
T: Copy,
impl<T> SimpleRPolygon<T> where
T: Copy,
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)),
]);
sourceimpl<T> SimpleRPolygon<T> where
T: CoordinateType,
impl<T> SimpleRPolygon<T> where
T: CoordinateType,
sourcepub fn try_new<P>(points: Vec<P, Global>) -> Option<SimpleRPolygon<T>> where
P: Copy + Into<Point<T>>,
pub fn try_new<P>(points: Vec<P, Global>) -> Option<SimpleRPolygon<T>> where
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());
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);
sourceimpl<T> SimpleRPolygon<T> where
T: Copy + PartialOrd<T>,
impl<T> SimpleRPolygon<T> where
T: Copy + PartialOrd<T>,
Trait Implementations
sourceimpl<T> Clone for SimpleRPolygon<T> where
T: Clone,
impl<T> Clone for SimpleRPolygon<T> where
T: Clone,
sourcepub fn clone(&self) -> SimpleRPolygon<T>
pub fn clone(&self) -> SimpleRPolygon<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T> Debug for SimpleRPolygon<T> where
T: Debug,
impl<T> Debug for SimpleRPolygon<T> where
T: Debug,
sourceimpl<'de, T> Deserialize<'de> for SimpleRPolygon<T> where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for SimpleRPolygon<T> where
T: Deserialize<'de>,
sourcepub fn deserialize<__D>(
__deserializer: __D
) -> Result<SimpleRPolygon<T>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<SimpleRPolygon<T>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<T> DoubledOrientedArea<T> for SimpleRPolygon<T> where
T: CoordinateType,
impl<T> DoubledOrientedArea<T> for SimpleRPolygon<T> where
T: CoordinateType,
sourcepub fn area_doubled_oriented(&self) -> T
pub 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);
sourceimpl<T> From<Rect<T>> for SimpleRPolygon<T> where
T: CoordinateType,
impl<T> From<Rect<T>> for SimpleRPolygon<T> where
T: CoordinateType,
sourcepub fn from(r: Rect<T>) -> SimpleRPolygon<T>
pub fn from(r: Rect<T>) -> SimpleRPolygon<T>
Performs the conversion.
sourceimpl<T> From<SimpleRPolygon<T>> for Geometry<T>
impl<T> From<SimpleRPolygon<T>> for Geometry<T>
sourcepub fn from(x: SimpleRPolygon<T>) -> Geometry<T>
pub fn from(x: SimpleRPolygon<T>) -> Geometry<T>
Performs the conversion.
sourceimpl<T> Hash for SimpleRPolygon<T> where
T: Hash,
impl<T> Hash for SimpleRPolygon<T> where
T: Hash,
sourceimpl<T> PartialEq<SimpleRPolygon<T>> for SimpleRPolygon<T> where
T: PartialEq<T>,
impl<T> PartialEq<SimpleRPolygon<T>> for SimpleRPolygon<T> where
T: PartialEq<T>,
sourcepub fn eq(&self, rhs: &SimpleRPolygon<T>) -> bool
pub fn eq(&self, rhs: &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.
Complexity: O(n^2)
TODO: Normalized ordering of vertices for faster comparison.
sourceimpl<T> Serialize for SimpleRPolygon<T> where
T: Serialize,
impl<T> Serialize for SimpleRPolygon<T> where
T: Serialize,
sourcepub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
sourceimpl<T> TryBoundingBox<T> for SimpleRPolygon<T> where
T: Copy + PartialOrd<T>,
impl<T> TryBoundingBox<T> for SimpleRPolygon<T> where
T: Copy + PartialOrd<T>,
sourcepub fn try_bounding_box(&self) -> Option<Rect<T>>
pub fn try_bounding_box(&self) -> Option<Rect<T>>
Return the bounding box of this geometry if a bounding box is defined.
sourceimpl<T, Dst> TryCastCoord<T, Dst> for SimpleRPolygon<T> where
T: CoordinateType + NumCast,
Dst: CoordinateType + NumCast,
impl<T, Dst> TryCastCoord<T, Dst> for SimpleRPolygon<T> where
T: CoordinateType + NumCast,
Dst: CoordinateType + NumCast,
type Output = SimpleRPolygon<Dst>
type Output = SimpleRPolygon<Dst>
Output type of the cast. This is likely the same geometrical type just with other coordinate types. Read more
sourcepub fn try_cast(
&self
) -> Option<<SimpleRPolygon<T> as TryCastCoord<T, Dst>>::Output>
pub fn try_cast(
&self
) -> Option<<SimpleRPolygon<T> as TryCastCoord<T, Dst>>::Output>
Try to cast to target data type. Read more
sourceimpl<T> WindingNumber<T> for SimpleRPolygon<T> where
T: CoordinateType,
impl<T> WindingNumber<T> for SimpleRPolygon<T> where
T: CoordinateType,
sourcepub fn winding_number(&self, point: Point<T>) -> isize
pub 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.
sourcefn contains_point_non_oriented(&self, point: Point<T>) -> bool
fn contains_point_non_oriented(&self, point: Point<T>) -> bool
Check if point
is inside the polygon, i.e. the polygons winds around the point
a non-zero number of times. Read more
sourcefn contains_point(&self, point: Point<T>) -> bool
fn contains_point(&self, point: Point<T>) -> bool
Check if point
is inside the polygon, i.e. the polygon winds around the point
an odd number of times. Read more
impl<T> Eq for SimpleRPolygon<T> where
T: PartialEq<T>,
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more