Struct H3Vertex

Namespace

H3.NET.Native

Assembly

H3.NET.Native.dll

A 64-bit H3 vertex index, identifying one of the topological vertices shared by adjacent cells. All public coordinates exposed through its members are in degrees.

public readonly record struct H3Vertex : IEquatable<H3Vertex>

Implements

IEquatable<H3Vertex>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

H3Vertex(ulong)

A 64-bit H3 vertex index, identifying one of the topological vertices shared by adjacent cells. All public coordinates exposed through its members are in degrees.

public H3Vertex(ulong Value)

Parameters

Value ulong

The raw 64-bit H3 vertex index value.

Properties

IsNull

Gets a value indicating whether this is the Null sentinel (raw value 0).

public bool IsNull { get; }

Property Value

bool

Null

Gets the sentinel "null" vertex (raw value 0), representing an invalid or absent vertex.

public static H3Vertex Null { get; }

Property Value

H3Vertex

Value

The raw 64-bit H3 vertex index value.

public ulong Value { get; init; }

Property Value

ulong

Methods

IsValid()

Returns a value indicating whether the native library considers this a valid H3 vertex index. This never throws, even for an arbitrary raw value.

public bool IsValid()

Returns

bool

true if this is a valid vertex; otherwise false.

IsValid(ulong)

Returns a value indicating whether the native library considers a raw value a valid H3 vertex index. This never throws.

public static bool IsValid(ulong value)

Parameters

value ulong

The raw 64-bit value to test.

Returns

bool

true if value is a valid vertex; otherwise false.

ToLatLng()

Returns the geographic coordinate of this vertex.

public LatLng ToLatLng()

Returns

LatLng

The vertex location, in degrees.

Exceptions

H3InvalidIndexException

This is not a valid H3 vertex.