Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

refs #6779: mobile SDK style transition options #7711

Merged
merged 16 commits into from
Jan 18, 2017
Merged

refs #6779: mobile SDK style transition options #7711

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
aeb20cb
refs #6779: first cut of iOS transition options
incanus Jan 13, 2017
b2b0198
use properties instead
incanus Jan 13, 2017
705cb6b
use auto
incanus Jan 13, 2017
fb9c416
[core] Fix calculation of delayed transitions
jfirebaugh Jan 17, 2017
59f5e7a
Merge remote-tracking branch 'origin/fix-7720' into 6779-style-transi…
incanus Jan 17, 2017
2c68ae7
re-enable transition delay due to #7756 fix
incanus Jan 17, 2017
2f4ee9c
Merge remote-tracking branch 'origin/master' into 6779-style-transiti…
incanus Jan 18, 2017
16d6a05
pipe Android support
incanus Jan 18, 2017
530e32b
docs comments
incanus Jan 18, 2017
6ddc216
clearer function naming
incanus Jan 18, 2017
1fa75dd
update macos for new function
incanus Jan 18, 2017
71947b6
exercise macos transition options
incanus Jan 18, 2017
264005b
upping checkstyle max file length to 2042 per chat with @zugaldia
incanus Jan 18, 2017
d2d4af9
minor comment clarity tweaks
incanus Jan 18, 2017
37f3c54
Merge remote-tracking branch 'origin/master' into 6779-style-transiti…
incanus Jan 18, 2017
6745984
update Android, iOS, and macOS changelogs
incanus Jan 18, 2017
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
7 changes: 7 additions & 0 deletions platform/darwin/src/MGLStyle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,13 @@ MGL_EXPORT
*/
- (void)removeImageForName:(NSString *)name;

#pragma mark Managing a Style’s Transition Options

- (void)setTransitionDuration:(NSTimeInterval)duration;
- (NSTimeInterval)transitionDuration;
- (void)setTransitionDelay:(NSTimeInterval)delay;
- (NSTimeInterval)transitionDelay;
Copy link
Contributor

Choose a reason for hiding this comment

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

These options should be exposed as properties.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

b2b0198


@end

NS_ASSUME_NONNULL_END
28 changes: 28 additions & 0 deletions platform/darwin/src/MGLStyle.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,34 @@ - (MGLImage *)imageForName:(NSString *)name
return spriteImage ? [[MGLImage alloc] initWithMGLSpriteImage:spriteImage] : nil;
}

#pragma mark Style transitions

- (void)setTransitionDuration:(NSTimeInterval)duration
{
mbgl::style::TransitionOptions transitionOptions = self.mapView.mbglMap->getTransitionOptions();
Copy link
Contributor

Choose a reason for hiding this comment

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

auto is typically used in situations like this to avoid repetition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

705cb6b

transitionOptions.duration = MGLDurationInSeconds(duration);
self.mapView.mbglMap->setTransitionOptions(transitionOptions);
}

- (NSTimeInterval)transitionDuration
{
const mbgl::style::TransitionOptions transitionOptions = self.mapView.mbglMap->getTransitionOptions();
return MGLSecondsFromDuration(transitionOptions.duration.value_or(mbgl::Duration::zero()));
}

- (void)setTransitionDelay:(NSTimeInterval)delay
{
mbgl::style::TransitionOptions transitionOptions = self.mapView.mbglMap->getTransitionOptions();
transitionOptions.delay = MGLDurationInSeconds(delay);
self.mapView.mbglMap->setTransitionOptions(transitionOptions);
}

- (NSTimeInterval)transitionDelay
{
const mbgl::style::TransitionOptions transitionOptions = self.mapView.mbglMap->getTransitionOptions();
return MGLSecondsFromDuration(transitionOptions.delay.value_or(mbgl::Duration::zero()));
}

- (NSString *)description
{
return [NSString stringWithFormat:@"<%@: %p; name = %@, URL = %@>",
Expand Down
3 changes: 3 additions & 0 deletions platform/darwin/src/NSDate+MGLAdditions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,7 @@
/// Converts from a duration in seconds to a duration object usable in mbgl.
mbgl::Duration MGLDurationInSeconds(NSTimeInterval duration);

/// Converts from an mbgl duration object to a duration in seconds.
NSTimeInterval MGLSecondsFromDuration(mbgl::Duration duration);
Copy link
Contributor

Choose a reason for hiding this comment

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

MGLTimeIntervalFromDuration() would make the return type clearer, presuming that an NSTimeInterval is always measured in seconds (which is the case).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then should we not also rename MGLDurationInSeconds() to MGLDurationFromTimeInterval()?

Copy link
Contributor

Choose a reason for hiding this comment

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

MGLDurationInSecondsFromTimeInterval(), actually. mbgl::Duration can be expressed in many units; seconds is the one we’ve chosen to use for consistency with NSTimeInterval, but other parts of mbgl use milliseconds instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, took me a while to figure that out, but true. Do you think it's worth adding an assertion or other check here that it remains in seconds in this part of the code?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, I don’t think that’s an issue with std::chrono::duration or mbgl::Duration (which is actually in nanoseconds, my bad). MGLDurationInSeconds() performs a duration_cast to ensure that the output has the right quantity (if not the same unit as the input).

Copy link
Contributor

Choose a reason for hiding this comment

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

mbgl::Duration is similar to NSTimeInterval in the sense that the unit is fixed and built into the type. You can't have one mbgl::Duration representing a duration "in seconds" and another representing a duration "in milliseconds". The actual unit is defined by std::chrono::steady_clock and I'm not sure that it's invariant across platforms or standard library implementations. But it is fixed at compile time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

6ddc216


@end
5 changes: 5 additions & 0 deletions platform/darwin/src/NSDate+MGLAdditions.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,9 @@ @implementation NSDate (MGLAdditions)
return std::chrono::duration_cast<mbgl::Duration>(std::chrono::duration<NSTimeInterval>(duration));
}

NSTimeInterval MGLSecondsFromDuration(mbgl::Duration duration)
{
return duration.count();
}

@end
2 changes: 2 additions & 0 deletions platform/ios/app/MBXViewController.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,8 @@ - (void)styleSymbolLayer

- (void)styleBuildingLayer
{
[self.mapView.style setTransitionDuration:5];
// [self.mapView.style setTransitionDelay:2];
MGLFillStyleLayer *buildingLayer = (MGLFillStyleLayer *)[self.mapView.style layerWithIdentifier:@"building"];
buildingLayer.fillColor = [MGLStyleValue<UIColor *> valueWithRawValue:[UIColor blackColor]];
}
Expand Down