Barcode Tracking Advanced Overlay#

Defined under the namespace Scandit.Datacapture.Barcode.Tracking.Ui

Note

Using this class requires the MatrixScan AR add-on.

BarcodeTrackingAdvancedOverlay#
class BarcodeTrackingAdvancedOverlay : DataCaptureOverlay

Added in version 6.3.0

An overlay for DataCaptureView that allows anchoring a single user-provided View to each tracked barcode.

The provided view is visible on the top of the camera preview as long as its tracked barcode is and for all this time retains its relative position to it. This is useful when an additional information should be provided to tracked barcodes in real time. For instance, a user may overlay the price of an item or its expiry date for each corresponding barcode.

To display the views, this overlay must be attached to a DataCaptureView. This may be done either by creating it with withBarcodeTrackingForView() with a non-null view parameter or by passing this overlay to DataCaptureView.addOverlay().

A user of this class may configure what view is displayed for the given barcode and the relative position between the two by implementing BarcodeTrackingAdvancedOverlayListener or by calling setViewForTrackedBarcode(), setAnchorForTrackedBarcode() or setOffsetForTrackedBarcode().

For additional information about using this overlay, refer to Get Started With MatrixScan and Add AR Overlays in MatrixScan.

withBarcodeTrackingForView(barcodeTracking, view)#
static withBarcodeTrackingForView(barcodeTracking: BarcodeTracking,
        view: DataCaptureView | null): BarcodeTrackingAdvancedOverlay

Added in version 6.3.0

Constructs a new barcode tracking advanced overlay for the barcode tracking instance. The overlay is automatically added to the view.

listener#
listener: BarcodeTrackingAdvancedOverlayListener | null

Added in version 6.3.0

setViewForTrackedBarcode(view, trackedBarcode)#
setViewForTrackedBarcode(view: Promise<TrackedBarcodeView | null>,
        trackedBarcode: TrackedBarcode): Promise<void>

Added in version 6.3.0

The method can be called to change the view drawn for the given tracked barcode. Setting the view to null will unset the view from the tracked barcode and will effectively remove it from the overlay. This method is thread-safe, it can be called from any thread. The view set via this method will take precedence over the one set via BarcodeTrackingAdvancedOverlayListener.viewForTrackedBarcode(): in case a view is set before BarcodeTrackingAdvancedOverlayListener.viewForTrackedBarcode() got called, no call to BarcodeTrackingAdvancedOverlayListener.viewForTrackedBarcode() will happen.

setAnchorForTrackedBarcode(anchor, trackedBarcode)#
setAnchorForTrackedBarcode(anchor: Anchor,
        trackedBarcode: TrackedBarcode): Promise<void>

Added in version 6.3.0

The method can be called to change the anchor point for the view associated with the given tracked barcode. This method is thread-safe, it can be called from any thread. The anchor set via this method will take precedence over the one set via BarcodeTrackingAdvancedOverlayListener.anchorForTrackedBarcode(): in case a view is set before BarcodeTrackingAdvancedOverlayListener.anchorForTrackedBarcode() got called, no call to BarcodeTrackingAdvancedOverlayListener.anchorForTrackedBarcode() will happen.

setOffsetForTrackedBarcode(offset, trackedBarcode)#
setOffsetForTrackedBarcode(offset: PointWithUnit,
        trackedBarcode: TrackedBarcode): Promise<void>

Added in version 6.3.0

The method can be called to change the offset for the view associated with the given tracked barcode. This method is thread-safe, it can be called from any thread. The offset set via this method will take precedence over the one set via BarcodeTrackingAdvancedOverlayListener.offsetForTrackedBarcode(): in case a view is set before BarcodeTrackingAdvancedOverlayListener.offsetForTrackedBarcode() got called, no call to BarcodeTrackingAdvancedOverlayListener.offsetForTrackedBarcode() will happen. If the MeasureUnit of the offset is MeasureUnit.Fraction, the offset is calculated relative to view’s dimensions.

clearTrackedBarcodeViews()#
clearTrackedBarcodeViews(): Promise<void>

Added in version 6.3.0

Clears all the views for the currently tracked barcodes from this overlay. This method is thread-safe, it can be called from any thread.