ViewBasedMatrixScanOverlay Class Reference

Inherits MatrixScanOverlay, and OnClickListener.

Classes
interface	ViewBasedMatrixScanOverlayListener

Public Member Functions
	ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, ViewBasedMatrixScanOverlayListener listener)
	ViewBasedMatrixScanOverlay (Context context, MatrixScan matrixScan, ViewBasedMatrixScanOverlayListener listener, int viewCenterPoint)
void	removeAllAugmentations ()
void	add (TrackedBarcode code, long id)
void	update (TrackedBarcode code, long id)
void	remove (long id)
void	setViewForCode (View view, long barcodeId)
void	setOffsetForCode (Point offset, long barcodeId)

Static Public Attributes
Possible anchor points of the augmentations, relative to the actual tracked
barcode location within the frame.
static final int	TOP_EDGE_CENTER
static final int	CENTER

Detailed Description

An implementation of the abstract MatrixScanOverlay class, that uses View class instances as augmentations for all of the tracked barcodes.

Since

5.9.0

Constructor & Destructor Documentation

ViewBasedMatrixScanOverlay() [1/2]

ViewBasedMatrixScanOverlay	(	Context	context,
		MatrixScan	matrixScan,
		ViewBasedMatrixScanOverlayListener	listener
	)

A ViewBasedMatrixScanOverlay constructor.

All augmentations drawn by this overlay will be attached to the center of the top edge of the detected barcode.

Parameters

context	Context.
matrixScan	A reference to a MatrixScan instance that the overlay will be added to.
listener	Instance of the ViewBasedMatrixScanOverlayListener class.

Since

5.9.0

ViewBasedMatrixScanOverlay() [2/2]

ViewBasedMatrixScanOverlay	(	Context	context,
		MatrixScan	matrixScan,
		ViewBasedMatrixScanOverlayListener	listener,
		int	viewCenterPoint
	)

A ViewBasedMatrixScanOverlay constructor.

The last argument of the constructor defines whether the augmentations drawn by this overlay should be attached either to the center of the top edge of the detected barcode or to the actual center of the barcode.

Parameters

context	Context.
matrixScan	A reference to a MatrixScan instance that the overlay will be added to.
listener	Instance of the ViewBasedMatrixScanOverlayListener class.
viewCenterPoint	An int representing an anchor point for all augmentations (views). The value has to be one of ViewBasedMatrixScanOverlay.TOP_EDGE_CENTER or ViewBasedMatrixScanOverlay.CENTER.

Since

5.9.0

Member Function Documentation

removeAllAugmentations()

void removeAllAugmentations

(

)

Remove augmentations that are part of the MatrixScanOverlay.

Since

5.9.0

Reimplemented from MatrixScanOverlay.

add()

void add	(	TrackedBarcode	code,
		long	id
	)

Add a new augmentation to the MatrixScanOverlay for the given code.

The new augmentation should have an identifier equal to the given id.

Parameters

code	TrackedBarcode to be used to generate the new augmentation.
id	Identifier for the new augmentation.

Since

5.9.0

Reimplemented from MatrixScanOverlay.

update()

void update	(	TrackedBarcode	code,
		long	id
	)

Update (recreate) an existing augmentation with given id for the given code.

Parameters

code	TrackedBarcode to be used to recreate the augmentation.
id	Identifier of an augmentation that should be updated.

Since

5.9.0

Reimplemented from MatrixScanOverlay.

remove()

void remove

(

long

id

)

Remove an existing augmentation with the given id from the MatrixScanOverlay.

Parameters

id	Identifier of an augmentation that should be removed.

Since

5.9.0

Reimplemented from MatrixScanOverlay.

setViewForCode()

void setViewForCode	(	View	view,
		long	barcodeId
	)

Set a View augmentation for the barcode with the given id.

Parameters

view	View instance, to be used as an augmentation.
barcodeId	Barcode identifier.

Since

5.9.0

setOffsetForCode()

void setOffsetForCode	(	Point	offset,
		long	barcodeId
	)

Set an offset (from the anchor point) of the augmentation drawn for the barcode with the given id.

Parameters

offset	Point instance, representing an offset.
barcodeId	Barcode identifier.

Since

5.9.0

Member Data Documentation

TOP_EDGE_CENTER

final int TOP_EDGE_CENTER

static

Anchor in the middle of the top edge of the tracked barcode.

CENTER

final int CENTER

static

Anchor in the center of the tracked barcode.

---

The documentation for this class was generated from the following file:

• ViewBasedMatrixScanOverlay.java