Skip navigation links
< A C D E F G H I L N P R S T 

<

<no name provided>() - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Continuously notified about contour detection results.

A

AdaptiveFinderOverlayView - Class in io.scanbot.sdk.ui.camera
Represents Finder view overlay, which automatically adjusts to the document format according to AdaptiveFinderOverlayView.requiredAspectRatios
AdaptiveFinderOverlayView(context, attr) - Constructor for class io.scanbot.sdk.ui.camera.AdaptiveFinderOverlayView
Represents Finder view overlay, which automatically adjusts to the document format according to AdaptiveFinderOverlayView.requiredAspectRatios
AdaptiveFinderOverlayViewKt - Class in io.scanbot.sdk.ui.camera
 
addResultHandler(handler) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Registers result handler which will be notified about contour detection results.
attach(cameraView, detector) - Static method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Convenience method for creating new class ContourDetectorFrameHandler and adding it as FrameHandler to given camera view.
attach(cameraView, detector) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.Companion
Convenience method for creating new class ContourDetectorFrameHandler and adding it as FrameHandler to given camera view.
attach(cameraView, contourDetector) - Static method in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController
Convenience method for attaching class DocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Static method in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController
Convenience method for attaching class DocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, contourDetector) - Method in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController.Companion
Convenience method for attaching class DocumentAutoSnappingController to IScanbotCameraView
attach(cameraView, frameHandler) - Method in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController.Companion
Convenience method for attaching class DocumentAutoSnappingController to IScanbotCameraView

C

calculateLine(start, end) - Method in class io.scanbot.sdk.util.view.PolygonHelper.Line
Calculate all 3 components of the line
checkPolygonSize(polygon) - Static method in class io.scanbot.sdk.util.view.PolygonHelper
 
clearResultHandlers() - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Unregisters all handlers.
Companion - Static variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
 
Companion - Static variable in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController
 
ContourDetectorFrameHandler - Class in io.scanbot.sdk.contourdetector
Performs contour detection on camera preview frames. Outputs results via interface ContourDetectorFrameHandler.ResultHandler (.addResultHandler).
ContourDetectorFrameHandler(context, contourDetector) - Constructor for class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Performs contour detection on camera preview frames. Outputs results via interface ContourDetectorFrameHandler.ResultHandler (.addResultHandler).
ContourDetectorFrameHandler.Companion - Class in io.scanbot.sdk.contourdetector
 
ContourDetectorFrameHandler.ContourDetectorResultHandler - Class in io.scanbot.sdk.contourdetector
Successor-class needed for cross-platform implementation
ContourDetectorFrameHandler.DetectedFrame - Class in io.scanbot.sdk.contourdetector
Contour detection results alongside with information about frame
ContourDetectorFrameHandler.ResultHandler - Interface in io.scanbot.sdk.contourdetector
 
ContourDetectorResultHandler() - Constructor for class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.ContourDetectorResultHandler
Successor-class needed for cross-platform implementation

D

detach() - Method in class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController
 
DetectedFrame(detectionResult, polygon, frameOrientation, frameWidth, frameHeight) - Constructor for class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Deprecated. 
DetectedFrame(detectionResult, polygon, frameOrientation, frameWidth, frameHeight, detectionScore, finderRect, requiredPageAspectRatios) - Constructor for class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
 
detectionResult - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Contour detection result status. Typically used to decide whether contour detection was successful or not and what can be improved from user side.
detectionScore - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Score of detected frame as double value in [0.0, 100.0].
DocumentAutoSnappingController - Class in io.scanbot.sdk.contourdetector
Controls auto-snapping for a document based on it's detected contours.
DocumentAutoSnappingController(cameraView, contourDetectorFrameHandler) - Constructor for class io.scanbot.sdk.contourdetector.DocumentAutoSnappingController
 
DocumentAutoSnappingController.Companion - Class in io.scanbot.sdk.contourdetector
 
DocumentAutoSnappingControllerKt - Class in io.scanbot.sdk.contourdetector
 

E

edgeLine - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 

F

finderRect - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
 
frameHeight - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Height of the frame before rotation
frameOrientation - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Rotation of the frame in degrees relatively to what is seen on the screen. Frames might come in different orientation from the camera, that's why this value is needed. You might use it to compensate rotation of .polygon.
frameWidth - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Width of the frame before rotation

G

getAngleInDegrees() - Method in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
getContourDetectorFrameHandler() - Method in class io.scanbot.sdk.ui.camera.AdaptiveFinderOverlayView
 
getDistanceToPoint(point) - Method in class io.scanbot.sdk.util.view.PolygonHelper.Line
Calculates distance to point Should be used after line components are calculated
getDrawingPolygon(polygon, drawingPolygon) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Processes original polygon with coordinates 0..1 to drawing polygon by multiplying them by view dimensions
getHandle() - Method in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
getIntersectionPoint(line) - Method in class io.scanbot.sdk.util.view.PolygonHelper.Line
 
getPolygonFromDrawingPolygon(drawingPolygon, polygon) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Processes drawing polygon coordinates to polygon with coordinates 0..1 by dividing them by view dimensions

H

handleDetectionResult(requiredAspectRatios, detectionResult, frameWidth, frameHeight, frameOrientation, polygon) - Method in class io.scanbot.sdk.ui.camera.AdaptiveFinderOverlayView
 
handleFrame(previewFrame) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
 

I

io.scanbot.sdk.contourdetector - package io.scanbot.sdk.contourdetector
 
io.scanbot.sdk.ui.camera - package io.scanbot.sdk.ui.camera
 
io.scanbot.sdk.util.view - package io.scanbot.sdk.util.view
 
isDetectedLine - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
isEnabled() - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
 
isHorizontal() - Method in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 

L

lineA - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
lineB - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 

N

notifyHandlers(result) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
 

P

pointA - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
pointB - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
pointFarA - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
pointFarB - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
polygon - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
Detected polygon. If no polygon was detected - empty list. Points of polygon are normalized values between 0 and 1 relatively to the size of the frame.
PolygonHelper - Class in io.scanbot.sdk.util.view
Helper to make it easier to draw polygon on view
PolygonHelper.Edge - Class in io.scanbot.sdk.util.view
Represents edge of polygon with near and far points as well as intersecting lines from other edges
PolygonHelper.Line - Class in io.scanbot.sdk.util.view
Representation of line
polygonToLinePoints(polygon, points) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Calculates lines points from polygon multiplying 0..1 values by view dimensions and applying rotation matrix. Usually used on preview as it has camera rotation
polygonToPoints(polygon, points) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Calculates points from polygon multiplying 0..1 values by view dimensions and applying rotation matrix. Usually used on preview as it has camera rotation
prevX - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 
prevY - Variable in class io.scanbot.sdk.util.view.PolygonHelper.Edge
 

R

removeResultHandler(handler) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Unregisters handler.
requiredPageAspectRatios - Variable in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler.DetectedFrame
 

S

scaleLines(lines) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Performs scaling from 0..1 values to image pixel values
setAcceptedAngleScore(acceptedAngleScore) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion.
setAcceptedSizeScore(acceptedSizeScore) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0.
setEnabled(p) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
 
setImageSize(width, height) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Set scaled image size that will be drawn on screen
setLayout(left, top, right, bottom) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Sets layout of surface inside parent to compensate differences between viewport and preview sizes and draw polygon correctly
setRequiredAspectRatios(requiredPageAspectRatios) - Method in class io.scanbot.sdk.contourdetector.ContourDetectorFrameHandler
Set required PageAspectRatios.
setRotation(degrees) - Method in class io.scanbot.sdk.util.view.PolygonHelper
Set rotation in degrees for polygon

T

toFinderAspectRatios($receiver) - Static method in class io.scanbot.sdk.ui.camera.AdaptiveFinderOverlayViewKt
 
< A C D E F G H I L N P R S T 
Skip navigation links