//
//  SDLTouch.h
//  SmartDeviceLink-iOS
//
//  Created by Muller, Alexander (A.) on 6/14/16.
//  Copyright © 2016 smartdevicelink. All rights reserved.
//

#import <UIKit/UIKit.h>

@class SDLTouchEvent;

/// Identifies finger touch
typedef NS_ENUM(NSUInteger, SDLTouchIdentifier) {
    /// Touch was first finger
    SDLTouchIdentifierFirstFinger = 0,

    /// Touch was second finger
    SDLTouchIdentifierSecondFinger = 1
};

NS_ASSUME_NONNULL_BEGIN

/// Describes a touch location
@interface SDLTouch : NSObject

/**
 *  @abstract
 *      Initializes a touch.
 *  @param touchEvent
 *      Incoming touch event from onOnTouchEvent notification.
 *  @return SDLTouch
 *      Instance of SDLTouch.
 */
- (instancetype)initWithTouchEvent:(SDLTouchEvent *)touchEvent;

/**
 *  @abstract
 *      Identifier of the touch's finger. Refer to SDLTouchIdentifier for valid 
 *      identifiers.
 */
@property (nonatomic, assign, readonly) NSInteger identifier;

/**
 *  @abstract
 *      Location of touch point, in the head unit's coordinate system.
 */
@property (nonatomic, assign, readonly) CGPoint location;

/**
 *  @abstract
 *      Timestamp in which the touch occurred.
 */
@property (nonatomic, assign, readonly) NSUInteger timeStamp;

/**
 *  @abstract
 *      Returns whether or not this touch is a first finger.
 */
@property (nonatomic, assign, readonly) BOOL isFirstFinger;

/**
 *  @abstract
 *      Returns whether or not this touch is a second finger.
 */
@property (nonatomic, assign, readonly) BOOL isSecondFinger;

@end

NS_ASSUME_NONNULL_END