Vertex mode
An H3 Vertex index (mode 4) represents a single topological vertex in H3 grid system, shared by three cells. Note that this does not include the distortion vertexes occasionally present in a cell's geographic boundary. An H3 Vertex is arbitrarily assigned one of the three neighboring cells as its "owner", which is used to calculate the canonical index and geographic coordinates for the vertex. The components of the H3 Vertex index are packed into a 64-bit integer in order, highest bit first, as follows:
- 1 bit reserved and set to 0,
- 4 bits to indicate the H3 Vertex index mode,
- 3 bits to indicate the vertex number (0-5) of vertex on the owner cell,
- Subsequent bits matching the index bits of the owner cell.
Bit layout of H3Index for vertexes
The layout of an H3Index for vertexes is shown below in table form. The interpretation of the "Mode-Dependent" field differs depending on the mode of the index.
| 0x0F | 0x0E | 0x0D | 0x0C | 0x0B | 0x0A | 0x09 | 0x08 | 0x07 | 0x06 | 0x05 | 0x04 | 0x03 | 0x02 | 0x01 | 0x00 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0x30 | Reserved (0) | Mode (4) | Vertex | Resolution | Base cell | |||||||||||
| 0x20 | Base cell | Digit 1 | Digit 2 | Digit 3 | Digit 4 | Digit 5 | ||||||||||
| 0x10 | Digit 5 | Digit 6 | Digit 7 | Digit 8 | Digit 9 | Digit 10 | ||||||||||
| 0x00 | Digit 10 | Digit 11 | Digit 12 | Digit 13 | Digit 14 | Digit 15 | ||||||||||