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

Mark camera functions as unsupported for globe projection #1440

Merged
merged 1 commit into from
Jul 11, 2022

Conversation

tobrun
Copy link
Member

@tobrun tobrun commented Jul 11, 2022

Mark camera functions as unsupported for globe projection,
Invocation results in a no-op.

Pull request checklist:

  • Write tests for all new functionality. If tests were not written, please explain why.
  • Add documentation comments for any added or updated public APIs.
  • Add any new public, top-level symbols to the Jazzy config's custom_categories (scripts/doc-generation/.jazzy.yaml)
  • Describe the changes in this PR, especially public API changes.
  • Add a changelog entry to to bottom of the relevant section (typically the ## main heading near the top).
  • Update the guides (internal access only), README.md, and DEVELOPING.md if their contents are impacted by these changes.
  • Review and agree to the Contributor License Agreement (CLA).

@tobrun tobrun added the skip changelog Add this label if this item does not need to be included in the changelog label Jul 11, 2022
@tobrun tobrun requested a review from a team as a code owner July 11, 2022 08:53
@tobrun tobrun self-assigned this Jul 11, 2022
@@ -314,6 +314,8 @@ public final class MapboxMap: MapboxMapProtocol {

/// Calculates a `CameraOptions` to fit a `CoordinateBounds`
///
/// This API isn't supported by Globe projection.
///
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to also log a warning message to the console when this(and others) method is called and projection is globe? To increase chances this message is seen - sometimes docs are not read that carefully(or at all).
Something like this:

if style.projection.name == .globe {
    Log.warning(forMessage: "Camera API isn't supported by Globe projection", category: "Camera")
}

Copy link
Member Author

Choose a reason for hiding this comment

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

This is done upstream already :)

@tobrun tobrun merged commit 6a62f01 into main Jul 11, 2022
@tobrun tobrun deleted the tvn-api-ref-doc-globe branch July 11, 2022 10:35
OdNairy pushed a commit that referenced this pull request Jul 14, 2022
OdNairy pushed a commit that referenced this pull request Jul 14, 2022
OdNairy added a commit that referenced this pull request Jul 14, 2022
* Update changelog (#1418)

* Add style toggle to location example (#1413)

* [XCParty] Add tag name if HEAD has any (#1424)

* [XCParty] Export crash reports for XCResult (#1434)

* Expose a way to initialise TilesetDescriptorOptionsForTilesets (#1431)

* Add cast shadow option to 3d puck config (#1435)

* Mark camera functions as unsupported for globe projection, invocation results in a no-op (#1440)

* Rotation gesture threshold and simultaneousRotateAndPinchToZoomEnabled option (#1429)

* Add option to support measurements from the only last run (#1445)

* Update examples (#1443)

* Fix flaky test (#1450)

* Fix view annotation losing its feature association after update (#1446)

* Enable `modelCastsShadow` option for custom location puck config (#1447)

* enabled model casts shadows option for custom location puck configuration

* Provide default value for list of last-run metrics (#1453)

* Update CoreMaps to `10.7.0-rc.1` (#1456)

* Update CoreMaps to 10.7.0-rc.1

* Update changelog

* Update changelog header (#1459)

* Update 10.7.0 versions (#1460)

Co-authored-by: ZiZi <44972592+ZiZasaurus@users.noreply.github.com>
Co-authored-by: Roman Laitarenko <roman.laitarenko@mapbox.com>
Co-authored-by: Tobrun <tobrun.van.nuland@gmail.com>
OdNairy added a commit that referenced this pull request Jul 14, 2022
* Add style toggle to location example (#1413)

* [XCParty] Add tag name if HEAD has any (#1424)

* [XCParty] Export crash reports for XCResult (#1434)

* Expose a way to initialise TilesetDescriptorOptionsForTilesets (#1431)

* Add cast shadow option to 3d puck config (#1435)

* Mark camera functions as unsupported for globe projection, invocation results in a no-op (#1440)

* Rotation gesture threshold and simultaneousRotateAndPinchToZoomEnabled option (#1429)

* Add option to support measurements from the only last run (#1445)

* Update examples (#1443)

* Fix flaky test (#1450)

* Fix view annotation losing its feature association after update (#1446)

* Enable `modelCastsShadow` option for custom location puck config (#1447)

* enabled model casts shadows option for custom location puck configuration

* Provide default value for list of last-run metrics (#1453)

* Update CoreMaps to `10.7.0-rc.1` (#1456)

* Update CoreMaps to 10.7.0-rc.1

* Update changelog

* Update changelog header (#1459)

* Update 10.7.0 versions (#1460)

Co-authored-by: ZiZi <44972592+ZiZasaurus@users.noreply.github.com>
Co-authored-by: Roman Laitarenko <roman.laitarenko@mapbox.com>
Co-authored-by: Tobrun <tobrun.van.nuland@gmail.com>
maios added a commit that referenced this pull request Mar 24, 2023
maios added a commit that referenced this pull request Mar 24, 2023
* Add missing changelog entries (#1440)

---------

Co-authored-by: Roman Gardukevich <roman.gardukevich@mapbox.com>
Co-authored-by: Ivan Persidsky <ivan.persidskii@mapbox.com>
Co-authored-by: Roman Laitarenko <roman.laitarenko@mapbox.com>
evil159 pushed a commit that referenced this pull request Mar 31, 2023
OdNairy pushed a commit that referenced this pull request Apr 5, 2023
OdNairy pushed a commit that referenced this pull request Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog Add this label if this item does not need to be included in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants