Refactor gestures #677
Merged
Refactor gestures #677
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generalize the name to MapboxMapProtocol that can be used throughout the SDK. SDK seems small enough that per-component dependency inversion feels unnecessary and might negatively impact binary size.
Inject MapboxMap into PinchGestureHandler instead.
macdrevx
added
breaking change ⚠️
Sources/MapboxMaps/Gestures/GestureHandlers/DoubleTapGestureHandler.swift
Outdated
Show resolved
Hide resolved
|
|
||
| delegate.pinchEnded() | ||
| mapboxMap.setCamera( | ||
| to: CameraOptions( |
There was a problem hiding this comment.
nit: indentation feels weird here.
nit: make camera options on a different line
There was a problem hiding this comment.
I think this indentation is advantageous for a few reasons…
- It keeps the lines from getting too long because Xcode's indention behaviors only increase by 4 spaces per level when you indent this way.
- It helps to avoid needing to reindent subsequent lines if, for example, you rename
setCameraorCameraOptionsdown the road. (unlikely in this situation, but as a general rule, this is useful) - It provides a natural visual hierarchy of nested invocations and their associated parameters.
There was a problem hiding this comment.
Is this a style that we are choosing to follow in our codebase? I see the arguments for it, but IMO, I think this style of indentation is harder to read and follow. It doesn't feel swifty.
I think we should standardize these things in our coding style guide
There was a problem hiding this comment.
I think we should standardize these things in our coding style guide
Agreed. We don't have a standard here, so right now it's anyone's opinion.
Merged
nishant-karajgikar
pushed a commit
that referenced
this pull request
Sep 22, 2021
#### Breaking Changes - Pan deceleration has been temporarily removed - `TapGestureHandler.init` was previously public by mistake and is now internal - The behavior of `GestureManager.options` has been updated to better reflect the `isEnabled` state of the associated gesture recognizers - The gesture recognizer properties of `GestureManager` are no longer `Optional` - `GestureType` has been redesigned so that its cases have a 1-1 relationship with the built-in gestures #### Public API Additions - `CameraState`'s fields are now `var`s instead of `let`s for testing purposes, and a public, memberwise initializer has been added. - `PanScrollingMode` now conforms to `CaseIterable` - `GestureType` now conforms to `CaseIterable` #### Bug fixes - GestureManager no longer sets itself as the delegate of all gestures in MapView when its options change #### Internal Refactoring - Generalizes `CameraAnimatorMapboxMap` by renaming it to `MapboxMapProtocol` so that it can be used throughout the SDK. SDK seems small enough that per-component dependency inversion feels unnecessary and might negatively impact binary size. - Removes old `GestureHandlerDelegate` by injecting `MapboxMap` and `CameraAnimationsManager` into each gesture handler to allow each handler to manipulate the camera directly. - Removes unnecessary `GestureContextProvider` - Refactors handlers and `GestureManager` for dependency injection and more thorough tests - Tidies up handlers and `GestureManager` and associated tests for greater consistency
nishant-karajgikar
added a commit
that referenced
this pull request
Sep 22, 2021
* remove hapticFeedbackEnabled (#663) * remove hapticFeedbackEnabled` * clean up changelog * Make gestureOptions.decelarationRate the source of truth (#662) * making gesture options decelaration rate the source of truth * clean up changelog * fix indentation * Internalize UIGestureRecognizerDelegate (#669) * seperated gesture recognizer delegate into a new class and fixed downstream breaks * adding changelog * swift lint and code clean up * adding a comment * pr comments * Refactor gestures (#677) #### Breaking Changes - Pan deceleration has been temporarily removed - `TapGestureHandler.init` was previously public by mistake and is now internal - The behavior of `GestureManager.options` has been updated to better reflect the `isEnabled` state of the associated gesture recognizers - The gesture recognizer properties of `GestureManager` are no longer `Optional` - `GestureType` has been redesigned so that its cases have a 1-1 relationship with the built-in gestures #### Public API Additions - `CameraState`'s fields are now `var`s instead of `let`s for testing purposes, and a public, memberwise initializer has been added. - `PanScrollingMode` now conforms to `CaseIterable` - `GestureType` now conforms to `CaseIterable` #### Bug fixes - GestureManager no longer sets itself as the delegate of all gestures in MapView when its options change #### Internal Refactoring - Generalizes `CameraAnimatorMapboxMap` by renaming it to `MapboxMapProtocol` so that it can be used throughout the SDK. SDK seems small enough that per-component dependency inversion feels unnecessary and might negatively impact binary size. - Removes old `GestureHandlerDelegate` by injecting `MapboxMap` and `CameraAnimationsManager` into each gesture handler to allow each handler to manipulate the camera directly. - Removes unnecessary `GestureContextProvider` - Refactors handlers and `GestureManager` for dependency injection and more thorough tests - Tidies up handlers and `GestureManager` and associated tests for greater consistency * Pan Deceleration (#692) * update changelog * fix changelog * Gesture Options Cleanup (#696) * wip * Change double tap to zoom out to "double touch" * Fix warning * Lint * Update changelog * [run device tests] * Use explicit self Co-authored-by: Andrew Hershberger <andrew.hershberger@mapbox.com> Co-authored-by: Nishant Karajgikar <nishant.karajgikar@mapbox.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request checklist:
Summary of changes
Refactors gestures for better modularity, maintainability, and testability.
Breaking Changes
TapGestureHandler.initwas previously public by mistake and is now internalGestureManager.optionshas been updated to better reflect theisEnabledstate of the associated gesture recognizersGestureManagerare no longerOptionalGestureTypehas been redesigned so that its cases have a 1-1 relationship with the built-in gesturesPublic API Additions
CameraState's fields are nowvars instead oflets for testing purposes, and a public, memberwise initializer has been added.PanScrollingModenow conforms toCaseIterableGestureTypenow conforms toCaseIterableBug fixes
Internal Refactoring
CameraAnimatorMapboxMapby renaming it toMapboxMapProtocolso that it can be used throughout the SDK. SDK seems small enough that per-component dependency inversion feels unnecessary and might negatively impact binary size.GestureHandlerDelegateby injectingMapboxMapandCameraAnimationsManagerinto each gesture handler to allow each handler to manipulate the camera directly.GestureContextProviderGestureManagerfor dependency injection and more thorough testsGestureManagerand associated tests for greater consistency