Barcode AR Responsive Annotation

Defined in package com.scandit.datacapture.barcode.ar.ui

BarcodeArResponsiveAnnotation

class BarcodeArResponsiveAnnotation : BarcodeArAnnotation

Added in version 7.5.0

Responsive annotations dynamically switch between different info 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 BarcodeArInfoAnnotation instance, but any can be set to null to display nothing in that range.

BarcodeArResponsiveAnnotation()

BarcodeArResponsiveAnnotation(context: Context,
        barcode: Barcode,
        annotationsByThreshold: Map<Float, BarcodeArInfoAnnotation?>)

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 null value suppresses the annotation in that range, and keys outside (0.0, 1.0] are ignored.

BarcodeArResponsiveAnnotation()

BarcodeArResponsiveAnnotation(context: Context,
        barcode: Barcode,
        closeUpAnnotation: BarcodeArInfoAnnotation?,
        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.

update(barcodeLocation, highlightViewLocation, view)

fun update(barcodeLocation: Quadrilateral,
        highlightViewLocation: Quadrilateral?,
        view: View)

Added in version 7.5.0

Called to update the view with barcode location and highlight location. Called from the main thread. This method should not be called directly, it will be invoked automatically when needed.

createView()

fun createView(): View

Added in version 7.5.0

Called once to get the view that will be updated with barcode location in update(). Called from the main thread.

annotationsByThreshold

val annotationsByThreshold: Map<Float, BarcodeArInfoAnnotation?>

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 null for a range that shows nothing. Keys passed to the initializer outside (0.0, 1.0] are dropped.

threshold

var BarcodeArResponsiveAnnotation.threshold: Float

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

val barcode: Barcode

Added in version 7.5.0

The barcode instance for the annotation.

annotationTrigger

var annotationTrigger: BarcodeArAnnotationTrigger

Added in version 7.5.0

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

closeUpAnnotation

val closeUpAnnotation: BarcodeArInfoAnnotation?

Added in version 8.2.0

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

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

Deprecated since version 8.6: Use annotationsByThreshold instead.

farAwayAnnotation

val farAwayAnnotation: BarcodeArInfoAnnotation?

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 null to display nothing for far-away barcodes.

Deprecated since version 8.6: Use annotationsByThreshold instead.