Struct Envelope 

pub struct Envelope { /* private fields */ }

Axis-aligned bounding box in 3-D space.

An Envelope is defined by a lower corner and an upper corner such that each coordinate component of the lower corner is ≤ the corresponding component of the upper corner.

Corresponds to gml:EnvelopeType in ISO 19136.

Implementations

impl Envelope

pub fn new( lower_corner: DirectPosition, upper_corner: DirectPosition, ) -> Result<Self, Error>

Creates an envelope from explicit lower and upper corners.

Errors

Returns Error::InvalidEnvelopeBounds if any coordinate component of lower_corner is strictly greater than the corresponding component of upper_corner.

Examples

use egml_core::model::geometry::{DirectPosition, Envelope};

let lo = DirectPosition::new(0.0, 0.0, 0.0).unwrap();
let hi = DirectPosition::new(1.0, 2.0, 3.0).unwrap();
let env = Envelope::new(lo, hi).unwrap();
assert_eq!(env.size_x(), 1.0);

pub fn lower_corner(&self) -> &DirectPosition

Returns the lower (minimum) corner.

pub fn upper_corner(&self) -> &DirectPosition

Returns the upper (maximum) corner.

pub fn srs_name(&self) -> Option<&str>

Returns the SRS name identifying the CRS of this envelope’s coordinates, or None if unspecified.

pub fn srs_dimension(&self) -> Option<u8>

Returns the coordinate dimension of this envelope’s positions, or None if unspecified.

pub fn set_srs_name(&mut self, srs_name: Option<String>)

Sets the SRS (Spatial Reference System) name, identifying the CRS in which this envelope’s coordinates are expressed (e.g. "urn:ogc:def:crs:EPSG::25832"). Pass None to leave the CRS unspecified.

pub fn set_srs_dimension(&mut self, srs_dimension: Option<u8>)

Sets the coordinate dimension of this envelope’s positions (typically 2 or 3). Pass None to leave the dimension implicit.

pub fn size(&self) -> Vector3<f64>

Returns the diagonal vector from the lower corner to the upper corner.

pub fn size_x(&self) -> f64

Returns the extent along the X axis (upper.x - lower.x).

pub fn size_y(&self) -> f64

Returns the extent along the Y axis (upper.y - lower.y).

pub fn size_z(&self) -> f64

Returns the extent along the Z axis (upper.z - lower.z).

pub fn volume(&self) -> f64

Returns the volume of the box (size_x * size_y * size_z).

Returns 0.0 for degenerate envelopes where one or more extents are zero.

pub fn is_point(&self) -> bool

Returns true if the lower and upper corners are equal, i.e. the envelope collapses to a point.

pub fn is_linear(&self) -> bool

Returns true if exactly one axis has non-zero extent (a line segment).

pub fn is_surface(&self) -> bool

Returns true if exactly two axes have non-zero extent (a flat rectangle).

pub fn is_volume(&self) -> bool

Returns true if all three axes have non-zero extent.

pub fn center(&self) -> DirectPosition

Returns the center point of the envelope.

Computed as lower + size / 2 to avoid overflow with large coordinates.

pub fn contains(&self, point: &DirectPosition) -> bool

Returns true if point lies inside or on the boundary of this envelope.

pub fn contains_envelope(&self, envelope: &Envelope) -> bool

Returns true if envelope is fully contained within (or touches the boundary of) self.

pub fn contains_envelope_partially(&self, envelope: &Envelope) -> bool

Returns true if any corner of envelope lies inside or on the boundary of self.

pub fn enlarge(&self, distance: f64) -> Result<Envelope, Error>

Returns a new envelope expanded by distance in every direction.

Each lower-corner coordinate is decreased by distance and each upper-corner coordinate is increased by distance.

Errors

Returns Error::NonFiniteCoordinate if distance is NaN or infinite, or if the resulting coordinates would overflow f64::MAX.

pub fn apply_transform(&mut self, m: &Isometry3<f64>)

Applies a rigid-body isometry (rotation + translation) to this envelope in place.

Both corners are transformed and the result is re-fitted as an axis-aligned bounding box by taking per-axis minima/maxima. This keeps the AABB invariant valid after rotation, at the cost of a potentially larger box for non-axis-aligned rotations.

Examples

use egml_core::model::geometry::{DirectPosition, Envelope};
use nalgebra::{Isometry3, Vector3};

let lo = DirectPosition::new(0.0, 0.0, 0.0).unwrap();
let hi = DirectPosition::new(1.0, 2.0, 3.0).unwrap();
let mut env = Envelope::new(lo, hi).unwrap();

let translation = Isometry3::translation(10.0, 0.0, 0.0);
env.apply_transform(&translation);

assert_eq!(env.lower_corner().x(), 10.0);
assert_eq!(env.upper_corner().x(), 11.0);

impl Envelope

pub fn from_envelopes(envelopes: &[Self]) -> Option<Self>

Computes the union of a slice of envelopes.

Returns None if envelopes is empty; otherwise returns the smallest envelope that contains all envelopes in the slice.

pub fn from_points(points: &[DirectPosition]) -> Result<Self, Error>

Computes the smallest envelope that contains all points.

Errors

Returns Error::TooFewElements if points is empty.

impl Envelope

pub fn to_solid(&self) -> Result<Solid, Error>

Constructs a Solid whose boundary is the six faces of the bounding box.

Each face is a Polygon with an outward-facing LinearRing exterior. Faces are ordered: bottom (−z), top (+z), front (−y), back (+y), left (−x), right (+x).

Errors

Returns Error::NotAVolume if the envelope does not have all three extents non-zero.

pub fn to_polygon(&self) -> Result<Polygon, Error>

Constructs a Polygon from the flat rectangle of this envelope.

The four corners are wound counter-clockwise when viewed from the positive side of the collapsed axis (i.e. outward-facing normal).

Errors

Returns Error::NotASurface if the envelope does not have exactly two non-zero extents.

pub fn to_triangulated_surface(&self) -> Result<TriangulatedSurface, Error>

Triangulates the envelope into a TriangulatedSurface.

• For a surface envelope (is_surface()): triangulates the single rectangular face.
• For a volume envelope (is_volume()): triangulates all six bounding faces and merges them.

Errors

Returns Error::NotSurfaceOrVolume if the envelope is a point or line segment.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Envelope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Envelope

fn default() -> Envelope

Returns the “default value” for a type.

impl Display for Envelope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Envelope

fn eq(&self, other: &Envelope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Envelope