ios/chrome/browser/scanner/ui_bundled/scanner_view.h

// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_SCANNER_UI_BUNDLED_SCANNER_VIEW_H_
#define IOS_CHROME_BROWSER_SCANNER_UI_BUNDLED_SCANNER_VIEW_H_

#import <AVFoundation/AVFoundation.h>
#import <UIKit/UIKit.h>

// Delegate manages the Scanner View.
@protocol ScannerViewDelegate

// Called when the close button is pressed.
- (void)dismissScannerView:(id)sender;

// Called when the torch button is pressed.
- (void)toggleTorch:(id)sender;

@end

// The view rendering the Scanner UI. The view contains the camera preview,
// a semi-transparent overlay with a transparent viewport, border around the
// viewport, the close and flash controls, and a label instructing the user to
// correctly position the scanned code.
@interface ScannerView : UIView

// The delegate which receives button events.
@property(nonatomic, weak) id<ScannerViewDelegate> delegate;

// Returns the viewport size. By default this is the size of the window the
// receiver is in, or CGSizeZero if it is not in a window.
@property(nonatomic, readonly) CGSize viewportSize;

// Returns the scanner caption. By default this caption returns nil
// and can be overridden in the subclass.
@property(nonatomic, readonly) NSString* caption;

- (instancetype)initWithFrame:(CGRect)frame
                     delegate:(id<ScannerViewDelegate>)delegate
    NS_DESIGNATED_INITIALIZER;

- (instancetype)initWithFrame:(CGRect)frame NS_UNAVAILABLE;

- (instancetype)initWithCoder:(NSCoder*)coder NS_UNAVAILABLE;

// Returns the displayed preview layer.
- (AVCaptureVideoPreviewLayer*)previewLayer;

// Sets the state of the torch button to enabled or disabled according to the
// value of `torchIsAvailable`.
- (void)enableTorchButton:(BOOL)torchIsAvailable;

// Sets the torch button icon to on or off based on the value of `torchIsOn`.
- (void)setTorchButtonTo:(BOOL)torchIsOn;

// Resets the frame of the preview layer to a CGRect with origin (0, 0) and
// size equal to `size`.
- (void)resetPreviewFrame:(CGSize)size;

// Rotates the preview layer by `angle`. Used for a transform which prevents the
// preview layer from rotating with the rest of the interface.
- (void)rotatePreviewByAngle:(CGFloat)angle;

// Rounds the parameters of the preview layer's transform.
- (void)finishPreviewRotation;

// Returns the normalised rectangle of interest required for the Vision request.
- (CGRect)viewportRegionOfInterest;

// Returns the rectangle in camera coordinates in which items should be
// recognized.
- (CGRect)viewportRectOfInterest;

// Displays a flash animation when a result is scanned. `completion` will be
// called when the animation completes.
- (void)animateScanningResultWithCompletion:(void (^)(void))completion;

@end

#endif  // IOS_CHROME_BROWSER_SCANNER_UI_BUNDLED_SCANNER_VIEW_H_