com.scvngr.levelup.core.ui.view

Class LevelUpQrCodeGenerator.LevelUpQrCodeImage

java.lang.Object

com.scvngr.levelup.core.ui.view.LevelUpQrCodeGenerator.LevelUpQrCodeImage

Enclosing interface:

LevelUpQrCodeGenerator

@Immutable
public static final class LevelUpQrCodeGenerator.LevelUpQrCodeImage
extends Object

A bitmap of a QR code with information about the QR code targets. The code is rotated 180° from the standard QR Code position.

The targets are the three squares-with-a-square-in-them in the corners of the QR code.

Constructor Summary

Constructors

Constructor and Description
LevelUpQrCodeImage(Bitmap bitmap, int targetSize, int codeMargin) Create a new LevelUpQrCodeGenerator.LevelUpQrCodeImage.

Method Summary

Modifier and Type	Method and Description
Bitmap	getBitmap()
int	getCodeMargin()
int[]	getTargetBottomLeft() Gets the position of the bottom left target marker within the bitmap.
int[]	getTargetBottomRight() Gets the position of the bottom right target marker within the bitmap.
int	getTargetSize()
int[]	getTargetTopRight() Gets the position of the top right target marker within the bitmap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LevelUpQrCodeImage

public LevelUpQrCodeImage(Bitmap bitmap,
                          int targetSize,
                          int codeMargin)

Create a new LevelUpQrCodeGenerator.LevelUpQrCodeImage. Width and height are extracted from the bitmap.

Parameters:

bitmap - an immutable bitmap representing the given QR code. This should be rotated 180° from the standard orientation.

targetSize - the width of the target marker, in pixels. This must be the same for all target markers.

codeMargin - the width between the edge of the bitmap and the first black pixel. This must be the same on all sides.

Method Detail

getBitmap

public Bitmap getBitmap()

Returns:

the code image's bitmap.

getCodeMargin

public int getCodeMargin()

Returns:

the width of the code's margin, in pixels.

getTargetBottomLeft

public int[] getTargetBottomLeft()

Gets the position of the bottom left target marker within the bitmap.

Returns:

[left, top, right, bottom], in pixels. Note: as this is a primitive, it cannot be made immutable and should therefore not be modified.

getTargetBottomRight

public int[] getTargetBottomRight()

Gets the position of the bottom right target marker within the bitmap.

Returns:

[left, top, right, bottom], in pixels. Note: as this is a primitive, it cannot be made immutable and should therefore not be modified.

getTargetSize

public int getTargetSize()

Returns:

the width of the target marker, in pixels.

getTargetTopRight

public int[] getTargetTopRight()

Gets the position of the top right target marker within the bitmap.

Returns:

[left, top, right, bottom], in pixels. Note: as this is a primitive, it cannot be made immutable and should therefore not be modified.