Added cameraThatFitsShape: direction: pitch: edgePadding: method

[d-prukop]

Fixes #13005

The current implementation uses the current pitch of the map to calculate the altitude. This addition allows for getting the proper altitude of the camera for an upcoming pitch change which allows for a smooth animation to the new pitch and altitude.

/cc @1ec5 @fabian-guerra @friedbunny @julianrex

[fabian-guerra]

I made a minor comment. Just make sure everything works correctly in:
cameraThatFitsShape:direction:edgePadding:

[fabian-guerra]

I may be wrong but if you pass 0 in this method it will ignore the current transformation state and calculate a 0 based pitch. Could you please test and confirm that this is not the case.

[d-prukop]

That would be true. I'll fix that

[fabian-guerra]

Same as above:

I may be wrong but if you pass 0 in this method it will ignore the current transformation state and calculate a 0 based pitch. Could you please test and confirm that this is not the case.

[d-prukop]

good catch

[d-prukop]

@fabian-guerra Thanks for catching those issues. I've updated the files.

[julianrex]

Looks good

[1ec5]

Before this PR can be merged, I think there would need to be a test or at least screenshots demonstrating that the returned camera actually fits the given shape snugly. I don’t see how this method accomplishes that task given that #2259 is still outstanding.

[d-prukop]

@1ec5 This will behave the same way as the current cameraThatFitsShape: direction: edgePadding: method but with the ability to send a predefined pitch to include in the calculations. The most important components in the MGLMapCamera that is returned from this are the center coordinate and the altitude. These are the unknown values and are what determines how the shape fits into the map view. If the intention is to animate to these new settings, calculating the unknown center and altitude with respect to the known final pitch and final heading is important.
The shape will not fit snugly until #2259 lands but this method will automatically benefit from that improvement when it does.

[d-prukop]

So... there's already a method called camera: fittingShape: edgePadding: that allows for passing in the heading and pitch through an MGLMapCamera object. Is it worth keeping this new method?

[1ec5]

Aha! I thought I remembered @bsudekum implemented that but couldn’t find #12213 for some reason. Thanks for digging it up. If I recall correctly, we gave it that awkward name in part because it doesn’t necessarily fit all the parameters that are passed in – it just tries to fit as many as possible. We felt that #2259 wouldn’t be a blocker because it makes no guarantees about actually fitting anything precisely.

It sounds like this PR is unnecessary given #12213.

[d-prukop]

Closed in favor of using the existing camera: fittingShape: edgePadding: method