Puck2DConfiguration Structure Reference


                    
                    
                    topImage

Image to use as the top of the location indicator.

Declaration

Swift

public var topImage: UIImage?


                    
                    
                    bearingImage

Image to use as the middle of the location indicator.

Declaration

Swift

public var bearingImage: UIImage?


                    
                    
                    shadowImage

Image to use as the background of the location indicator.

Declaration

Swift

public var shadowImage: UIImage?


                    
                    
                    scale

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

Declaration

Swift

public var scale: Value<Double>?


                    
                    
                    showsAccuracyRing

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

Declaration

Swift

public var showsAccuracyRing: Bool


                    
                    
                    accuracyRingColor

The color of the accuracy ring.

Declaration

Swift

public var accuracyRingColor: UIColor


                    
                    
                    accuracyRingBorderColor

The color of the accuracy ring border.

Declaration

Swift

public var accuracyRingBorderColor: UIColor


                    
                    
                    init(topImage:bearingImage:shadowImage:scale:showsAccuracyRing:)

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

Declaration

Swift

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

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.


                    
                    
                    init(topImage:bearingImage:shadowImage:scale:showsAccuracyRing:accuracyRingColor:accuracyRingBorderColor:)

Initialize a Puck2D object with a top image, bearing image, shadow image, scale, 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))

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.


                    
                    
                    makeDefault(showBearing:)

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