Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate FollowPuckViewportStateOptions.animationDurationMs. #1256

Merged
merged 3 commits into from
Apr 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Mapbox welcomes participation and contributions from everyone.
* Add `LocationIndicatorLayer.bearingTransition` API to control transition of bearing property. ([1207](https://github.com/mapbox/mapbox-maps-android/pull/1207))
* Add `MapboxConcurrentGeometryModificationException` with detailed information instead of `ConcurrentModificationException` that is thrown when GeoJson data is mutated. ([1248](https://github.com/mapbox/mapbox-maps-android/pull/1248))
* Introduce `line-trim-offset` property for LineLayer. ([1252](https://github.com/mapbox/mapbox-maps-android/pull/1252))
* Deprecate `FollowPuckViewportStateOptions.animationDurationMs`, the initial transition will be handled properly by the Viewport plugin internally. ([1256](https://github.com/mapbox/mapbox-maps-android/pull/1256))

## Bug fixes 🐞
* Fix PolygonAnnotation and PolylineAnnotation being distorted while dragging with 3D terrain. ([#1223](https://github.com/mapbox/mapbox-maps-android/pull/1223))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ class FollowPuckViewportStateOptions private constructor(
*
* Defaults to [DEFAULT_STATE_ANIMATION_DURATION_MS] milliseconds
*/
@Deprecated("AnimationDurationMs is not needed any more, the transition will be handled properly internally.")
Copy link
Contributor

@kiryldz kiryldz Apr 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume internally it's not handled for now - that's why we can't drop it right now, correct?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, the actual fix will land in rc.1, we don't want to rush the fix itself, Deprecate affects public API, so that's why we add the Deprecated in beta.1

val animationDurationMs: Long
) {
/**
Expand Down Expand Up @@ -152,6 +153,7 @@ class FollowPuckViewportStateOptions private constructor(
*
* Defaults to [DEFAULT_STATE_ANIMATION_DURATION_MS] milliseconds
*/
@Deprecated("AnimationDurationMs is not needed any more, the transition will be handled properly internally.")
fun animationDurationMs(duration: Long) = apply {
this.animationDurationMs = duration
}
Expand Down