HorizonPath

public struct HorizonPath : Equatable

Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the horizon subscription options.

Important

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

Lifecycle


                    
                    
                    init(pathID:parentPathID:offsetOnParentPath:horizonElements:pathGeometry:)

Important

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

Declaration

Swift

public init(
    pathID: Int,
    parentPathID: Int,
    offsetOnParentPath: Measurement<UnitLength>,
    horizonElements: [HorizonElementType: [HorizonElement]],
    pathGeometry: [PathGeometry]
)

Public

pathID
Identifier of this path.
Declaration
Swift

public let pathID: Int
parentPathID
Identifier of the parent path (0 if there is no parent path).
Declaration
Swift

public let parentPathID: Int
offsetOnParentPath
Offset on the parent path of the stub where this path starts. (0 if there is no parent path).
Declaration
Swift

public let offsetOnParentPath: Measurement<UnitLength>


                    
                    
                    horizonElements

Map of horizon elements on the path.

Declaration

Swift

public let horizonElements: [HorizonElementType : [HorizonElement]]

pathGeometry
Path geometry.
Declaration
Swift

public let pathGeometry: [PathGeometry]


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: HorizonPath, rhs: HorizonPath) -> Bool

getElements()
Get all elements in all paths of the snapshot

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

public func getElements() -> [HorizonElement]
getElements(types:)
Get all elements in all paths of the snapshot for the specified types

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

public func getElements(types: [HorizonElementType]) -> [HorizonElement]
getElements(type:)
Get all elements in all paths of the snapshot of a specific type

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

public func getElements(type: HorizonElementType) -> [HorizonElement]