Rectangular Viewfinder

Defined in package com.scandit.datacapture.core.ui.viewfinder

RectangularViewfinderStyle

Added in version 6.8.0

The style of the RectangularViewfinder.

LEGACY

Added in version 6.8.0

Legacy style from versions before 6.8.

SQUARE

Added in version 6.8.0

New style from version 6.8 onwards with square corners.

ROUNDED

Added in version 6.8.0

New style from version 6.8 onwards with rounded corners.

RectangularViewfinderLineStyle

Added in version 6.8.0

The style of the lines drawn as part of the RectangularViewfinder for all styles except RectangularViewfinderStyle.LEGACY.

BOLD

Added in version 6.8.0

Draws lines with a width of 5 dips/points.

LIGHT

Added in version 6.8.0

Draws lines with a width of 3 dips/points.

RectangularViewfinder

class RectangularViewfinder : Viewfinder

Added in version 6.0.0

Rectangular viewfinder with an embedded Scandit logo. The rectangle is always centered on the point of interest of the view.

The rectangular viewfinder is displayed when the recognition is active and hidden when it is not.

To use this viewfinder, create a new instance and assign it to the overlay, e.g. the barcode capture overlay by assigning to the BarcodeCaptureOverlay.viewfinder property.

RectangularViewfinder()

RectangularViewfinder(RectangularViewfinderStyle style,
        RectangularViewfinderLineStyle lineStyle)

Added in version 6.8.0

Constructs a new rectangular viewfinder with the specified style and line style.

RectangularViewfinder()

RectangularViewfinder(RectangularViewfinderStyle style)

Added in version 6.8.0

Constructs a new rectangular viewfinder with the specified style and RectangularViewfinderLineStyle.LIGHT.

RectangularViewfinder()

RectangularViewfinder()

Added in version 6.0.0

Constructs a new rectangular viewfinder with RectangularViewfinderStyle.LEGACY and RectangularViewfinderLineStyle.LIGHT.

style

RectangularViewfinderStyle getStyle()

Added in version 6.8.0

The style of the viewfinder.

lineStyle

RectangularViewfinderLineStyle getLineStyle()

Added in version 6.8.0

The style of the viewfinder’s lines. Not available for RectangularViewfinderStyle.LEGACY.

color

int getColor()
void setColor(int value)

Added in version 6.0.0

The color used to draw the logo and viewfinder when the mode is enabled. The color is always used at full opacity, changing the alpha value has no effect.

disabledColor

int getDisabledColor()
void setDisabledColor(int value)

Added in version 6.3.0

The color used to draw the logo and viewfinder when the mode is disabled. By default transparent.

dimming

float getDimming()
void setDimming(float value)

Added in version 6.8.0

The amount the area outside the viewfinder’s rectangle is dimmed by. Accepts values between 0 (no dimming) and 1 (fully blacked out). Not available for RectangularViewfinderStyle.LEGACY.

disabledDimming

float getDisabledDimming()
void setDisabledDimming(float value)

Added in version 6.10.0

The amount the area outside the viewfinder’s rectangle is dimmed by when the mode is disabled. Accepts values between 0 (no dimming) and 1 (fully blacked out). Not available for RectangularViewfinderStyle.LEGACY.

animation

@Nullable RectangularViewfinderAnimation getAnimation()
void setAnimation(@Nullable RectangularViewfinderAnimation value)

Added in version 6.8.0

The animation used for the viewfinder, if any. Not available for RectangularViewfinderStyle.LEGACY.

sizeWithUnitAndAspect

@NonNull SizeWithUnitAndAspect getSizeWithUnitAndAspect()

Added in version 6.0.0

The size and sizing mode of the viewfinder.

setSize(size)

void setSize(@NonNull SizeWithUnit size)

Added in version 6.0.0

Sets the horizontal and vertical size of the viewfinder to the provided value. When the unit is relative (unit in either x or y is MeasureUnit.FRACTION) the size is computed relative to the view size minus the scan area margins.

setWidthAndAspectRatio(width, heightToWidthAspectRatio)

void setWidthAndAspectRatio(@NonNull FloatWithUnit width,
        float heightToWidthAspectRatio)

Added in version 6.0.0

Sets the width of the viewfinder and compute height automatically based on the provided height/width aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the width is computed relative to the view size minus the scan area margins.

setHeightAndAspectRatio(height, widthToHeightAspectRatio)

void setHeightAndAspectRatio(@NonNull FloatWithUnit height,
        float widthToHeightAspectRatio)

Added in version 6.0.0

Sets the height of the viewfinder and compute width automatically based on the provided width/height aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the height is computed relative to the view size minus the scan area margins.

setShorterDimensionAndAspectRatio(fraction, aspectRatio)

void setShorterDimensionAndAspectRatio(float fraction,
        float aspectRatio)

Added in version 6.8.0

Sets the viewfinder size on the short side of the scan area as fraction of the scan area size. The size on the long side is calculated based on the provided short side/long side aspectRatio.