PathGeometryElement

public struct PathGeometryElement : HorizonElement

Describes path geometry of the horizon element.

This structure holds a horizon element with information regarding path geometry. It contains information regarding exact coordinates and altitude.

To obtain PathGeometryElement horizon elements, the integrator must create an instance of HorizonEngine, register HorizonOptions including elementTypes containing HorizonElementType .pathGeometryType with a call to HorizonEngine .registerHorizonOptions, and request a HorizonResult using the previously registered HorizonOptions with a call to HorizonEngine .generateHorizon.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Initializes instance of PathGeometryElement.

    Declaration

    Swift

    public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    coordinate: CLLocationCoordinate2D,
    altitude: Measurement<UnitLength>?
)

Public

  • Type of the element. Used to filter elements by type.

    Declaration

    Swift

    public let elementType: HorizonElementType
  • id

    Identifier of this element.

    Declaration

    Swift

    public let id: Int

  • Identifier of the path where this element belongs.

    Declaration

    Swift

    public let pathID: Int

  • Start offset on the path.

    Declaration

    Swift

    public let startOffset: Measurement<UnitLength>

  • End offset on the path.

    Declaration

    Swift

    public let endOffset: Measurement<UnitLength>

  • Coordinate of the geometry point.

    Declaration

    Swift

    public let coordinate: CLLocationCoordinate2D

  • Altitude at the geometry point. Null if altitude is not supported.

    Declaration

    Swift

    public let altitude: Measurement<UnitLength>?