-
Notifications
You must be signed in to change notification settings - Fork 16
/
TKMoveGestureRecognizer.h
129 lines (101 loc) · 5.94 KB
/
TKMoveGestureRecognizer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
//
// TKMoveViewGestureRecognizer.h
// Created by Devin Ross on 4/16/15.
//
/*
curryfire || https://github.com/devinross/curry-fire
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/
@import UIKit;
@import curry;
@import pop;
/** The axis that a move gesture could move in. */
typedef enum {
TKMoveGestureAxisXY = 0,
TKMoveGestureAxisX = 1,
TKMoveGestureAxisY = 2,
} TKMoveGestureAxis;
/** `TKMoveGestureRecognizer` is a pan-gesture-recognizer built to move a view between certain locations. */
@interface TKMoveGestureRecognizer : UIPanGestureRecognizer
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@return A newly minted move-gesture-recognizer.
*/
+ (instancetype) gestureWithAxis:(TKMoveGestureAxis)axis movableView:(UIView*)movableView;
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@param locations An array of locations that the view can move to. If the axis is X&Y, then the array should contain `NSValue` objects with a `CGPoint`. Otherwise, it should an array of `NSNumbers`.
@return A newly minted move-gesture-recognizer.
*/
+ (instancetype) gestureWithAxis:(TKMoveGestureAxis)axis movableView:(UIView*)movableView locations:(NSArray*)locations;
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@param locations An array of locations that the view can move to. If the axis is X&Y, then the array should contain `NSValue` objects with a `CGPoint`. Otherwise, it should an array of `NSNumbers`.
@param block A callback block for the gesture-recognizer.
@return A newly minted move-gesture-recognizer.
*/
+ (instancetype) gestureWithAxis:(TKMoveGestureAxis)axis movableView:(UIView *)movableView locations:(NSArray*)locations moveHandler:(void (^)(TKMoveGestureRecognizer *gesture, CGPoint position, CGPoint location ))block;
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@return A newly minted move-gesture-recognizer.
*/
- (instancetype) initWithAxis:(TKMoveGestureAxis)axis movableView:(UIView*)movableView;
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@param locations An array of locations that the view can move to. If the axis is X&Y, then the array should contain `NSValue` objects with a `CGPoint`. Otherwise, it should an array of `NSNumbers`.
@return A newly minted move-gesture-recognizer.
*/
- (instancetype) initWithAxis:(TKMoveGestureAxis)axis movableView:(UIView*)movableView locations:(NSArray*)locations;
/** Creates and returns a gesture recognizer to move a view between points.
@param movableView The view that the gesture will move.
@param axis The directions the movable can move in.
@param locations An array of locations that the view can move to. If the axis is X&Y, then the array should contain `NSValue` objects with a `CGPoint`. Otherwise, it should an array of `NSNumbers`.
@param block A callback block for the gesture-recognizer.
@return A newly minted move-gesture-recognizer.
*/
- (instancetype) initWithAxis:(TKMoveGestureAxis)axis movableView:(UIView *)movableView locations:(NSArray*)locations moveHandler:(void (^)(TKMoveGestureRecognizer *gesture, CGPoint position, CGPoint location ))block;
/** The callback of the gesture-recognizer. */
@property (nonatomic,copy,setter=setMoveHandler:) void (^moveHandler)(TKMoveGestureRecognizer *gesture, CGPoint position, CGPoint location);
/** The directions the movable can go. */
@property (nonatomic,readonly) TKMoveGestureAxis axis;
/** A flag that indicates if the gesture is active. */
@property (nonatomic,readonly) BOOL moving;
/** A flag that indicates if the movable view is moving to a resting location. */
@property (nonatomic,readonly) BOOL animating;
/** If YES, it keeps the view within the location bounds. Otherwise NO. */
@property (nonatomic,assign) BOOL canMoveOutsideLocationBounds;
/** The view that the gesture will move. */
@property (nonatomic,strong) UIView *movableView;
/** Resting locations for the movable view. */
@property (nonatomic,strong) NSArray *locations;
/** The POPSpringAnimation used to animate the movable view to a resting place. */
@property (nonatomic,strong) POPSpringAnimation *snapBackAnimation;
/** Reduces the velocity used to determine the resting location after a gesture. */
@property (nonatomic,assign) CGFloat velocityDamping;
/** Animates the movable view to a certain point.
@param point The point the movable view will relocate to.
*/
- (void) moveToPoint:(CGPoint)point;
@end