Puck2DConfiguration

 
public struct Puck2DConfiguration : Equatable

Undocumented

  • The configration parameters for sonar-like pulsing circle animation shown around the 2D puck.

    See more

    Declaration

    Swift

    public struct Pulsing : Equatable

  • The opacity of the entire location indicator.

    Declaration

    Swift

    public var opacity: Double

  • Image to use as the top of the location indicator.

    Declaration

    Swift

    public var topImage: UIImage?

  • Image to use as the middle of the location indicator.

    Declaration

    Swift

    public var bearingImage: UIImage?

  • Image to use as the background of the location indicator.

    Declaration

    Swift

    public var shadowImage: UIImage?

  • The size of the images, as a scale factor applied to the size of the specified image.

    Declaration

    Swift

    public var scale: Value<Double>?

  • Undocumented

    Declaration

    Swift

    public var pulsing: Pulsing?

  • Flag determining if the horizontal accuracy ring should be shown arround the Puck. default value is false

    Declaration

    Swift

    public var showsAccuracyRing: Bool

  • The color of the accuracy ring.

    Declaration

    Swift

    public var accuracyRingColor: UIColor

  • The color of the accuracy ring border.

    Declaration

    Swift

    public var accuracyRingBorderColor: UIColor

  • Initialize a Puck2D object with a top image, bearing image, shadow image, scale, opacity and accuracy ring visibility.

    Declaration

    Swift

    public init(topImage: UIImage? = nil,
            bearingImage: UIImage? = nil,
            shadowImage: UIImage? = nil,
            scale: Value<Double>? = nil,
            pulsing: Pulsing? = nil,
            showsAccuracyRing: Bool = false,
            opacity: Double = 1)

    Parameters

    topImage

    The image to use as the top layer for the location indicator.
    bearingImage

    The image used as the middle of the location indicator.
    shadowImage

    The image that acts as a background of the location indicator.
    scale

    The size of the images, as a scale factor applied to the size of the specified image.
    showsAccuracyRing

    Indicates whether the location accurary ring should be shown.
    opacity

    The opacity of the entire location indicator.

  • Initialize a Puck2D object with a top image, bearing image, shadow image, scale, opacity and accuracy ring visibility.

    Declaration

    Swift

    public init(topImage: UIImage? = nil,
            bearingImage: UIImage? = nil,
            shadowImage: UIImage? = nil,
            scale: Value<Double>? = nil,
            showsAccuracyRing: Bool = false,
            accuracyRingColor: UIColor = UIColor(red: 0.537, green: 0.812, blue: 0.941, alpha: 0.3),
            accuracyRingBorderColor: UIColor = UIColor(red: 0.537, green: 0.812, blue: 0.941, alpha: 0.3),
            opacity: Double = 1)

    Parameters

    topImage

    The image to use as the top layer for the location indicator.
    bearingImage

    The image used as the middle of the location indicator.
    shadowImage

    The image that acts as a background of the location indicator.
    scale

    The size of the images, as a scale factor applied to the size of the specified image..
    showsAccuracyRing

    Indicates whether the location accurary ring should be shown.
    accuracyRingColor

    The color of the accuracy ring.
    accuracyRingBorderColor

    The color of the accuracy ring border.
    opacity

    The opacity of the entire location indicator.

  • Create a Puck2DConfiguration instance with or without an arrow bearing image. Default without the arrow bearing image.

    Declaration

    Swift

    public static func makeDefault(showBearing: Bool = false) -> Puck2DConfiguration