Release v1.3.5

Fix interaction

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-> Please fill out this template when filing an issue.
+> Please fill out this template appropriately when filing a bug report.
 >
 > Please remove this line and everything above it before submitting.
 

FloatingPanel.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name                = "FloatingPanel"
-  s.version             = "1.3.3"
+  s.version             = "1.3.5"
   s.summary             = "FloatingPanel is a clean and easy-to-use UI component of a floating panel interface."
   s.description         = <<-DESC
 FloatingPanel is a clean and easy-to-use UI component for a new interface introduced in Apple Maps, Shortcuts and Stocks app.

Framework/Sources/FloatingPanel.swift

@@ -3,6 +3,7 @@
 //
 
 import UIKit
+import UIKit.UIGestureRecognizerSubclass // For Xcode 9.4.1
 
 ///
 /// FloatingPanel presentation model
@@ -35,16 +36,17 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
         return remains.count == 0
     }
 
-    let panGesture: FloatingPanelPanGestureRecognizer
+    let panGestureRecognizer: FloatingPanelPanGestureRecognizer
     var isRemovalInteractionEnabled: Bool = false
 
-    private var animator: UIViewPropertyAnimator?
+    fileprivate var animator: UIViewPropertyAnimator?
     private var initialFrame: CGRect = .zero
     private var initialScrollOffset: CGPoint = .zero
     private var initialScrollInset: UIEdgeInsets = .zero
     private var transOffsetY: CGFloat = 0
 
     var interactionInProgress: Bool = false
+    var isDecelerating: Bool = false
 
     // Scroll handling
     private var stopScrollDeceleration: Bool = false
@@ -68,17 +70,19 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                                                         layout: layout)
         self.behavior = behavior
 
-        panGesture = FloatingPanelPanGestureRecognizer()
+        panGestureRecognizer = FloatingPanelPanGestureRecognizer()
 
         if #available(iOS 11.0, *) {
-            panGesture.name = "FloatingPanelSurface"
+            panGestureRecognizer.name = "FloatingPanelSurface"
         }
 
         super.init()
 
-        surfaceView.addGestureRecognizer(panGesture)
-        panGesture.addTarget(self, action: #selector(handle(panGesture:)))
-        panGesture.delegate = self
+        panGestureRecognizer.floatingPanel = self
+
+        surfaceView.addGestureRecognizer(panGestureRecognizer)
+        panGestureRecognizer.addTarget(self, action: #selector(handle(panGesture:)))
+        panGestureRecognizer.delegate = self
     }
 
     func move(to: FloatingPanelPosition, animated: Bool, completion: (() -> Void)? = nil) {
@@ -107,9 +111,12 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                 self.updateLayout(to: to)
                 self.state = to
             }
-            animator.addCompletion { _ in
+            animator.addCompletion { [weak self] _ in
+                guard let `self` = self else { return }
+                self.animator = nil
                 completion?()
             }
+            self.animator = animator
             animator.startAnimation()
         } else {
             self.updateLayout(to: to)
@@ -127,8 +134,8 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
     private func getBackdropAlpha(with translation: CGPoint) -> CGFloat {
         let currentY = getCurrentY(from: initialFrame, with: translation)
 
-        let next = directionalPosition(with: translation)
-        let pre = redirectionalPosition(with: translation)
+        let next = directionalPosition(at: currentY, with: translation)
+        let pre = redirectionalPosition(at: currentY, with: translation)
         let nextY = layoutAdapter.positionY(for: next)
         let preY = layoutAdapter.positionY(for: pre)
 
@@ -146,7 +153,7 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
 
     public func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer,
                                   shouldRecognizeSimultaneouslyWith otherGestureRecognizer: UIGestureRecognizer) -> Bool {
-        guard gestureRecognizer == panGesture else { return false }
+        guard gestureRecognizer == panGestureRecognizer else { return false }
 
         /* log.debug("shouldRecognizeSimultaneouslyWith", otherGestureRecognizer) */
 
@@ -154,19 +161,29 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
             return true
         }
 
-        // all gestures of the tracking scroll view should be recognized in parallel
-        // and handle them in self.handle(panGesture:)
-        return scrollView?.gestureRecognizers?.contains(otherGestureRecognizer) ?? false
+        switch otherGestureRecognizer {
+        case is UIPanGestureRecognizer,
+             is UISwipeGestureRecognizer,
+             is UIRotationGestureRecognizer,
+             is UIScreenEdgePanGestureRecognizer,
+             is UIPinchGestureRecognizer:
+            // all gestures of the tracking scroll view should be recognized in parallel
+            // and handle them in self.handle(panGesture:)
+            return scrollView?.gestureRecognizers?.contains(otherGestureRecognizer) ?? false
+        default:
+            // Should always recognize tap/long press gestures in parallel
+            return true
+        }
     }
 
     public func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldBeRequiredToFailBy otherGestureRecognizer: UIGestureRecognizer) -> Bool {
-        guard gestureRecognizer == panGesture else { return false }
+        guard gestureRecognizer == panGestureRecognizer else { return false }
         /* log.debug("shouldBeRequiredToFailBy", otherGestureRecognizer) */
         return false
     }
 
     public func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldRequireFailureOf otherGestureRecognizer: UIGestureRecognizer) -> Bool {
-        guard gestureRecognizer == panGesture else { return false }
+        guard gestureRecognizer == panGestureRecognizer else { return false }
 
         /* log.debug("shouldRequireFailureOf", otherGestureRecognizer) */
 
@@ -252,7 +269,7 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                     // Fix the scroll offset in moving the panel from half and tip.
                     scrollView.contentOffset.y = initialScrollOffset.y + (initialScrollInset.top - scrollView.contentInset.top)
                 case .hidden:
-                    fatalError("A floating panel hidden must not be used by a user")
+                    fatalError("Now .hidden must not be used for a user interaction")
                 }
 
                 // Always hide a scroll indicator at the non-top.
@@ -265,7 +282,7 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                     unlockScrollView()
                 }
             }
-        case panGesture:
+        case panGestureRecognizer:
             let translation = panGesture.translation(in: panGesture.view!.superview)
             let location = panGesture.location(in: panGesture.view)
 
@@ -275,8 +292,10 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
                 return
             }
 
-            if let animator = self.animator, animator.isInterruptible {
-                animator.stopAnimation(true)
+            if let animator = self.animator {
+                if animator.isInterruptible {
+                    animator.stopAnimation(true)
+                }
                 self.animator = nil
             }
 
@@ -380,7 +399,7 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
 
         if isRemovalInteractionEnabled, isBottomState {
             let velocityVector = (distance != 0) ? CGVector(dx: 0,
-                                                            dy: max(min(velocity.y/distance, behavior.removalVelocity), 0.0)) : .zero
+                                                            dy: min(fabs(velocity.y)/distance, behavior.removalVelocity)) : .zero
 
 
 
@@ -427,8 +446,10 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
             self?.updateLayout(to: .hidden)
         }
         animator.addCompletion({ _ in
+            self.animator = nil
             completion?()
         })
+        self.animator = animator
         animator.startAnimation()
     }
 
@@ -495,22 +516,25 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
         let topBuffer = layoutAdapter.layout.topInteractionBuffer
         let bottomY = layoutAdapter.bottomY
         let bottomBuffer = layoutAdapter.layout.bottomInteractionBuffer
-
+        let topMax = layoutAdapter.topMaxY
+        let bottomMax = layoutAdapter.bottomMaxY
+        
         if let scrollView = scrollView, scrollView.panGestureRecognizer.state == .changed {
             let preY = surfaceView.frame.origin.y
             if preY > 0 && preY > y {
-                return max(topY, min(bottomY, y))
+                return max(max(topY, topMax), min(min(bottomY + bottomBuffer, bottomMax), y))
             }
         }
-        let topMax = layoutAdapter.topMaxY
-        let bottomMax = layoutAdapter.bottomMaxY
         return max(max(topY - topBuffer, topMax), min(min(bottomY + bottomBuffer, bottomMax), y))
     }
 
     private func startAnimation(to targetPosition: FloatingPanelPosition, at distance: CGFloat, with velocity: CGPoint) {
         log.debug("startAnimation", targetPosition, distance, velocity)
         let targetY = layoutAdapter.positionY(for: targetPosition)
-        let velocityVector = (distance != 0) ? CGVector(dx: 0, dy: max(min(velocity.y/distance, 30.0), -30.0)) : .zero
+
+        isDecelerating = true
+
+        let velocityVector = (distance != 0) ? CGVector(dx: 0, dy: min(fabs(velocity.y)/distance, 30.0)) : .zero
         let animator = behavior.interactionAnimator(self.viewcontroller, to: targetPosition, with: velocityVector)
         animator.addAnimations { [weak self] in
             guard let `self` = self else { return }
@@ -524,20 +548,21 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
         }
         animator.addCompletion { [weak self] pos in
             guard let `self` = self else { return }
+            self.isDecelerating = false
             guard
                 self.interactionInProgress == false,
                 animator == self.animator,
                 pos == .end
                 else { return }
+            self.animator = nil
             self.finishAnimation(at: targetPosition)
         }
-        animator.startAnimation()
         self.animator = animator
+        animator.startAnimation()
     }
 
     private func finishAnimation(at targetPosition: FloatingPanelPosition) {
         log.debug("finishAnimation \(targetPosition)")
-        self.animator = nil
         self.viewcontroller.delegate?.floatingPanelDidEndDecelerating(self.viewcontroller)
 
         stopScrollDeceleration = false
@@ -555,76 +580,43 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
 
         switch targetPosition {
         case .full:
-            return CGFloat(fabs(Double(currentY - topY)))
+            return CGFloat(fabs(currentY - topY))
         case .half:
-            return CGFloat(fabs(Double(currentY - middleY)))
+            return CGFloat(fabs(currentY - middleY))
         case .tip:
-            return CGFloat(fabs(Double(currentY - bottomY)))
+            return CGFloat(fabs(currentY - bottomY))
         case .hidden:
-            fatalError("A floating panel hidden must not be used by a user")
+            fatalError("Now .hidden must not be used for a user interaction")
         }
     }
 
-    private func directionalPosition(with translation: CGPoint) -> FloatingPanelPosition {
-        let currentY = getCurrentY(from: initialFrame, with: translation)
-
-        let supportedPositions = layoutAdapter.supportedPositions
-
-        if supportedPositions.count == 1 {
-            return state
-        }
-
-        switch supportedPositions {
-        case [.full, .half]: return translation.y >= 0 ? .half : .full
-        case [.half, .tip]: return translation.y >= 0 ? .tip : .half
-        case [.full, .tip]: return translation.y >= 0 ? .tip : .full
-        default:
-            let middleY = layoutAdapter.middleY
-
-            switch state {
-            case .full:
-                if translation.y <= 0 {
-                    return .full
-                }
-                return currentY > middleY ? .tip : .half
-            case .half:
-                return currentY > middleY ? .tip : .full
-            case .tip:
-                if translation.y >= 0 {
-                    return .tip
-                }
-                return currentY > middleY ? .half : .full
-            case .hidden:
-                fatalError("A floating panel hidden must not be used by a user")
-            }
-        }
+    private func directionalPosition(at currentY: CGFloat, with translation: CGPoint) -> FloatingPanelPosition {
+        return getPosition(at: currentY, with: translation, directional: true)
     }
 
-    private func redirectionalPosition(with translation: CGPoint) -> FloatingPanelPosition {
-        let currentY = getCurrentY(from: initialFrame, with: translation)
-
-        let supportedPositions = layoutAdapter.supportedPositions
+    private func redirectionalPosition(at currentY: CGFloat, with translation: CGPoint) -> FloatingPanelPosition {
+        return getPosition(at: currentY, with: translation, directional: false)
+    }
 
+    private func getPosition(at currentY: CGFloat, with translation: CGPoint, directional: Bool) -> FloatingPanelPosition {
+        let supportedPositions: Set = layoutAdapter.supportedPositions
         if supportedPositions.count == 1 {
             return state
         }
-
+        let isForwardYAxis = (translation.y >= 0)
         switch supportedPositions {
-        case [.full, .half]: return translation.y >= 0 ? .full : .half
-        case [.half, .tip]: return translation.y >= 0 ? .half : .tip
-        case [.full, .tip]: return translation.y >= 0 ? .full : .tip
+        case [.full, .half]:
+            return (isForwardYAxis == directional) ? .half : .full
+        case [.half, .tip]:
+            return (isForwardYAxis == directional) ? .tip : .half
+        case [.full, .tip]:
+            return (isForwardYAxis == directional) ? .tip : .full
         default:
             let middleY = layoutAdapter.middleY
-
-            switch state {
-            case .full:
-                return currentY > middleY ? .half : .full
-            case .half:
-                return .half
-            case .tip:
-                return currentY > middleY ? .tip : .half
-            case .hidden:
-                fatalError("A floating panel hidden must not be used by a user")
+            if currentY > middleY {
+                return (isForwardYAxis == directional) ? .tip : .half
+            } else {
+                return (isForwardYAxis == directional) ? .half : .full
             }
         }
     }
@@ -659,29 +651,27 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
             let middleY = layoutAdapter.middleY
             let bottomY = layoutAdapter.bottomY
 
-            let target: FloatingPanelPosition
+            let nextState: FloatingPanelPosition
             let forwardYDirection: Bool
 
+            /*
+             full <-> half <-> tip
+             */
             switch state {
             case .full:
-                target = .half
+                nextState = .half
                 forwardYDirection = true
             case .half:
-                if (currentY < middleY) {
-                    target = .full
-                    forwardYDirection = false
-                } else {
-                    target = .tip
-                    forwardYDirection = true
-                }
+                nextState = (currentY > middleY) ? .tip : .full
+                forwardYDirection = (currentY > middleY)
             case .tip:
-                target = .half
+                nextState = .half
                 forwardYDirection = false
             case .hidden:
-                fatalError("A floating panel hidden must not be used by a user")
+                fatalError("Now .hidden must not be used for a user interaction")
             }
 
-            let redirectionalProgress = max(min(behavior.redirectionalProgress(viewcontroller, from: state, to: target), 1.0), 0.0)
+            let redirectionalProgress = max(min(behavior.redirectionalProgress(viewcontroller, from: state, to: nextState), 1.0), 0.0)
 
             let th1: CGFloat
             let th2: CGFloat
@@ -797,12 +787,24 @@ class FloatingPanel: NSObject, UIGestureRecognizerDelegate, UIScrollViewDelegate
             targetContentOffset.pointee = scrollView.contentOffset
             stopScrollDeceleration = false
         } else {
+            let targetOffset = targetContentOffset.pointee
             userScrollViewDelegate?.scrollViewWillEndDragging?(scrollView, withVelocity: velocity, targetContentOffset: targetContentOffset)
+            // Stop scrolling on tip and half
+            if state != .full, targetOffset == targetContentOffset.pointee {
+                targetContentOffset.pointee.y = scrollView.contentOffset.y
+            }
         }
     }
 }
 
 class FloatingPanelPanGestureRecognizer: UIPanGestureRecognizer {
+    fileprivate var floatingPanel: FloatingPanel?
+    override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent) {
+        super.touchesBegan(touches, with: event)
+        if floatingPanel?.animator != nil {
+            self.state = .began
+        }
+    }
     override weak var delegate: UIGestureRecognizerDelegate? {
         get {
             return super.delegate

Framework/Sources/FloatingPanelController.swift

@@ -93,7 +93,7 @@ public class FloatingPanelController: UIViewController, UIScrollViewDelegate, UI
 
     // The underlying gesture recognizer for pan gestures
     public var panGestureRecognizer: UIPanGestureRecognizer {
-        return floatingPanel.panGesture
+        return floatingPanel.panGestureRecognizer
     }
 
     /// The current position of the floating panel controller's contents.
@@ -236,8 +236,9 @@ public class FloatingPanelController: UIViewController, UIScrollViewDelegate, UI
         // Don't re-layout the surface on SafeArea.Bottom enabled/disabled in interaction progress
         guard
             floatingPanel.layoutAdapter.safeAreaInsets != safeAreaInsets,
-            self.floatingPanel.interactionInProgress == false
-        else { return }
+            self.floatingPanel.interactionInProgress == false,
+            self.floatingPanel.isDecelerating == false
+            else { return }
 
         log.debug("Update safeAreaInsets", safeAreaInsets)
 

Framework/Sources/FloatingPanelLayout.swift

@@ -206,7 +206,7 @@ class FloatingPanelLayoutAdapter {
     }
 
     var topMaxY: CGFloat {
-        return layout is FloatingPanelFullScreenLayout ? 0.0 : -safeAreaInsets.top
+        return layout is FloatingPanelFullScreenLayout ? 0.0 : safeAreaInsets.top
     }
     var bottomMaxY: CGFloat { return safeAreaBottomY }
 

README.md

@@ -139,9 +139,9 @@ fpc.isRemovalInteractionEnabled = true // Optional: Let it removable by a swipe-
 self.present(fpc, animated: true, completion: nil)
 ```
 
-You can show a floating panel over UINavigationController from the containnee view controllers as a modality of `.overCurrentContext` style.
+You can show a floating panel over UINavigationController from the container view controllers as a modality of `.overCurrentContext` style.
 
-NOTE: FloatingPanelController has the custom presentation controller. If you would like to customize the presentation/dismissal, please see [FloatingPanelTransitioning](https://github.com/SCENEE/FloatingPanel/blob/feat-modality/Framework/Sources/FloatingPanelTransitioning.swift).
+NOTE: FloatingPanelController has the custom presentation controller. If you would like to customize the presentation/dismissal, please see [FloatingPanelTransitioning](https://github.com/SCENEE/FloatingPanel/blob/master/Framework/Sources/FloatingPanelTransitioning.swift).
 
 ## View hierarchy