Label Capture Advanced Overlay Listener

Defined in package com.scandit.datacapture.label.ui.overlay

LabelCaptureAdvancedOverlayListener

interface LabelCaptureAdvancedOverlayListener

Added in version 6.16.0

The listener interface for configuring advanced overlays in label capture. This interface allows you to provide custom views, anchors, and offsets for captured labels and their individual fields, enabling rich AR-style overlays.

viewForCapturedLabel(overlay, capturedLabel)

fun viewForCapturedLabel(overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel): View?

Added in version 6.16.0

View to be drawn corresponding to the given CapturedLabel. This method will be called before anchorForCapturedLabel() and offsetForCapturedLabel(). Called from the main thread. Beware that this view can be overridden with LabelCaptureAdvancedOverlay.setViewForCapturedLabel() method. This method will only be called for new tracked labels that do not have a view yet, e.g. a view set by a call to LabelCaptureAdvancedOverlay.setViewForCapturedLabel().

anchorForCapturedLabel(overlay, capturedLabel)

fun anchorForCapturedLabel(overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel): Anchor

Added in version 6.16.0

Anchor point that should be used for the view corresponding to the given CapturedLabel. This method will be called after viewForCapturedLabel() and before offsetForCapturedLabel(). Called from the main thread. Beware that this anchor can be overridden with LabelCaptureAdvancedOverlay.setAnchorForCapturedLabel() method. This method will only be called for new tracked labels that do not have an anchor yet, e.g. an anchor set by a call to LabelCaptureAdvancedOverlay.setAnchorForCapturedLabel().

offsetForCapturedLabel(overlay, capturedLabel, view)

fun offsetForCapturedLabel(overlay: LabelCaptureAdvancedOverlay,
        capturedLabel: CapturedLabel,
        view: View): PointWithUnit

Added in version 6.16.0

Offset to be set to the view corresponding to the given CapturedLabel. The offset is relative to the anchor point of the tracked label. This method will be called after viewForCapturedLabel() and anchorForCapturedLabel(). Called from the main thread. Beware that this offset can be overridden with LabelCaptureAdvancedOverlay.setOffsetForCapturedLabel() method. This method will only be called for new tracked labels that do not have an offset yet, e.g. an offset set by a call to LabelCaptureAdvancedOverlay.setOffsetForCapturedLabel().

viewForCapturedLabelField(overlay, labelField)

fun viewForCapturedLabelField(overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField): View?

Added in version 6.17.0

View to be drawn corresponding to the given LabelField. This method will be called before anchorForCapturedLabelField() and offsetForCapturedLabelField(). Called from the main thread. Beware that this view can be overridden with LabelCaptureAdvancedOverlay.setViewForCapturedLabelField() method. This method will only be called for new tracked fields that do not have a view yet, e.g. a view set by a call to LabelCaptureAdvancedOverlay.setViewForCapturedLabelField().

anchorForCapturedLabelField(overlay, labelField)

fun anchorForCapturedLabelField(overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField): Anchor

Added in version 6.17.0

Anchor point that should be used for the view corresponding to the given LabelField. This method will be called after viewForCapturedLabelField() and before offsetForCapturedLabelField(). Called from the main thread. Beware that this anchor can be overridden with LabelCaptureAdvancedOverlay.setAnchorForCapturedLabelField() method. This method will only be called for new tracked fields that do not have an anchor yet, e.g. an anchor set by a call to LabelCaptureAdvancedOverlay.setAnchorForCapturedLabelField().

offsetForCapturedLabelField(overlay, labelField, view)

fun offsetForCapturedLabelField(overlay: LabelCaptureAdvancedOverlay,
        labelField: LabelField,
        view: View): PointWithUnit

Added in version 6.17.0

Offset to be set to the view corresponding to the given LabelField. The offset is relative to the anchor point of the tracked field. This method will be called after viewForCapturedLabelField() and anchorForCapturedLabelField(). Called from the main thread. Beware that this offset can be overridden with LabelCaptureAdvancedOverlay.setOffsetForCapturedLabelField() method. This method will only be called for new tracked fields that do not have an offset yet, e.g. an offset set by a call to LabelCaptureAdvancedOverlay.setOffsetForCapturedLabelField().