Enum h3o::geom::ContainmentMode

#[non_exhaustive]
pub enum ContainmentMode {
    ContainsCentroid,
    ContainsBoundary,
    IntersectsBoundary,
}

Containment mode used to decide if a cell is contained in a polygon or not.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ContainsCentroid

This mode will select every cells whose centroid are contained inside the polygon.

This is the fasted option and ensures that every cell is uniquely assigned (e.g. two adjacent polygon with zero overlap also have zero overlapping cells).

On the other hand, some cells may cover area outside of the polygon (overshooting) and some parts of the polygon may be left uncovered.

ContainsBoundary

This mode will select every cells whose boundaries are entirely within the polygon.

This ensures that every cell is uniquely assigned (e.g. two adjacent polygon with zero overlap also have zero overlapping cells) and avoids any coverage overshooting.

Some parts of the polygon may be left uncovered (more than with ContainsCentroid).

IntersectsBoundary

This mode will select every cells whose boundaries are within the polygon, even partially.

This guarantees a complete coverage of the polygon, but some cells may belong to two different polygons if they are adjacent/close enough. Some cells may cover area outside of the polygon.

Trait Implementations

impl Clone for ContainmentMode

fn clone(&self) -> ContainmentMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainmentMode

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

Formats the value using the given formatter.

impl PartialEq<ContainmentMode> for ContainmentMode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ContainmentMode

impl Eq for ContainmentMode

impl StructuralEq for ContainmentMode

impl StructuralPartialEq for ContainmentMode