Barcode AR Responsive Annotation

Defined in framework ScanditBarcodeCapture

BarcodeArResponsiveAnnotation

open class BarcodeArResponsiveAnnotation : UIView, BarcodeArAnnotation

Added in version 7.5.0

Responsive annotations dynamically switch between different annotation variations based on the barcode’s size relative to the screen. This allows for different display styles as a barcode gets closer to or further from the camera.

Each variation is gated by an area-ratio upper bound (the barcode area as a percentage of the screen area). The variations are evaluated from far to close, and the one whose upper bound is the first at or above the current ratio is displayed.

Each variation is a BarcodeArAnnotation — an info, popover or status icon annotation, or your own custom annotation — and any can be set to nil to display nothing in that range.

Note

Passing a BarcodeArResponsiveAnnotation as a variation of another BarcodeArResponsiveAnnotation is undefined behavior and is not supported.

Note

A BarcodeArPopoverAnnotation is not fully supported as a variation. BarcodeArView only applies popover-specific handling — dark scrim, exclusive visibility, hiding on tap — to a popover the annotation provider returns directly, so a popover used as a variation does not receive it.

init(barcode:annotationsByThreshold:)

convenience init(barcode: Barcode, annotationsByThreshold: Dictionary<CGFloat, (any UIView & BarcodeArAnnotation)?>)

Added in version 8.6.0

Constructs a new responsive annotation whose displayed variation depends on the barcode’s area relative to the view. Each key is the area-ratio upper bound (in the range (0.0, 1.0]) at or below which the associated annotation is shown; ranges are evaluated from far to close. A key of 1.0 covers the entire view, so include one to cover the closest range. A nil value suppresses the annotation in that range, and keys outside (0.0, 1.0] are ignored.

Note

Passing a BarcodeArResponsiveAnnotation as a value in annotationsByThreshold is undefined behavior and is not supported.

init(barcode:closeUp:farAway:)

init(barcode: Barcode, closeUp closeUpAnnotation: BarcodeArInfoAnnotation?, farAway farAwayAnnotation: BarcodeArInfoAnnotation?)

Added in version 7.5.0

Constructs a new responsive annotation with the given barcode and annotation variations.

Deprecated since version 8.6: Replaced by the constructor that accepts an annotationsByThreshold map, which supports any number of distance-based variations.

annotationsByThreshold

var annotationsByThreshold: Dictionary<CGFloat, (any UIView & BarcodeArAnnotation)?> { get }

Added in version 8.6.0

The annotations keyed by the area-ratio upper bound (in (0.0, 1.0]) at or below which each is shown, with nil for a range that shows nothing. Keys passed to the initializer outside (0.0, 1.0] are dropped.

threshold

open class var threshold: CGFloat { get, set }

Added in version 7.5.0

The threshold (percentage of the barcode area vs screen area) that determines when to display close-up vs far-away annotations.

The value should be between 0.0 and 1.0, where 0.1 represents 10% of the screen area.

The default value is 0.05.

Note

The threshold is a class-level property that applies to all instances of BarcodeArResponsiveAnnotation.

Deprecated since version 8.6: Configure per-instance distance ranges with the annotationsByThreshold initializer instead.

barcode

open var barcode: Barcode { get }

Added in version 7.5.0

The barcode instance for the annotation.

annotationTrigger

open var annotationTrigger: BarcodeArAnnotationTrigger { get, set }

Added in version 7.5.0

The trigger that causes the annotation to be presented. By default is BarcodeArAnnotationTrigger.highlightTapAndBarcodeScan.

closeUpAnnotation

open var closeUpAnnotation: BarcodeArInfoAnnotation? { get }

Added in version 8.2.0

The annotation displayed when the barcode appears close-up (when the barcode area exceeds the threshold).

Can be nil to display nothing for close-up barcodes.

Deprecated since version 8.6: Use annotationsByThreshold instead.

farAwayAnnotation

open var farAwayAnnotation: BarcodeArInfoAnnotation? { get }

Added in version 8.2.0

The annotation displayed when the barcode appears far away (when the barcode area is below or equal to the threshold).

Can be nil to display nothing for far-away barcodes.

Deprecated since version 8.6: Use annotationsByThreshold instead.