Label Capture Basic Overlay

Defined in framework ScanditLabelCapture

SDCLabelCaptureBasicOverlay

@interface SDCLabelCaptureBasicOverlay : NSObject <SDCDataCaptureOverlay>

Added in version 6.0.0

Overlay for label capture that displays captured labels and their fields on top of the frames. When labels are successfully recognized, the label background as well as the fields are highlighted. Fields are highlighted using a default brush (capturedFieldBrush, predictedFieldBrush), a brush set through a user-defined SDCLabelCaptureBasicOverlayDelegate or calls to setBrush:forField:ofLabel:.

+ overlayWithLabelCapture:forDataCaptureView:

+ (instancetype)overlayWithLabelCapture:(nonnull SDCLabelCapture *)labelCapture
                     forDataCaptureView:(nullable SDCDataCaptureView *)view

Added in version 6.0.0

Constructs a new overlay to visualize the process of label capture. When view is non-nil, the overlay is automatically added to the view. Otherwise, the overlay needs to be added through a call to SDCDataCaptureView.addOverlay:.

+ overlayWithLabelCapture:

+ (instancetype)overlayWithLabelCapture:(nonnull SDCLabelCapture *)labelCapture

Added in version 6.0.0

Constructs a new overlay to visualize the process of label capture. The overlay needs to be added through a call to SDCDataCaptureView.addOverlay:.

delegate

@property (nonatomic, weak, nullable) id<SDCLabelCaptureBasicOverlayDelegate> delegate

Added in version 6.0.0

- setBrush:forField:ofLabel:

- (void)setBrush:(SDCBrush *)brush
        forField:(SDCLabelField *)field
         ofLabel:(SDCCapturedLabel *)label

Added in version 6.0.0

The method can be called to change the visualization style of a field. This method is thread-safe; it can be called from any thread.

When delegate is set to a non-nil instance, the delegate continues to be asked for the brush to use for this field whenever the state changes, thereby replacing any brushes set by calling setBrush:forField:ofLabel:.

- setBrush:forLabel:

- (void)setBrush:(SDCBrush *)brush
        forLabel:(SDCCapturedLabel *)label

Added in version 6.0.0

The method can be called to change the visualization style of a label. This method is thread-safe; it can be called from any thread.

When delegate is set to a non-nil instance, the delegate continues to be asked for the brush to use for this label whenever the state of one its fields changes, thereby replacing any brushes set by calling setBrush:forLabel:.

defaultPredictedFieldBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultPredictedFieldBrush

Added in version 6.4.0

The default brush applied to predicted fields. This is the brush used if SDCLabelCaptureBasicOverlayDelegate is not set.

defaultCapturedFieldBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultCapturedFieldBrush

Added in version 6.4.0

The default brush applied to captured fields. This is the brush used if SDCLabelCaptureBasicOverlayDelegate is not set.

defaultLabelBrush

@property (class, nonatomic, nonnull, readonly) SDCBrush *defaultLabelBrush

Added in version 6.4.0

The default brush used for drawing labels. This brush is used when no delegate is set, or the SDCLabelCaptureBasicOverlayDelegate.labelCaptureBasicOverlay:brushForLabel: returns a nil brush.

predictedFieldBrush

@property (nonatomic, strong, nonnull) SDCBrush *predictedFieldBrush

Added in version 6.4.0

The brush applied to predicted fields if no SDCLabelCaptureBasicOverlayDelegate is set. By default this brush is set to defaultPredictedFieldBrush.

The brush applied to predicted fields if no SDCLabelCaptureBasicOverlayDelegate is set.

capturedFieldBrush

@property (nonatomic, strong, nonnull) SDCBrush *capturedFieldBrush

Added in version 6.4.0

The brush applied to captured fields if no SDCLabelCaptureBasicOverlayDelegate is set. By default this brush is set to defaultCapturedFieldBrush.

labelBrush

@property (nonatomic, strong, nonnull) SDCBrush *labelBrush

Added in version 6.4.0

The brush used for drawing labels if no delegate is set, or the SDCLabelCaptureBasicOverlayDelegate.labelCaptureBasicOverlay:brushForLabel: returns a nil brush. By default this brush is set to defaultLabelBrush.

defaultPredictedFieldBrush

@property (nonatomic, strong, nonnull) SDCBrush *defaultPredictedFieldBrush

Added in version 6.0.0

The default brush applied to predicted fields. This is the brush used if SDCLabelCaptureBasicOverlayDelegate is not set.

Deprecated since version 6.4.0: Replaced by predictedFieldBrush.

defaultCapturedFieldBrush

@property (nonatomic, strong, nonnull) SDCBrush *defaultCapturedFieldBrush

Added in version 6.0.0

The default brush applied to captured fields. This is the brush used if SDCLabelCaptureBasicOverlayDelegate is not set.

Deprecated since version 6.4.0: Replaced by capturedFieldBrush.

defaultLabelBrush

@property (nonatomic, strong, nonnull) SDCBrush *defaultLabelBrush

Added in version 6.0.0

The default brush used for drawing labels. This brush is used when no delegate is set, or the SDCLabelCaptureBasicOverlayDelegate.labelCaptureBasicOverlay:brushForLabel: returns a nil brush.

Deprecated since version 6.4.0: Replaced by labelBrush.

shouldShowScanAreaGuides

@property (nonatomic, assign) BOOL shouldShowScanAreaGuides

Added in version 6.0.0

Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is NO.

viewfinder

@property (nonatomic, strong, nullable) id<SDCViewfinder> viewfinder

Added in version 6.8.0

Sets the viewfinder. By default, the viewfinder is nil. Set this to an instance of SDCViewfinder if you want to draw a viewfinder.