PathSearchDistance

public struct PathSearchDistance : Equatable

Horizon path search distance configuration.

The search distance defines the extent of the path in the horizon.

For more information on horizon paths see HorizonEngine.

For more information on horizon options see HorizonOptions.

Important

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

Lifecycle

  • Creates a distance with the maximum horizon length.

    Throws

    InitializationError .invalidHorizonLength if maxHorizonLength is negative.

    Declaration

    Swift

    public init(maxHorizonLength: Measurement<UnitLength>) throws

    Parameters

    maxHorizonLength

    The maximum length of the path in the horizon.

Public

  • An error that occurs during the creation of the instance.

    See more

    Declaration

    Swift

    public enum InitializationError : Error