Class DocumentPolygonConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class DocumentPolygonConfiguration implements Parcelable
Configuration of the document contour detection polygon.
-
-
Field Summary
Fields Modifier and Type Field Description private UserGuidanceVisibility
visibility
private PolygonStyle
documentOk
private PolygonStyle
documentNotOk
private PolygonStyle
autoSnapProgress
-
Constructor Summary
Constructors Constructor Description DocumentPolygonConfiguration(Map<String, Object> source)
DocumentPolygonConfiguration(JSONObject json)
DocumentPolygonConfiguration(UserGuidanceVisibility visibility, PolygonStyle documentOk, PolygonStyle documentNotOk, PolygonStyle autoSnapProgress)
-
Method Summary
Modifier and Type Method Description final UserGuidanceVisibility
getVisibility()
Determines the visibility mode for the polygon. final Unit
setVisibility(UserGuidanceVisibility visibility)
Determines the visibility mode for the polygon. final PolygonStyle
getDocumentOk()
Configuration of the polygon when the detected document status is 'OK'. final Unit
setDocumentOk(PolygonStyle documentOk)
Configuration of the polygon when the detected document status is 'OK'. final PolygonStyle
getDocumentNotOk()
Configuration of the polygon when the detected document status is 'not OK'. final Unit
setDocumentNotOk(PolygonStyle documentNotOk)
Configuration of the polygon when the detected document status is 'not OK'. final PolygonStyle
getAutoSnapProgress()
Configuration of the animated polygon when the document is being scanned for capturing in 'auto snapping mode'. final Unit
setAutoSnapProgress(PolygonStyle autoSnapProgress)
Configuration of the animated polygon when the document is being scanned for capturing in 'auto snapping mode'. final JSONObject
toJson()
final static DocumentPolygonConfiguration
default()
-
-
Constructor Detail
-
DocumentPolygonConfiguration
DocumentPolygonConfiguration(JSONObject json)
-
DocumentPolygonConfiguration
DocumentPolygonConfiguration(UserGuidanceVisibility visibility, PolygonStyle documentOk, PolygonStyle documentNotOk, PolygonStyle autoSnapProgress)
-
-
Method Detail
-
getVisibility
final UserGuidanceVisibility getVisibility()
Determines the visibility mode for the polygon. Default is ENABLED
-
setVisibility
final Unit setVisibility(UserGuidanceVisibility visibility)
Determines the visibility mode for the polygon. Default is ENABLED
-
getDocumentOk
final PolygonStyle getDocumentOk()
Configuration of the polygon when the detected document status is 'OK'.
-
setDocumentOk
final Unit setDocumentOk(PolygonStyle documentOk)
Configuration of the polygon when the detected document status is 'OK'.
-
getDocumentNotOk
final PolygonStyle getDocumentNotOk()
Configuration of the polygon when the detected document status is 'not OK'.
-
setDocumentNotOk
final Unit setDocumentNotOk(PolygonStyle documentNotOk)
Configuration of the polygon when the detected document status is 'not OK'.
-
getAutoSnapProgress
final PolygonStyle getAutoSnapProgress()
Configuration of the animated polygon when the document is being scanned for capturing in 'auto snapping mode'.
-
setAutoSnapProgress
final Unit setAutoSnapProgress(PolygonStyle autoSnapProgress)
Configuration of the animated polygon when the document is being scanned for capturing in 'auto snapping mode'.
-
toJson
final JSONObject toJson()
-
default
final static DocumentPolygonConfiguration default()
-
-
-
-