H3C class

Bindings to H3

Constructors

H3C.new(DynamicLibrary dynamicLibrary)
The symbols are looked up in dynamicLibrary.
H3C.fromLookup(Pointer<T> lookup<T extends NativeType>(String symbolName))
The symbols are looked up with lookup.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

areNeighborCells(int origin, int destination, Pointer<Int> out) → int
@defgroup areNeighborCells areNeighborCells Functions for areNeighborCells @{ / /** @brief returns whether or not the provided hexagons border
cellAreaKm2(int h, Pointer<Double> out) → int
@brief exact area for a specific cell (hexagon or pentagon) in kilometers^2
cellAreaM2(int h, Pointer<Double> out) → int
@brief exact area for a specific cell (hexagon or pentagon) in meters^2
cellAreaRads2(int h, Pointer<Double> out) → int
@defgroup cellArea cellArea Functions for cellArea @{ / /** @brief exact area for a specific cell (hexagon or pentagon) in radians^2
cellsToDirectedEdge(int origin, int destination, Pointer<H3Index> out) → int
@defgroup cellsToDirectedEdge cellsToDirectedEdge Functions for cellsToDirectedEdge @{ / /** @brief returns the directed edge H3Index for the specified origin and destination
cellsToLinkedMultiPolygon(Pointer<H3Index> h3Set, int numHexes, Pointer<LinkedGeoPolygon> out) → int
@defgroup cellsToMultiPolygon cellsToMultiPolygon Functions for cellsToMultiPolygon (currently a binding-only concept) @{ / /** @brief Create a LinkedGeoPolygon from a set of contiguous hexagons
cellToBoundary(int h3, Pointer<CellBoundary> gp) → int
@defgroup cellToBoundary cellToBoundary Functions for cellToBoundary @{ / /** @brief give the cell boundary in lat/lng coordinates for the cell h3
cellToCenterChild(int h, int childRes, Pointer<H3Index> child) → int
@defgroup cellToCenterChild cellToCenterChild Functions for cellToCenterChild @{ / /** @brief returns the center child of the given cell at the specified resolution
cellToChildPos(int child, int parentRes, Pointer<Int64> out) → int
@defgroup cellToChildPos cellToChildPos Functions for cellToChildPos @{ / /** @brief Returns the position of the cell within an ordered list of all children of the cell's parent at the specified resolution
cellToChildren(int h, int childRes, Pointer<H3Index> children) → int
@brief provides the children (or grandchildren, etc) of the given cell
cellToChildrenSize(int h, int childRes, Pointer<Int64> out) → int
@defgroup cellToChildren cellToChildren Functions for cellToChildren @{ / /** @brief determines the exact number of children (or grandchildren, etc) that would be returned for the given cell
cellToLatLng(int h3, Pointer<LatLng> g) → int
@defgroup cellToLatLng cellToLatLng Functions for cellToLatLng @{ / /** @brief find the lat/lng center point g of the cell h3
cellToLocalIj(int origin, int h3, int mode, Pointer<CoordIJ> out) → int
@defgroup cellToLocalIj cellToLocalIj Functions for cellToLocalIj @{ / /** @brief Returns two dimensional coordinates for the given index
cellToParent(int h, int parentRes, Pointer<H3Index> parent) → int
@defgroup cellToParent cellToParent Functions for cellToParent @{ / /** @brief returns the parent (or grandparent, etc) cell of the given cell
cellToVertex(int origin, int vertexNum, Pointer<H3Index> out) → int
@defgroup cellToVertex cellToVertex Functions for cellToVertex @{ / /** @brief Returns a single vertex for a given cell, as an H3 index
cellToVertexes(int origin, Pointer<H3Index> vertexes) → int
@defgroup cellToVertexes cellToVertexes Functions for cellToVertexes @{ / /** @brief Returns all vertexes for a given cell, as H3 indexes
childPosToCell(int childPos, int parent, int childRes, Pointer<H3Index> child) → int
@defgroup childPosToCell childPosToCell Functions for childPosToCell @{ / /** @brief Returns the child cell at a given position within an ordered list of all children at the specified resolution
compactCells(Pointer<H3Index> h3Set, Pointer<H3Index> compactedSet, int numHexes) → int
@defgroup compactCells compactCells Functions for compactCells @{ / /** @brief compacts the given set of hexagons as best as possible
degsToRads(double degrees) → double
@defgroup degsToRads degsToRads Functions for degsToRads @{ / /** @brief converts degrees to radians
describeH3Error(int err) → Pointer<Char>
@defgroup describeH3Error describeH3Error Functions for describeH3Error @{ / /** @brief converts the provided H3Error value into a description string
destroyLinkedMultiPolygon(Pointer<LinkedGeoPolygon> polygon) → void
@brief Free all memory created for a LinkedGeoPolygon
directedEdgeToBoundary(int edge, Pointer<CellBoundary> gb) → int
@defgroup directedEdgeToBoundary directedEdgeToBoundary Functions for directedEdgeToBoundary @{ / /** @brief Returns the CellBoundary containing the coordinates of the edge
directedEdgeToCells(int edge, Pointer<H3Index> originDestination) → int
@defgroup directedEdgeToCells
directedEdgeToCells Functions for directedEdgeToCells @{ / /** @brief Returns the origin and destination hexagons from the directed edge H3Index
edgeLengthKm(int edge, Pointer<Double> length) → int
@brief exact length for a specific directed edge in kilometers
edgeLengthM(int edge, Pointer<Double> length) → int
@brief exact length for a specific directed edge in meters
edgeLengthRads(int edge, Pointer<Double> length) → int
@defgroup edgeLength edgeLength Functions for edgeLength @{ / /** @brief exact length for a specific directed edge in radians
getBaseCellNumber(int h) → int
@defgroup getBaseCellNumber getBaseCellNumber Functions for getBaseCellNumber @{ / /** @brief returns the base cell "number" (0 to 121) of the provided H3 cell
getDirectedEdgeDestination(int edge, Pointer<H3Index> out) → int
@defgroup getDirectedEdgeDestination
getDirectedEdgeDestination Functions for getDirectedEdgeDestination @{ / /** @brief Returns the destination hexagon H3Index from the directed edge H3Index
getDirectedEdgeOrigin(int edge, Pointer<H3Index> out) → int
@defgroup getDirectedEdgeOrigin
getDirectedEdgeOrigin Functions for getDirectedEdgeOrigin @{ / /** @brief Returns the origin hexagon H3Index from the directed edge H3Index
getHexagonAreaAvgKm2(int res, Pointer<Double> out) → int
@defgroup getHexagonAreaAvg getHexagonAreaAvg Functions for getHexagonAreaAvg @{ / /** @brief average hexagon area in square kilometers (excludes pentagons)
getHexagonAreaAvgM2(int res, Pointer<Double> out) → int
@brief average hexagon area in square meters (excludes pentagons)
getHexagonEdgeLengthAvgKm(int res, Pointer<Double> out) → int
@defgroup getHexagonEdgeLengthAvg getHexagonEdgeLengthAvg Functions for getHexagonEdgeLengthAvg @{ / /** @brief average hexagon edge length in kilometers (excludes pentagons)
getHexagonEdgeLengthAvgM(int res, Pointer<Double> out) → int
@brief average hexagon edge length in meters (excludes pentagons)
getIcosahedronFaces(int h3, Pointer<Int> out) → int
@brief Find all icosahedron faces intersected by a given H3 index
getNumCells(int res, Pointer<Int64> out) → int
@defgroup getNumCells getNumCells Functions for getNumCells @{ / /** @brief number of cells (hexagons and pentagons) for a given resolution
getPentagons(int res, Pointer<H3Index> out) → int
@brief generates all pentagons at the specified resolution
getRes0Cells(Pointer<H3Index> out) → int
@brief provides all base cells in H3Index format
getResolution(int h) → int
@defgroup getResolution getResolution Functions for getResolution @{ / /** @brief returns the resolution of the provided H3 index Works on both cells and directed edges.
greatCircleDistanceKm(Pointer<LatLng> a, Pointer<LatLng> b) → double
@brief "great circle distance" between pairs of LatLng points in kilometers
greatCircleDistanceM(Pointer<LatLng> a, Pointer<LatLng> b) → double
@brief "great circle distance" between pairs of LatLng points in meters
greatCircleDistanceRads(Pointer<LatLng> a, Pointer<LatLng> b) → double
@defgroup greatCircleDistance greatCircleDistance Functions for distance @{ / /** @brief "great circle distance" between pairs of LatLng points in radians
gridDisk(int origin, int k, Pointer<H3Index> out) → int
@brief hexagon neighbors in all directions
gridDiskDistances(int origin, int k, Pointer<H3Index> out, Pointer<Int> distances) → int
@defgroup gridDiskDistances gridDiskDistances Functions for gridDiskDistances @{ / /** @brief hexagon neighbors in all directions, reporting distance from origin
gridDiskDistancesUnsafe(int origin, int k, Pointer<H3Index> out, Pointer<Int> distances) → int
@brief hexagons neighbors in all directions, assuming no pentagons, reporting distance from origin
gridDisksUnsafe(Pointer<H3Index> h3Set, int length, int k, Pointer<H3Index> out) → int
@brief collection of hex rings sorted by ring for all given hexagons
gridDiskUnsafe(int origin, int k, Pointer<H3Index> out) → int
@brief hexagons neighbors in all directions, assuming no pentagons
gridDistance(int origin, int h3, Pointer<Int64> distance) → int
@defgroup gridDistance gridDistance Functions for gridDistance @{ / /** @brief Returns grid distance between two indexes
gridPathCells(int start, int end, Pointer<H3Index> out) → int
@brief Line of h3 indexes connecting two indexes
gridPathCellsSize(int start, int end, Pointer<Int64> size) → int
@defgroup gridPathCells gridPathCells Functions for gridPathCells @{ / /** @brief Number of indexes in a line connecting two indexes
gridRingUnsafe(int origin, int k, Pointer<H3Index> out) → int
@defgroup gridRingUnsafe gridRingUnsafe Functions for gridRingUnsafe @{ / /** @brief hollow hexagon ring at some origin
h3ToString(int h, Pointer<Char> str, int sz) → int
@defgroup h3ToString h3ToString Functions for h3ToString @{ / /** @brief converts an H3Index to a canonical string
isPentagon(int h) → int
@defgroup isPentagon isPentagon Functions for isPentagon @{ / /** @brief determines if an H3 cell is a pentagon
isResClassIII(int h) → int
@defgroup isResClassIII isResClassIII Functions for isResClassIII @{ / /** @brief determines if a hexagon is Class III (or Class II)
isValidCell(int h) → int
@defgroup isValidCell isValidCell Functions for isValidCell @{ / /** @brief confirms if an H3Index is a valid cell (hexagon or pentagon) In particular, returns 0 (False) for H3 directed edges or invalid data
isValidDirectedEdge(int edge) → int
@defgroup isValidDirectedEdge isValidDirectedEdge Functions for isValidDirectedEdge @{ / /** @brief returns whether the H3Index is a valid directed edge
isValidVertex(int vertex) → int
@defgroup isValidVertex isValidVertex Functions for isValidVertex @{ / /** @brief Whether the input is a valid H3 vertex
latLngToCell(Pointer<LatLng> g, int res, Pointer<H3Index> out) → int
@defgroup latLngToCell latLngToCell Functions for latLngToCell @{ / /** @brief find the H3 index of the resolution res cell containing the lat/lng
localIjToCell(int origin, Pointer<CoordIJ> ij, int mode, Pointer<H3Index> out) → int
@defgroup localIjToCell localIjToCell Functions for localIjToCell @{ / /** @brief Returns index for the given two dimensional coordinates
maxFaceCount(int h3, Pointer<Int> out) → int
@defgroup getIcosahedronFaces getIcosahedronFaces Functions for getIcosahedronFaces @{ / /** @brief Max number of icosahedron faces intersected by an index
maxGridDiskSize(int k, Pointer<Int64> out) → int
@defgroup gridDisk gridDisk Functions for gridDisk @{ / /** @brief maximum number of hexagons in k-ring
maxPolygonToCellsSize(Pointer<GeoPolygon> geoPolygon, int res, int flags, Pointer<Int64> out) → int
@defgroup polygonToCells polygonToCells Functions for polygonToCells @{ / /** @brief maximum number of cells that could be in the polygon
maxPolygonToCellsSizeExperimental(Pointer<GeoPolygon> polygon, int res, int flags, Pointer<Int64> out) → int
@defgroup polygonToCellsExperimental polygonToCellsExperimental Functions for polygonToCellsExperimental. This is an experimental-only API and is subject to change in minor versions. @{ / /** @brief maximum number of cells that could be in the polygon
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
originToDirectedEdges(int origin, Pointer<H3Index> edges) → int
@defgroup originToDirectedEdges
originToDirectedEdges Functions for originToDirectedEdges @{ / /** @brief Returns the 6 (or 5 for pentagons) edges associated with the H3Index
pentagonCount() → int
@defgroup getPentagons getPentagons Functions for getPentagons @{ / /** @brief returns the number of pentagons per resolution
polygonToCells(Pointer<GeoPolygon> geoPolygon, int res, int flags, Pointer<H3Index> out) → int
@brief cells within the given polygon
polygonToCellsExperimental(Pointer<GeoPolygon> polygon, int res, int flags, int size, Pointer<H3Index> out) → int
@brief cells within the given polygon
radsToDegs(double radians) → double
@defgroup radsToDegs radsToDegs Functions for radsToDegs @{ / /** @brief converts radians to degrees
res0CellCount() → int
@defgroup getRes0Cells getRes0Cells Functions for getRes0Cells @{ / /** @brief returns the number of resolution 0 cells (hexagons and pentagons)
stringToH3(Pointer<Char> str, Pointer<H3Index> out) → int
@defgroup stringToH3 stringToH3 Functions for stringToH3 @{ / /** @brief converts the canonical string format to H3Index format
toString() → String
A string representation of this object.
inherited
uncompactCells(Pointer<H3Index> compactedSet, int numCompacted, Pointer<H3Index> outSet, int numOut, int res) → int
@brief uncompacts the compacted hexagon set
uncompactCellsSize(Pointer<H3Index> compactedSet, int numCompacted, int res, Pointer<Int64> out) → int
@defgroup uncompactCells uncompactCells Functions for uncompactCells @{ / /** @brief determines the exact number of hexagons that will be uncompacted from the compacted set
vertexToLatLng(int vertex, Pointer<LatLng> point) → int
@defgroup vertexToLatLng vertexToLatLng Functions for vertexToLatLng @{ / /** @brief Returns a single vertex for a given cell, as an H3 index

Operators

operator ==(Object other) → bool
The equality operator.
inherited