Struct geo::geometry::Rect

source ·
pub struct Rect<T = f64>where
    T: CoordNum,
{ /* private fields */ }
Expand description

An axis-aligned bounded 2D rectangle whose area is defined by minimum and maximum Coords.

The constructors and setters ensure the maximum Coord is greater than or equal to the minimum. Thus, a Rects 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§

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. });
👎Deprecated since 0.6.2: Use Rect::new instead, since Rect::try_new will never Error

Returns the minimum Coord 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. });

Set the Rect’s minimum coordinate.

Panics

Panics if min’s x/y is greater than the maximum coordinate’s x/y.

Returns the maximum Coord 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. });

Set the Rect’s maximum coordinate.

Panics

Panics if max’s x/y is less than the minimum coordinate’s x/y.

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.);

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.);

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.),
    ],
);

Split a rectangle into two rectangles along the X-axis with equal widths.

Examples
let rect = geo_types::Rect::new(
    geo_types::coord! { x: 0., y: 0. },
    geo_types::coord! { x: 4., y: 4. },
);

let [rect1, rect2] = rect.split_x();

assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 0. },
        geo_types::coord! { x: 2., y: 4. },
    ),
    rect1,
);
assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 2., y: 0. },
        geo_types::coord! { x: 4., y: 4. },
    ),
    rect2,
);

Split a rectangle into two rectangles along the Y-axis with equal heights.

Examples
let rect = geo_types::Rect::new(
    geo_types::coord! { x: 0., y: 0. },
    geo_types::coord! { x: 4., y: 4. },
);

let [rect1, rect2] = rect.split_y();

assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 0. },
        geo_types::coord! { x: 4., y: 2. },
    ),
    rect1,
);
assert_eq!(
    geo_types::Rect::new(
        geo_types::coord! { x: 0., y: 2. },
        geo_types::coord! { x: 4., y: 4. },
    ),
    rect2,
);

Returns the center Coord 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§

Equality assertion with an absolute limit.

Examples
use geo_types::{point, Rect};

let a = Rect::new((0.0, 0.0), (10.0, 10.0));
let b = Rect::new((0.0, 0.0), (10.01, 10.0));

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);
Used for specifying relative comparisons.
The default tolerance to use when testing values that are close together. Read more
The inverse of AbsDiffEq::abs_diff_eq.

Because a Rect has no winding order, the area will always be positive.

Return the bounding rectangle of a geometry Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Find the closest point between self and p.

Return the number of coordinates in the Rect.

Note: Although a Rect is represented by two coordinates, it is spatially represented by four, so this method returns 4.

Iterate over all exterior and (if any) interior coordinates of a geometry. Read more
Iterate over all exterior coordinates of a geometry. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
Converts to this type from the input type.
Converts to this type from the input type.
Some geometries, like a MultiPoint, can have zero coordinates - we call these empty. Read more
The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions. Read more
The dimensions of the Geometry’s boundary, as used by OGC-SFA. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
Calculates a representative point inside the Geometry Read more
Iterate over all exterior and (if any) interior lines of a geometry. Read more
Apply a function to all the coordinates in a geometric object, returning a new object. Read more
Map a fallible function over all the coordinates in a geometry, returning a Result Read more
Apply a function to all the coordinates in a geometric object, in place Read more
Map a fallible function over all the coordinates in a geometry, in place, returning a Result. Read more
👎Deprecated since 0.21.0: use MapCoordsInPlace::map_coords_in_place instead which takes a Coord instead of an (x,y) tuple

Apply a function to all the coordinates in a geometric object, in place

Examples
#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Equality assertion within a relative limit.

Examples
use geo_types::Rect;

let a = Rect::new((0.0, 0.0), (10.0, 10.0));
let b = Rect::new((0.0, 0.0), (10.01, 10.0));

approx::assert_relative_eq!(a, b, max_relative=0.1);
approx::assert_relative_ne!(a, b, max_relative=0.0001);
The default relative tolerance for testing values that are far-apart. Read more
The inverse of RelativeEq::relative_eq.
Create a new geometry with (consecutive) repeated points removed.
Remove (consecutive) repeated points inplace.
Serialize this value into the given Serde serializer. Read more

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.

The type returned in the event of a conversion error.
Performs the conversion.
👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple
👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple
Map a fallible function over all the coordinates in a geometry, returning a Result Read more
👎Deprecated since 0.21.0: use MapCoordsInPlace::try_map_coords_in_place which takes a Coord instead of an (x,y) tuple
Map a fallible function over all the coordinates in a geometry, in place, returning a Result. Read more

Auto Trait Implementations§

Blanket Implementations§

Apply transform immutably, outputting a new geometry.
Apply transform to mutate self.
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Rotate a geometry around its centroid by an angle, in degrees Read more
Mutable version of Self::rotate_around_centroid
Rotate a geometry around the center of its bounding box by an angle, in degrees. Read more
Mutable version of Self::rotate_around_center
Rotate a Geometry around an arbitrary point by an angle, given in degrees Read more
Mutable version of Self::rotate_around_point
Scale a geometry from it’s bounding box center. Read more
Mutable version of scale
Scale a geometry from it’s bounding box center, using different values for x_factor and y_factor to distort the geometry’s aspect ratio. Read more
Mutable version of scale_xy.
Scale a geometry around a point of origin. Read more
Mutable version of scale_around_point.
An affine transformation which skews a geometry, sheared by a uniform angle along the x and y dimensions. Read more
Mutable version of skew.
An affine transformation which skews a geometry, sheared by an angle along the x and y dimensions. Read more
Mutable version of skew_xy.
An affine transformation which skews a geometry around a point of origin, sheared by an angle along the x and y dimensions. Read more
Mutable version of skew_around_point.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Translate a Geometry along its axes by the given offsets Read more
Translate a Geometry along its axes, but in place.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.