Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder Class Reference
Inheritance diagram for com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder:
com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperienceCriteriaHolder com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperienceCriteriaHolder com.kofax.kmc.kui.uicontrols.captureanimations.DocumentCaptureExperienceCriteriaHolder

Public Member Functions

 CaptureExperienceCriteriaHolder ()
 
boolean isStabilityThresholdEnabled ()
 
void setStabilityThresholdEnabled (boolean stabilityThresholdEnabled)
 
int getStabilityThreshold ()
 
void setStabilityThreshold (int stabilityThreshold)
 
boolean isPitchThresholdEnabled ()
 
void setPitchThresholdEnabled (boolean pitchThresholdEnabled)
 
int getPitchThreshold ()
 
void setPitchThreshold (int pitchThreshold)
 
boolean isRollThresholdEnabled ()
 
void setRollThresholdEnabled (boolean rollThresholdEnabled)
 
int getRollThreshold ()
 
void setRollThreshold (int rollThreshold)
 
boolean isFocusEnabled ()
 
void setFocusEnabled (boolean focusEnabled)
 
boolean isOrientationEnabled ()
 
void setOrientationEnabled (boolean enabled)
 

Detailed Description

This class allows all of the capture related parameters to be configured. The criteria are met before a picture is taken. The threshold parameters in this class are not set on the image capture view directly.

Constructor & Destructor Documentation

com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.CaptureExperienceCriteriaHolder ( )
inline

Member Function Documentation

int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.getPitchThreshold ( )
inline

Valid values are in the range [0, 45]. The default value is 15. A value of 45 disables level checking for pitch even if pitch threshold is enabled

Returns
int The pitch threshold value which needs to be met before taking a picture
See also
setPitchThreshold(int)
setPitchThresholdEnabled(boolean)
isPitchThresholdEnabled()
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.getRollThreshold ( )
inline

Valid values are in the range [0, 45]. A value of 45 disables level checking for roll.

Returns
int The roll threshold value which needs to be met before taking a picture
See also
setRollThreshold(int)
setRollThresholdEnabled(boolean)
isRollThresholdEnabled()
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.getStabilityThreshold ( )
inline

If enabled the stability threshold is checked before taking a picture.

Returns
The stability value which needs to be met before taking a picture
See also
setStabilityThreshold(int)
setStabilityThresholdEnabled(boolean)
isStabilityThresholdEnabled()
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.isFocusEnabled ( )
inline
Returns
boolean Whether the Focus constraint is enabled or not
See also
setFocusEnabled(boolean)
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.isOrientationEnabled ( )
inline

Checks if orientation constraint is enabled.

Returns
true
if enabled and
false
otherwise
See also
setOrientationEnabled(boolean)
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.isPitchThresholdEnabled ( )
inline
Returns
boolean Whether the pitch threshold is enabled or not
See also
setPitchThresholdEnabled(boolean)
setPitchThreshold(int)
getPitchThreshold()
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.isRollThresholdEnabled ( )
inline
Returns
boolean Whether the Roll threshold is enabled or not
See also
setRollThresholdEnabled(boolean)
setRollThreshold(int)
getRollThreshold()
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.isStabilityThresholdEnabled ( )
inline
Returns
boolean Whether the stability threshold is enabled or not
See also
setStabilityThresholdEnabled(boolean)
setStabilityThreshold(int)
getStabilityThreshold()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setFocusEnabled ( boolean  focusEnabled)
inline

A boolean that indicates whether the Focus constraint is enabled. If enabled, this criterion is checked before taking a picture. The default value is true. Leaving it enabled is advisable. Otherwise it is highly likely that out of focus images are captured.

Parameters
focusEnabledwhether the Focus constraint is enabled or not
See also
isFocusEnabled()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setOrientationEnabled ( boolean  enabled)
inline

Enables or disables orientation constraint.

This constraint checks that the orientation of the document matches the orientation of the target frame.

Enabled by default.

Parameters
enabledtrue to enable and false to disable.
See also
isOrientationEnabled()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setPitchThreshold ( int  pitchThreshold)
inline

If the pitch threshold constraint is enabled, and the device pitch is greater than the specified threshold, a picture will not be taken. Valid values are in the range [0, 45]. Values outside this range will throw KmcRuntimeException. The default value is 15. A value of 45 disables level checking for pitch.

Parameters
pitchThresholdThe pitch threshold value which needs to be met before taking a picture
Exceptions
KmcRuntimeException
See also
setPitchThresholdEnabled(boolean)
getPitchThreshold()
isPitchThresholdEnabled()
Note
This method takes precedence over com.kofax.kmc.kui.uicontrols.ImageCaptureView#setLevelThresholdPitch(int)
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setPitchThresholdEnabled ( boolean  pitchThresholdEnabled)
inline

A boolean that specifies whether the level threshold for pitch enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.

Parameters
pitchThresholdEnabledWhether the pitch threshold is enabled or not
See also
isPitchThresholdEnabled()
setPitchThreshold(int)
getPitchThreshold()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setRollThreshold ( int  rollThreshold)
inline

If the roll threshold constraint is enabled, and the device roll is greater than the specified threshold, a picture will not be taken. Valid values are in the range [0, 45]. Values outside this range will throw KmcRuntimeException. The default value is 15. A value of 45 disables level checking for roll.

Parameters
rollThresholdThe level threshold value for roll which needs to be met before taking a picture
Exceptions
KmcRuntimeException
See also
getRollThreshold()
setRollThresholdEnabled(boolean)
isRollThresholdEnabled()
Note
This method takes precedence over com.kofax.kmc.kui.uicontrols.ImageCaptureView#setLevelThresholdRoll(int)
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setRollThresholdEnabled ( boolean  rollThresholdEnabled)
inline

A boolean that specifies whether the level threshold for roll is enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.

Parameters
rollThresholdEnabledWhether the Roll threshold is enabled or not
See also
isRollThresholdEnabled()
setRollThreshold(int)
getRollThreshold()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setStabilityThreshold ( int  stabilityThreshold)
inline

If the stability threshold constraint is enabled, and the device stability is less than the specified threshold, a picture will not be taken. Valid values are in the range [0, 100], where 100 indicates that the device must be perfectly still to take a picture and 0 indicates that stability checking is turned off. Values outside this range will throw KmcRuntimeException. The default value is 15.

Parameters
stabilityThresholdThe stability value which needs to be met before taking a picture
Exceptions
KmcRuntimeException
See also
setStabilityThresholdEnabled(boolean)
isStabilityThresholdEnabled()
getStabilityThreshold()
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperienceCriteriaHolder.setStabilityThresholdEnabled ( boolean  stabilityThresholdEnabled)
inline

A boolean that specifies whether the stability threshold is enabled. If enabled, this criterion is checked before taking a picture. Default is enabled.

Parameters
stabilityThresholdEnabledWhether the stability threshold is enabled or not
See also
isStabilityThresholdEnabled()
setStabilityThreshold(int)
getStabilityThreshold()

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.