pub struct Rect<T: CoordNum> { /* private fields */ }
Expand description
An axis-aligned bounded 2D rectangle whose area is
defined by minimum and maximum Coordinate
s.
The constructors and setters ensure the maximum
Coordinate
is greater than or equal to the minimum.
Thus, a Rect
s width, height, and area is guaranteed to
be greater than or equal to zero.
Note. While Rect
implements MapCoords
and
RotatePoint
algorithmic traits, the usage is expected
to maintain the axis alignment. In particular, only
rotation by integer multiples of 90 degrees, will
preserve the original shape. In other cases, the min,
and max points are rotated or transformed, and a new
rectangle is created (with coordinate swaps to ensure
min < max).
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 0., y: 4.},
coord! { x: 3., y: 10.},
);
assert_eq!(3., rect.width());
assert_eq!(6., rect.height());
assert_eq!(
coord! { x: 1.5, y: 7. },
rect.center()
);
Implementations
sourceimpl<T: CoordNum> Rect<T>
impl<T: CoordNum> Rect<T>
sourcepub fn new<C>(c1: C, c2: C) -> Self where
C: Into<Coordinate<T>>,
pub fn new<C>(c1: C, c2: C) -> Self where
C: Into<Coordinate<T>>,
Creates a new rectangle from two corner coordinates.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 10., y: 20. },
coord! { x: 30., y: 10. }
);
assert_eq!(rect.min(), coord! { x: 10., y: 10. });
assert_eq!(rect.max(), coord! { x: 30., y: 20. });
pub fn try_new<C>(c1: C, c2: C) -> Result<Rect<T>, InvalidRectCoordinatesError> where
C: Into<Coordinate<T>>,
Use Rect::new
instead, since Rect::try_new
will never Error
sourcepub fn min(self) -> Coordinate<T>
pub fn min(self) -> Coordinate<T>
Returns the minimum Coordinate
of the Rect
.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 5., y: 5. },
coord! { x: 15., y: 15. },
);
assert_eq!(rect.min(), coord! { x: 5., y: 5. });
sourcepub fn set_min<C>(&mut self, min: C) where
C: Into<Coordinate<T>>,
pub fn set_min<C>(&mut self, min: C) where
C: Into<Coordinate<T>>,
Set the Rect
’s minimum coordinate.
Panics
Panics if min
’s x/y is greater than the maximum coordinate’s x/y.
sourcepub fn max(self) -> Coordinate<T>
pub fn max(self) -> Coordinate<T>
Returns the maximum Coordinate
of the Rect
.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 5., y: 5. },
coord! { x: 15., y: 15. },
);
assert_eq!(rect.max(), coord! { x: 15., y: 15. });
sourcepub fn set_max<C>(&mut self, max: C) where
C: Into<Coordinate<T>>,
pub fn set_max<C>(&mut self, max: C) where
C: Into<Coordinate<T>>,
Set the Rect
’s maximum coordinate.
Panics
Panics if max
’s x/y is less than the minimum coordinate’s x/y.
sourcepub fn width(self) -> T
pub fn width(self) -> T
Returns the width of the Rect
.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 5., y: 5. },
coord! { x: 15., y: 15. },
);
assert_eq!(rect.width(), 10.);
sourcepub fn height(self) -> T
pub fn height(self) -> T
Returns the height of the Rect
.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 5., y: 5. },
coord! { x: 15., y: 15. },
);
assert_eq!(rect.height(), 10.);
sourcepub fn to_polygon(self) -> Polygon<T>
pub fn to_polygon(self) -> Polygon<T>
Create a Polygon
from the Rect
.
Examples
use geo_types::{coord, Rect, polygon};
let rect = Rect::new(
coord! { x: 0., y: 0. },
coord! { x: 1., y: 2. },
);
assert_eq!(
rect.to_polygon(),
polygon![
(x: 0., y: 0.),
(x: 0., y: 2.),
(x: 1., y: 2.),
(x: 1., y: 0.),
(x: 0., y: 0.),
],
);
pub fn to_lines(&self) -> [Line<T>; 4]
sourceimpl<T: CoordFloat> Rect<T>
impl<T: CoordFloat> Rect<T>
sourcepub fn center(self) -> Coordinate<T>
pub fn center(self) -> Coordinate<T>
Returns the center Coordinate
of the Rect
.
Examples
use geo_types::{coord, Rect};
let rect = Rect::new(
coord! { x: 5., y: 5. },
coord! { x: 15., y: 15. },
);
assert_eq!(rect.center(), coord! { x: 10., y: 10. });
Trait Implementations
sourceimpl<T: CoordNum> TryFrom<Geometry<T>> for Rect<T>
impl<T: CoordNum> TryFrom<Geometry<T>> for Rect<T>
Convert a Geometry enum into its inner type.
Fails if the enum case does not match the type you are trying to convert it to.
impl<T: Copy + CoordNum> Copy for Rect<T>
impl<T: Eq + CoordNum> Eq for Rect<T>
impl<T: CoordNum> StructuralEq for Rect<T>
impl<T: CoordNum> StructuralPartialEq for Rect<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Rect<T> where
T: RefUnwindSafe,
impl<T> Send for Rect<T> where
T: Send,
impl<T> Sync for Rect<T> where
T: Sync,
impl<T> Unpin for Rect<T> where
T: Unpin,
impl<T> UnwindSafe for Rect<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 · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
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.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more