//
//  PPOverlaySubview.h
//  BarcodeFramework
//
//  Created by Jura on 06/06/14.
//  Copyright (c) 2015 MicroBlink Ltd. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "PPDetectionStatus.h"

/**
 * Protocol which all objects interested in receiving information about overlay subviews need to implement
 */
@protocol PPOverlaySubviewDelegate <NSObject>

/** Delegate method called when animation starts */
- (void)overlaySubviewAnimationDidStart:(id)overlaySubview;

/** Delegate method called when animation finishes */
- (void)overlaySubviewAnimationDidFinish:(id)overlaySubview;

@end

@class PPOcrLayout;
@class PPOverlayViewController;

/**
 * Common interface for all OverlaySubviews
 */
@protocol PPOverlaySubview <NSObject>

/** Delegate which is notified on Overlay events */
@property (nonatomic, assign) id<PPOverlaySubviewDelegate> delegate;

/** The overlay view controller containing this overlay subview (if any) */
@property (nonatomic, weak) PPOverlayViewController* overlay;

@optional

/**
 Overlay view appears and the scanning resumes. This happens when the camera view
 is opened, or when the app enters foreground with camera view displayed.
 */
- (void)overlayDidResumeScanning;

/**
 Overlay disappears and the scanning pauses. This happens when the camera view
 is closed, or when the app enters background with camera view displayed.
 */
- (void)overlayDidStopScanning;

/**
 Overlay started the new recognition cycle. Since recognition is done on video frames, 
 there might be multiple recognition cycles before the scanning completes
 */
- (void)overlayDidStartRecognition;

/**
 Overlay ended the recognition cycle with a certain result.
 The scanning result cannot be considered as valid, sometimes here are received objects which
 contain only partial scanning information.

 Use this method only if you need UI update on this event (although this is unnecessary in many cases).

 If you're interested in valid data, use cameraViewController:didOutputResults: method
 */
- (void)overlayDidFinishRecognitionWithResult:(id)result;

/**
 Overlay reports the progress of the current OCR/barcode scanning recognition cycle.
 Note: this is not the actual progress from the moment camera appears.
 This might not be meaningful for the user in all cases.
 */
- (void)overlayDidPublishProgress:(float)progress;

/**
 Overlay reports the status of the object detection. Scanning status contain information
 about whether the scan was successful, whether the user holds the device too far from
 the object, whether the angles was too high, or the object isn't seen on the camera in
 it's entirety. If the object was found, the corner points of the object are returned.
 */
- (void)overlayDidFindLocation:(NSArray*)points
                    withStatus:(PPDetectionStatus)status;

/**
 Overlay reports obtained ocr layout

 Besides the ocr layout itself, we get the ID of the layout so we can
 distinguish consecutive layouts of the same area on the image
 */
- (void)overlayDidObtainOcrLayout:(PPOcrLayout*)ocrLayout
                   withIdentifier:(NSString*)identifier;

/**
 Overlay ended the recognition cycle with a certain Scanning result.
 The scanning result can be considered as valid, meaning it can be presented to the user for inspection.
 Use this method only if you need UI update on this event (although this is unnecessary in many cases).
 The actual result will be passed to your PPPhotoPayDelegate object.
 */
- (void)overlayDidOutputResults:(NSArray*)results;

/**
 Overlay wants to remove all animations from a subview
 */
- (void)overlayWillRemoveAllAnimations;

/**
 Method called when a rotation to a given
 interface orientation is about to happen
 */
- (void)willRotateToInterfaceOrientation:(UIInterfaceOrientation)toInterfaceOrientation
                                duration:(NSTimeInterval)duration;

/**
 Method called immediately after the rotation from a given
 interface orientation happened
 */
- (void)didRotateFromInterfaceOrientation:(UIInterfaceOrientation)fromInterfaceOrientation;

/**
 Method called inside an animation block. Any changes you make
 to your UIView's inside this method will be animated
 */
- (void)willAnimateRotationToInterfaceOrientation:(UIInterfaceOrientation)toInterfaceOrientation
                                         duration:(NSTimeInterval)duration;

@end

/**
 Base class for all overlay subviews
 */
@interface PPOverlaySubview : UIView<PPOverlaySubview>

- (NSArray*)getSortedPoints:(NSArray*)points;

@end