Enum ContainmentMode

Namespace

H3.NET.Native

Assembly

H3.NET.Native.dll

Containment predicate that selects which H3 cells of a given resolution are returned when filling a GeoPolygon via ToCellsExperimental(GeoPolygon, int, ContainmentMode).

[Experimental("H3NET0001")]
public enum ContainmentMode : uint

Fields

Center = 0

Cells whose center falls within the polygon.

Full = 1

Cells that are fully contained within the polygon.

Overlapping = 2

Cells that overlap the polygon (their boundary intersects it or they are contained).

OverlappingBBox = 3

Cells that overlap the bounding box of the polygon. This is a faster, looser approximation of Overlapping that may include extra cells.

Remarks

This API is experimental and may change in any future minor H3 version. The backing type is uint to match the C uint32_t flags argument; it maps 1:1 to the upstream C ContainmentMode constants (CONTAINMENT_CENTER, CONTAINMENT_FULL, CONTAINMENT_OVERLAPPING, CONTAINMENT_OVERLAPPING_BBOX), minus the CONTAINMENT_INVALID sentinel. Passing a value outside the defined range is rejected by the native library with H3DomainException.