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

[ios, macos] Light property implementation in MGLStyle #9043

Merged
merged 12 commits into from
May 23, 2017

Conversation

fabian-guerra
Copy link
Contributor

@fabian-guerra fabian-guerra commented May 19, 2017

Closes #8840

Work in progress.

  • Implement Objc bindings for Light.
  • Reimplement MGLLight as value object.
  • Add tests cases.
  • Implement this as codegen.

/**
`lightAnchorType` property.
*/
@property (nonatomic) MGLStyleValue<NSValue *> *lightAnchorType;
Copy link
Contributor

Choose a reason for hiding this comment

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

Judging from the style specification documentation, the anchor property can’t be set to a function and isn’t transitionable. So the type of this property should be simply MGLLightAnchorType, and the lightAnchorTypeTransition property should be removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

The style specification was incorrect: mapbox/mapbox-gl-js#4743. Tracking a fix to this API in #9085.

/**
Position.
*/
@property (nonatomic) MGLPosition position;
Copy link
Contributor

Choose a reason for hiding this comment

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

The style specification documentation for this property seems to indicate that it can be set to a function. So the type needs to be MGLStyleValue. Since MGLPosition is a struct rather than a class, we’ll need to use the type MGLStyleValue<NSValue *> * and provide some extensions to NSValue to convert between NSValue and MGLPosition.

return self;
}

- (instancetype)initWithRawLayer:(mbgl::style::Light *)rawLight {
Copy link
Contributor

Choose a reason for hiding this comment

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

This method takes a light object, not a layer object.

// mbglLight.get()->setPosition(self.rawLight->getPosition());
// mbglLight.get()->setColor(self.rawLight->getColor());
// mbglLight.get()->setIntensity(self.rawLight->getIntensity());
std::unique_ptr<mbgl::style::Light> mbglLight(std::move(self.rawLight));
Copy link
Contributor

Choose a reason for hiding this comment

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

This implementation hews closely to one of the MGLStyleLayer subclass implementations. I think that could be problematic for the reason mentioned in #8431 (comment): as with MGLMapCamera, the developer could expect to be able to share a single MGLLight instance among multiple MGLMapViews.

If we follow the MGLMapCamera example, we can remove the std::unique_ptr usage from this class:

  • The class would rely on autosynthesized getters and setters for all the properties.
  • -mbglLight would create a simple mbgl::style::Light based on the class’s ivars, using the conversion code below to convert the Objective-C values into C++ style values.
  • -initWithMBGLLight: would extract all the property values from the passed-in mbgl::style::Light.

@interface NSValue (MGLLightAdditions)

+ (instancetype)valueWithMGLLightAnchorType:(MGLLightAnchorType)lightAnchorType;

Copy link
Contributor

Choose a reason for hiding this comment

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

In addition to -valueWithMGLLightAnchorType:, there should be a read-only MGLLightAnchorTypeValue property for converting in the other direction.


NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSUInteger, MGLLightAnchorType) {
Copy link
Contributor

Choose a reason for hiding this comment

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

“Type” isn’t needed in the name of this type.

};

MGL_EXPORT
@interface MGLLight : NSObject
Copy link
Contributor

Choose a reason for hiding this comment

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

This class any any other new public symbols will need documentation comments. The style specification documentation can be a starting point, although we’ll need to tailor a few details to make sense in Objective-C and Swift.

Any new top-level symbols, such as MGLLight, should also be added to both platforms’ jazzy table of contents.

Copy link
Contributor

Choose a reason for hiding this comment

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

#9087

@@ -14,6 +14,8 @@
#import "MGLStyle_Private.h"
#import "MGLStyleLayer_Private.h"
#import "MGLSource_Private.h"
#import "MGLLight.h"
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: This import statement is redundant to the MGLLight_Private.h import statement below.


@param radial value
@param azimuthal value
@param polar value
Copy link
Contributor

Choose a reason for hiding this comment

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

Each of these three parameters is described as “value”.

@@ -1039,6 +1048,9 @@
35599DB81D46AD7F0048254D /* Categories */,
353933F01D3FB6BA003F57D7 /* Layers */,
35136D491D4277EA00C20EFD /* Sources */,
1F0666881EC64F8E001C16D7 /* MGLLight.h */,
1F0666891EC64F8E001C16D7 /* MGLLight.mm */,
1F7454941ECD450D00021D39 /* MGLLight_Private.h */,
Copy link
Contributor

Choose a reason for hiding this comment

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

Please make corresponding changes to the macOS project and umbrella header to unbreak the build.

@1ec5 1ec5 added beta blocker Blocks the next beta release GL JS parity For feature parity with Mapbox GL JS iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling labels May 19, 2017
@1ec5 1ec5 added this to the ios-v3.6.0 milestone May 19, 2017
@jfirebaugh jfirebaugh requested review from lbud and removed request for jfirebaugh May 19, 2017 05:25
@fabian-guerra fabian-guerra changed the title Light property implementation in MGLStyle [ios, macos] Light property implementation in MGLStyle May 19, 2017
/**
Values describing animated transitions to `lightAnchorType` property.
*/
@property (nonatomic) MGLTransition lightAnchorTransition;
Copy link
Contributor

Choose a reason for hiding this comment

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

It doesn't appear to be possible to customize an anchor transition, probably because an anchor can only be one of two values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's what I thought as well but looking at light it has a transition for anchor and to keep consistency I kept the property.

auto propertyValue = mbglLight.getAnchor();
MGLStyleValue<NSValue *> *lightAnchorType;
if (propertyValue.isUndefined()) {
mbgl::style::PropertyValue<mbgl::style::LightAnchorType> defaultAnchor = mbglLight.getDefaultAnchor();
Copy link
Contributor

Choose a reason for hiding this comment

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

In C++ as in Swift, it's common to use auto and let the compiler infer the variable's type instead of specifying it manually.

lightAnchorType = MGLStyleValueTransformer<mbgl::style::LightAnchorType, NSValue *, mbgl::style::LightAnchorType, MGLLightAnchor>().toEnumStyleValue(propertyValue);
}

if ([lightAnchorType isKindOfClass:[MGLConstantStyleValue class]]) {
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably assert that the light anchor is a constant value.


}

- (MGLTransition)transitionFromOptions:(const mbgl::style::TransitionOptions &)options {
Copy link
Contributor

Choose a reason for hiding this comment

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

This method has no dependencies on self, so it should be a standalone function. Do we already have a standalone function to convert between mbgl::style::Transition and MGLTransition?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No we don't and I don't see other places where we could reuse it . I made this as a convenient method for the local transformations.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, in that case, let's make it a standalone C function just in this source file. (Same with the method that converts in the other direction.)

return transition;
}

- (mbgl::style::Light)toMBGLLight
Copy link
Contributor

Choose a reason for hiding this comment

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

Method names don't begin with prepositions in Objective-C; if the method returns a value without side effects, the name should generally be a noun phrase. mbgLight would be a fine name for this method.

Copy link
Contributor

Choose a reason for hiding this comment

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

mbglLight, that is.

#import "MGLLight.h"

#import <mbgl/style/light.hpp>
#import <mbgl/style/types.hpp>
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it necessary to import types.hpp here, or is light.hpp enough? Note that it may be possible to forward-declare mbgl::style::Light instead of importing the whole header. Being judicious about includes may help us optimize Objective-C++ compilation times; I'm not sure to what extent C++ benefits from whole-module optimization.

#9055 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is not necessary, was part of the previous implementation.

@@ -564,6 +565,8 @@ MGL_EXPORT
*/
- (void)removeImageForName:(NSString *)name;

@property (nonatomic, strong) MGLLight *light;
Copy link
Contributor

Choose a reason for hiding this comment

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

This property is currently under the #pragma mark for style images. It should get its own mark. jazzy turns marks into section headings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Working on it.


- (MGLLight *)light
{
mbgl::style::Light mbglLight = *self.mapView.mbglMap->getLight();
Copy link
Contributor

Choose a reason for hiding this comment

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

This code appears to obtain a double pointer to the mbgl::style::Light and assign it to a Light, in all likelihood creating a copy. Would it be possible to pass the original pointer returned by getLight() directly into -initWithMBGLLight:?

/**
A structure containing information about light position.
*/
typedef struct MGLPosition {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is the anchor's type called MGLLightAnchor and placed in MGLLight.h but the position's type called MGLPosition and placed in this file? Do we expect the position to be used in other, non-light-related APIs in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Initially I thought this may be used beyond light. But I can move it to MGLLight.h and refactor in the future if happens to be used elsewhere.

@@ -19,6 +19,7 @@ FOUNDATION_EXPORT MGL_EXPORT const unsigned char MapboxVersionString[];
#import "MGLDistanceFormatter.h"
#import "MGLFeature.h"
#import "MGLGeometry.h"
#import "MGLLight.h"
Copy link
Contributor

Choose a reason for hiding this comment

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

Also import MGLLight.h into the macOS SDK's umbrella header.

/** Options to specify extruded geometries are lit relative to the map or viewport. */
typedef NS_ENUM(NSUInteger, MGLLightAnchor) {
/** The position of the light source is aligned to the rotation of the map. */
MGLLightAnchorTypeMap,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these should match the base name so you should remove Type. So MGLLightAnchor is in both MGLLightAnchorMap and MGLLightAnchorViewport

Copy link
Contributor

@boundsj boundsj left a comment

Choose a reason for hiding this comment

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

I think this looks good. We should ticket tail work for codegen and additional documentation if required. Also an example in iosapp would be nice to have for this feature.

Copy link
Contributor

@1ec5 1ec5 left a comment

Choose a reason for hiding this comment

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

There are several remaining issues around code style and property naming that I'd prefer to see addressed as part of this PR. Hopefully none of them is a big deal.

There are also a couple pieces of documentation improvements that could be tail work. (Normally documentation should not be tail work, but what you've got here is plenty good enough for a developer to work with.) Generating MGLLight.h/.mm automatically would also a nice-to-have in the long run, but I don't see it as essential to shipping this PR because any changes to the interface would require a style specification update anyways.

typedef struct MGLLightPosition {
/** Distance from the center of the base of an object to its light. */
CGFloat radial;
/** Position of the light relative to 0° (0° when `lightAnchor` is set to viewport corresponds
Copy link
Contributor

Choose a reason for hiding this comment

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

The reference to lightAnchor needs to be MGLLight.lightAnchor in order for jazzy to automatically link to the property's documentation.

/**
`lightAnchorType` Whether extruded geometries are lit relative to the map or viewport.
*/
@property (nonatomic) MGLLightAnchor lightAnchor;
Copy link
Contributor

Choose a reason for hiding this comment

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

The property should be named anchor, not lightAnchor. There's no ambiguity as to the kind of anchor we're looking at.

@interface MGLLight : NSObject

/**
`lightAnchorType` Whether extruded geometries are lit relative to the map or viewport.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "lightAnchorType".


/**
Position of the light source relative to lit (extruded) geometries.
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

These documentation comments should cross-reference (and link to) the style specification's entries for the corresponding properties on the Light object. See the MGLSymbolStyleLayer.h documentation comments for examples. This can be tail work.

auto anchor = mbglLight->getAnchor();
MGLStyleValue<NSValue *> *lightAnchorType;
if (anchor.isUndefined()) {
mbgl::style::PropertyValue<mbgl::style::LightAnchorType> defaultAnchor = mbglLight->getDefaultAnchor();
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: this code would be more readable with the use of auto here and in other situations where we're creating a local variable to hold the return value of a method call.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree but I had a problem in the line below. If I specify it as auto I get No matching member function for call toEnumStyleValue.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, makes sense. That's because getDefaultAnchor() returns a raw LightAnchorType and we're relying on this variable declaration to implicitly wrap it in a PropertyValue, PropertyValue being the type that has the toEnunStyleValue() method.


#import "MGLLight.h"

#import <mbgl/style/light.hpp>
Copy link
Contributor

Choose a reason for hiding this comment

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

It may be possible to avoid this import statement too, by forward declaring a class Light inside a namespace style inside a namespace mbgl. See some of the other runtime styling private headers for examples.

CGFloat azimuthal;
/** Indicates the height of the light (from 0°, directly above, to 180°, directly below). */
CGFloat polar;
} MGLLightPosition;
Copy link
Contributor

Choose a reason for hiding this comment

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

As tail work, maybe we could consider naming this struct MGLSphericalPosition, so it emphasizes the nature of the value instead of how it's used.


// position
{
auto light = new mbgl::style::Light();
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems odd that we're using the new keyword here. Would it work to declare mbgl::style::Light light; instead?

NSAssert([mglLight.color isKindOfClass:[MGLConstantStyleValue class]], @"mglLight.color isn’t a MGLConstantStyleValue.");
MGLColor *colorValue = ((MGLConstantStyleValue *)mglLight.color).rawValue;
auto color = light->getDefaultColor();
const CGFloat *colorComponents = CGColorGetComponents(colorValue.CGColor);
Copy link
Contributor

Choose a reason for hiding this comment

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

There's an Objective-C method on NSColor and UIColor that does the same thing.

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 but for some reason when I was using it it was failing.

Copy link
Contributor

Choose a reason for hiding this comment

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

What error were you seeing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Setting and retrieving MGLLight.color to [UIcolor whiteColor] this function CGColorEqualToColor always returned false.

Copy link
Contributor

Choose a reason for hiding this comment

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

That's because the color space for whiteColor is a grayscale color space rather than the RGB color space. We have methods for converting between NSColor/UIColor and mbgl::Color.

@@ -14,6 +14,7 @@ Mapbox welcomes participation and contributions from everyone. Please read [CONT
* Fixed an issue causing a composite function’s highest zoom level stop to be misinterpreted. ([#8613](https://github.com/mapbox/mapbox-gl-native/pull/8613), [#8790](https://github.com/mapbox/mapbox-gl-native/pull/8790))
* Fixed an issue where re-adding a layer that had been previously removed from a style would reset its paint properties. Moved initializers for `MGLTileSource`, `MGLStyleLayer`, and `MGLForegroundStyleLayer` to their concrete subclasses; because these classes were already intended for initialization only via concrete subclasses, this should have no developer impact. ([#8626](https://github.com/mapbox/mapbox-gl-native/pull/8626))
* Feature querying results now account for any changes to a feature’s size caused by a source or composite style function. ([#8665](https://github.com/mapbox/mapbox-gl-native/pull/8665))
* Added support for 3D extrusion's light via the `MGLLight` class and the `light` property in style JSON. ([#9043](https://github.com/mapbox/mapbox-gl-native/pull/9043))
Copy link
Contributor

Choose a reason for hiding this comment

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

There's already a blurb above about adding 3D extrusion support to the release. This is one part of that feature, not a separate feature. Let's remove this entry and put it in the draft release notes for beta 1. (But feel free to add a link to this PR to the end of the existing blurb.)

Copy link
Contributor

Choose a reason for hiding this comment

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

(Same for the macOS changelog; 3D extrusion is already covered by an existing blurb.)

Copy link
Contributor

@1ec5 1ec5 left a comment

Choose a reason for hiding this comment

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

Some additional comments about the types and documentation of spherical positions. I don't think these changes would have an effect on binary compatibility for the most part, since CLLocationDirection and CLLocationDistance are typedef'd to doubles on 64-bit systems.

/**
`anchor` Whether extruded geometries are lit relative to the map or viewport.

This attribute corresponds to the <a
Copy link
Contributor

Choose a reason for hiding this comment

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

It's OK to say property here instead of attribute here, since there's no need in this case to distinguish between a property and the effect it has on the map.


This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-js/style-spec/#light-anchor"><code>anchor</code></a>
layout property in the Mapbox Style Specification.
Copy link
Contributor

Choose a reason for hiding this comment

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

These are light properties, not layout properties.

*/
typedef struct MGLSphericalPosition {
/** Distance from the center of the base of an object to its light. */
CGFloat radial;
Copy link
Contributor

Choose a reason for hiding this comment

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

What unit is this distance in? If this distance is measured in meters, its type should be CLLocationDistance.

Copy link
Contributor

Choose a reason for hiding this comment

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

#9234

/** Position of the light relative to 0° (0° when `MGLLight.anchor` is set to viewport corresponds
to the top of the viewport, or 0° when `MGLLight.anchor` is set to map corresponds to due north,
and degrees proceed clockwise). */
CGFloat azimuthal;
Copy link
Contributor

Choose a reason for hiding this comment

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

This field's type should be CLLocationDirection, which is measured in degrees clockwise from north (or up).

and degrees proceed clockwise). */
CGFloat azimuthal;
/** Indicates the height of the light (from 0°, directly above, to 180°, directly below). */
CGFloat polar;
Copy link
Contributor

Choose a reason for hiding this comment

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

Similarly, if this height is measured in meters, the type should be CLLocationDistance.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, actually, based on the documentation, this field appears to be measured in degrees as well. It isn't clear to me whether it goes clockwise; if it does, then the appropriate type would be CLLocationDirection.

@1ec5
Copy link
Contributor

1ec5 commented May 23, 2017

Generating MGLLight.h/.mm automatically would also a nice-to-have in the long run

#9086

tobrun added a commit that referenced this pull request Jun 2, 2017
* [android] Update release script to support CircleCI builds (#8950)

* update release script to trigger builds on circleci now

* update release script to trigger builds on circleci now

* [core] When a layer is added, reload its source's tiles

* [android] - keep observer when timeout occurs, make observer param nullable, fixup log messages (#8919)

* [android] - avoid crashing when deleting already deleted region (#8920)

* [android] - update LOST to 2.3.0 (#8872)

* [android] - update proguard config, allow debug mimification, update OkHttp to latest version (#8944)

* [core, android, ios, macos, qt] v10 default styles

Upgraded from v9 default styles to v10 wherever the developer expects to get the latest and greatest, as well as in a couple tests where it may be beneficial to ensure that we can handle a two-digit version number in the style URL.

Cherry-picked from ed54849.

* [ios, macos] Updated documented default style version

MGLStyleDefaultVersion is just for Streets now. Deleted style version documentation tests because not all styles are on the same version.

Cherry-picked from ca97dd8.

* [ios, macos] Undeprecated unversioned style URL factory methods

Undeprecated the unversioned style URL factory methods in MGLStyle for consistency with the Android and Qt SDKs. Added warnings about using them with the runtime styling API.

Refactored mbgl::util::default_styles to track different versions for different styles.

Cherry-picked from 9e384b7.

* [core, android, ios, macos] Added Traffic Day/Night to default styles

The Styles API section of the Mapbox API Documentation site now lists Traffic Day v2 and Traffic Night v2, so this change adds those styles to all the places where styles are listed.

Also switched iosapp and macosapp to unversioned style factory methods since MGLStyleDefaultVersion is no longer applicable for all styles.

Cherry-picked from 4d6f545.

* [android] Release android-v5.1.0-beta.2 (#8976)

* [android] url getter on sources

* [android] fix ui test filter in makefile

* [android] - build SNAPSHOT from release branch (#8958)

* [android] - update changelog for 5.1.0-beta.2

* [android] - bump version number

* [android] - Camera change listener v2.0

* [core] allow filesource url transform reset

* [android] Update attribution wordmark (#8774)

* Update wordmark on android

* Moved attribution i icon to the right of mapbox word (in mapview preview image)

* update padding and margin

* [android] update hardcoded branch name

* revert version to 5.1.0-SNAPSHOT

* [android] - MarkerView deselect events with OnMarkerViewClickListener integration (#8996)

* [android] - publish SNAPSHOT from release 5.1.0 branch (#8995)

* [ios, macos] edited identity interpolation mode documentation (#8657)

* [ios, macos] Factored out tile URL template guide

Factored out redundant tile URL template documentation from the MGLRasterSource and MGLVectorSource documentation into a jazzy guide. This documentation used to live in one place, on a method on MGLTileSource, but that method had to be moved to MGLTileSource’s concrete subclasses. A jazzy guide is easier to link to, in any case.

* [ios] Telemetry button in modal view controllers (#9027)

Fixes #8980.

* [android] - bump tools and support lib version due to SNAPSHOT dependencies (#9046)

* [android] - bump tools and support lib version for SNAPSHOT dependencies

* revert unsupported Circle CI build tools version

* [core] Make destructor virtual to avoid object splicing during destruction

* [core] add error for non-virtual destructor deletes + add virtual dtors

* [android] -  remove marker from selected markers when removing marker from annotation manager. (#9047)

* Observe layout guides (#7716)

* [ios] observe layout guides

* [ios] update changelog

* [ios, macos] Change == to = in style function initializers

* [ios] Add annotation view initializer with annotation and reuse id (#9029)

* [ios] Remove annotation view from container view when annotation removed (#9025)

The annotation container view keeps an array of annotation views that is separate from the array of subviews that is a property of the UIView parent class. This removes an annotation view from that container view array when the associated annotation is removed. This avoids issue related to previously removed annotation views continuing to be involved in map view logic around annotation view selection due to taps.

* [android] - correct bearing conversion when animating the map with jumpTo, easeTo and animateTo. (#9050)

* [ios, macos] Updated `maximumZoomLevel` description, cherry-picked #8818 (#8842)

Cherry-picked from a3e4e67.

* [ios] Updated podspecs and changelog for v3.5.3 (#8870)

Cherry-picked from 25c1990.

* [ios] Update podspecs and changelog for iOS v3.5.4

Cherry-picked from db7bb50.

* [ios, macos] Updated changelogs

* [ios, macos] changed TRUE -> 'true' (#9059) fixes #9056

* [ios, macos] Light property implementation in MGLStyle (#9043)

* [ios, macos] Add MGLLight to MGLStyle

* [ios, macos] Implement Objc bindings for Light object

* [ios, macos] Remove rawLight from MGLLight and re-implement it as value class

* [ios, macos] Fix build on macos

* [ios, macos] Add MGLLight documentation, Move MGLLightPosition to MGLLight

* [ios, macos] Add MGLLight tests.

* [ios, macos] Update changelogs

* [ios, macos] Fix misspelling

* [ios, macos] Fix MGLLightAnchor enum property names

* [ios, macos] Update documentation. Improve varialble naming.

* [ios, macos] Rename MGLLightPosition to MGLSphericalPosition

* [ios, macos] Update data types of MGLSphericalPosition

* [android] - horizontally rotated in snapshot (#9083)

* Cherry-pick arabic text to release branch v3.6.0 (#9071)

* [core] Throttle tiles to redo symbol placement at most once every 300ms.
Fixes issue #8435 and prepares for pitch-scaling changes in issue #8967.

* [core] Disable letter-spacing for Arabic labels (issue #9057)

* [ios,macos] multipolygon coordinate (#8713)

* [ios] MGLMultiPolygon's coordinate property implemented

* [ios,macos] Add polylabalel to project config

* [ios,macos] Change coordinate property for MGLPolyline,MGLPolygon,MGLMultiPolygon

* [macos] Change project configuration to support polilabel

* [ios,macos] Add MGLLocationCoordinate2DFromPoint

* [ios, macos] Update changelogs

* [ios, macos] remove unnecesary variables

* [ios, macos] Add radians conversions

* [ios, macos] Add coordinate calc to MGLPolyline

* [ios, macos] Move radian fuctions to MGLGeometry_Private.h

* [ios, macos] Fix code style

* [ios, macos] Fix code indentation

* [ios, macos] Fix radian per meters constant

* [ios, macos] Add test scenarios to testPolyline

* [ios, macos] Fix test accuracy

* [ios, macos] More robust Streets localization

Added Arabic, Portuguese, and Simplified Chinese to the list of languages with specialized fields in the Mapbox Streets source.

Rely on NSBundle to select the most appropriate locale based on the user’s preferred languages.

* [ios] Fallback to Mapbox.bundle as the framework bundle (#9074)

Fixes an issue where localizations could not be found when using static builds.

Throws exception if our bundle can't be found.

* [ios] Move image resources to an asset catalog & switch to PDFs

* [ios, macos] Updated changelogs

Reorganized the changelogs with a new packaging section. Added blurbs about #9062, #8713, #9060, and #9031.

* [ios] Update pods spec for iOS v3.6.0-beta.1

* [macos] Enable View ‣ Traffic Night

Enable the View ‣ Traffic Night menu item and check it when that style is active.

* [android] - stop location updates when toggle MyLocationView state (#9099)

* [android] - LatLngBounds bearing default value (#9102)

* [ios, macos] Fix MGLLight.achor to accept style functions

* [ios] Fix annotation initializers for subclasses of MGLAnnotationView (#9104)

Use a common init function in both of the provided initializers so that subclasses of `MGLAnnotationView` written in Swift don't need to override `init(annotation, reuseIdentifier)`

* [ios] Moved `MGLLight` in jazzy table of contents (#9111)

* [android] - logo placement for creating a Mapview programatically (#9094)

* [android] - Correct logo placement for creating a Mapview programatically, fixup non default placements

* Fixed NIGHTY_TWO_DP typo to NINETY_TWO_DP

* [android] - add binding support for Light (#9013)

* [android] Update Lost to final version 3.0.0 (#9112)

* update lost to final version 3.0.0

* bump MAS version to 2.1.1

* [android] - convert dp to pixels when getting meters per pixel at. (#9048)

* Release Android v5.1.0-beta.3 (#9115)

* [android] - Changelog update for Android release v5.1.0-beta.3

* update CI & version

* reset release properties

* [android] - harden orientation changes (#9128)

* [ios] Remove filter of single metric event

* [ios] remove layout guide observers

* Migrate to GL JS–powered feedback form (#9078)

* [ios, macos] Updated feedback URL

* [ios, macos] Add referrer, heading, pitch to feedback URL

* [ios, macos] Updated changelogs for feedback changes

* [ios] Vary referrer by platform

* [android] - javadoc update for 5.1.0 release (#9138)

* [android] - javadoc update for 5.1.0 release

* oxford comma

* Grammar/spelling tweaks

* grammar tweak

* grammar tweak

* Grammar tweaks

* Grammar tweaks

* [android] fix missing access token variable issue (#9151)

* [ios] Update pods spec for iOS v3.6.0-beta.2

* [android] Cherry picking 9133 (#9145)

* [android] Fix tracking mode + camera race condition (#9133)

* [android] fix tracking mode + camera race condition

* fix resetTrackingModesIfRequired bug (comparing current camera position with target camera position

* cherry pick #9133 and update CHANGELOG

* add null check to prevent null pointer exception

* add null check in custom location engine activity to prevent null pointer exception (#9159)

* [core] Make TransformState LatLngBounds optional

* [ios] Make annotation view rotation alignment configurable (#9147)

This commit adds `rotatesWithMap` property on `MGLAnnotationView`. This
property, when set to `YES` fixes the annotation to a map such that view
follows map's rotation angle. This is useful when user wants to display
rotation-dependent annotations (e.g. sector lights).

* [android] - validate if gestures should execute (#9173)
tobrun added a commit that referenced this pull request Jul 5, 2017
* [android] Update release script to support CircleCI builds (#8950)

* update release script to trigger builds on circleci now

* update release script to trigger builds on circleci now

* [core] When a layer is added, reload its source's tiles

* [android] - keep observer when timeout occurs, make observer param nullable, fixup log messages (#8919)

* [android] - avoid crashing when deleting already deleted region (#8920)

* [android] - update LOST to 2.3.0 (#8872)

* [android] - update proguard config, allow debug mimification, update OkHttp to latest version (#8944)

* [core, android, ios, macos, qt] v10 default styles

Upgraded from v9 default styles to v10 wherever the developer expects to get the latest and greatest, as well as in a couple tests where it may be beneficial to ensure that we can handle a two-digit version number in the style URL.

Cherry-picked from ed54849.

* [ios, macos] Updated documented default style version

MGLStyleDefaultVersion is just for Streets now. Deleted style version documentation tests because not all styles are on the same version.

Cherry-picked from ca97dd8.

* [ios, macos] Undeprecated unversioned style URL factory methods

Undeprecated the unversioned style URL factory methods in MGLStyle for consistency with the Android and Qt SDKs. Added warnings about using them with the runtime styling API.

Refactored mbgl::util::default_styles to track different versions for different styles.

Cherry-picked from 9e384b7.

* [core, android, ios, macos] Added Traffic Day/Night to default styles

The Styles API section of the Mapbox API Documentation site now lists Traffic Day v2 and Traffic Night v2, so this change adds those styles to all the places where styles are listed.

Also switched iosapp and macosapp to unversioned style factory methods since MGLStyleDefaultVersion is no longer applicable for all styles.

Cherry-picked from 4d6f545.

* [android] Release android-v5.1.0-beta.2 (#8976)

* [android] url getter on sources

* [android] fix ui test filter in makefile

* [android] - build SNAPSHOT from release branch (#8958)

* [android] - update changelog for 5.1.0-beta.2

* [android] - bump version number

* [android] - Camera change listener v2.0

* [core] allow filesource url transform reset

* [android] Update attribution wordmark (#8774)

* Update wordmark on android

* Moved attribution i icon to the right of mapbox word (in mapview preview image)

* update padding and margin

* [android] update hardcoded branch name

* revert version to 5.1.0-SNAPSHOT

* [android] - MarkerView deselect events with OnMarkerViewClickListener integration (#8996)

* [android] - publish SNAPSHOT from release 5.1.0 branch (#8995)

* [ios, macos] edited identity interpolation mode documentation (#8657)

* [ios, macos] Factored out tile URL template guide

Factored out redundant tile URL template documentation from the MGLRasterSource and MGLVectorSource documentation into a jazzy guide. This documentation used to live in one place, on a method on MGLTileSource, but that method had to be moved to MGLTileSource’s concrete subclasses. A jazzy guide is easier to link to, in any case.

* [ios] Telemetry button in modal view controllers (#9027)

Fixes #8980.

* [android] - bump tools and support lib version due to SNAPSHOT dependencies (#9046)

* [android] - bump tools and support lib version for SNAPSHOT dependencies

* revert unsupported Circle CI build tools version

* [core] Make destructor virtual to avoid object splicing during destruction

* [core] add error for non-virtual destructor deletes + add virtual dtors

* [android] -  remove marker from selected markers when removing marker from annotation manager. (#9047)

* Observe layout guides (#7716)

* [ios] observe layout guides

* [ios] update changelog

* [ios, macos] Change == to = in style function initializers

* [ios] Add annotation view initializer with annotation and reuse id (#9029)

* [ios] Remove annotation view from container view when annotation removed (#9025)

The annotation container view keeps an array of annotation views that is separate from the array of subviews that is a property of the UIView parent class. This removes an annotation view from that container view array when the associated annotation is removed. This avoids issue related to previously removed annotation views continuing to be involved in map view logic around annotation view selection due to taps.

* [android] - correct bearing conversion when animating the map with jumpTo, easeTo and animateTo. (#9050)

* [ios, macos] Updated `maximumZoomLevel` description, cherry-picked #8818 (#8842)

Cherry-picked from a3e4e67.

* [ios] Updated podspecs and changelog for v3.5.3 (#8870)

Cherry-picked from 25c1990.

* [ios] Update podspecs and changelog for iOS v3.5.4

Cherry-picked from db7bb50.

* [ios, macos] Updated changelogs

* [ios, macos] changed TRUE -> 'true' (#9059) fixes #9056

* [ios, macos] Light property implementation in MGLStyle (#9043)

* [ios, macos] Add MGLLight to MGLStyle

* [ios, macos] Implement Objc bindings for Light object

* [ios, macos] Remove rawLight from MGLLight and re-implement it as value class

* [ios, macos] Fix build on macos

* [ios, macos] Add MGLLight documentation, Move MGLLightPosition to MGLLight

* [ios, macos] Add MGLLight tests.

* [ios, macos] Update changelogs

* [ios, macos] Fix misspelling

* [ios, macos] Fix MGLLightAnchor enum property names

* [ios, macos] Update documentation. Improve varialble naming.

* [ios, macos] Rename MGLLightPosition to MGLSphericalPosition

* [ios, macos] Update data types of MGLSphericalPosition

* [android] - horizontally rotated in snapshot (#9083)

* Cherry-pick arabic text to release branch v3.6.0 (#9071)

* [core] Throttle tiles to redo symbol placement at most once every 300ms.
Fixes issue #8435 and prepares for pitch-scaling changes in issue #8967.

* [core] Disable letter-spacing for Arabic labels (issue #9057)

* [ios,macos] multipolygon coordinate (#8713)

* [ios] MGLMultiPolygon's coordinate property implemented

* [ios,macos] Add polylabalel to project config

* [ios,macos] Change coordinate property for MGLPolyline,MGLPolygon,MGLMultiPolygon

* [macos] Change project configuration to support polilabel

* [ios,macos] Add MGLLocationCoordinate2DFromPoint

* [ios, macos] Update changelogs

* [ios, macos] remove unnecesary variables

* [ios, macos] Add radians conversions

* [ios, macos] Add coordinate calc to MGLPolyline

* [ios, macos] Move radian fuctions to MGLGeometry_Private.h

* [ios, macos] Fix code style

* [ios, macos] Fix code indentation

* [ios, macos] Fix radian per meters constant

* [ios, macos] Add test scenarios to testPolyline

* [ios, macos] Fix test accuracy

* [ios, macos] More robust Streets localization

Added Arabic, Portuguese, and Simplified Chinese to the list of languages with specialized fields in the Mapbox Streets source.

Rely on NSBundle to select the most appropriate locale based on the user’s preferred languages.

* [ios] Fallback to Mapbox.bundle as the framework bundle (#9074)

Fixes an issue where localizations could not be found when using static builds.

Throws exception if our bundle can't be found.

* [ios] Move image resources to an asset catalog & switch to PDFs

* [ios, macos] Updated changelogs

Reorganized the changelogs with a new packaging section. Added blurbs about #9062, #8713, #9060, and #9031.

* [ios] Update pods spec for iOS v3.6.0-beta.1

* [macos] Enable View ‣ Traffic Night

Enable the View ‣ Traffic Night menu item and check it when that style is active.

* [android] - stop location updates when toggle MyLocationView state (#9099)

* [android] - LatLngBounds bearing default value (#9102)

* [ios, macos] Fix MGLLight.achor to accept style functions

* [ios] Fix annotation initializers for subclasses of MGLAnnotationView (#9104)

Use a common init function in both of the provided initializers so that subclasses of `MGLAnnotationView` written in Swift don't need to override `init(annotation, reuseIdentifier)`

* [ios] Moved `MGLLight` in jazzy table of contents (#9111)

* [android] - logo placement for creating a Mapview programatically (#9094)

* [android] - Correct logo placement for creating a Mapview programatically, fixup non default placements

* Fixed NIGHTY_TWO_DP typo to NINETY_TWO_DP

* [android] - add binding support for Light (#9013)

* [android] Update Lost to final version 3.0.0 (#9112)

* update lost to final version 3.0.0

* bump MAS version to 2.1.1

* [android] - convert dp to pixels when getting meters per pixel at. (#9048)

* Release Android v5.1.0-beta.3 (#9115)

* [android] - Changelog update for Android release v5.1.0-beta.3

* update CI & version

* reset release properties

* [android] - harden orientation changes (#9128)

* [ios] Remove filter of single metric event

* [ios] remove layout guide observers

* Migrate to GL JS–powered feedback form (#9078)

* [ios, macos] Updated feedback URL

* [ios, macos] Add referrer, heading, pitch to feedback URL

* [ios, macos] Updated changelogs for feedback changes

* [ios] Vary referrer by platform

* [android] - javadoc update for 5.1.0 release (#9138)

* [android] - javadoc update for 5.1.0 release

* oxford comma

* Grammar/spelling tweaks

* grammar tweak

* grammar tweak

* Grammar tweaks

* Grammar tweaks

* [android] fix missing access token variable issue (#9151)

* [ios] Update pods spec for iOS v3.6.0-beta.2

* [android] Cherry picking 9133 (#9145)

* [android] Fix tracking mode + camera race condition (#9133)

* [android] fix tracking mode + camera race condition

* fix resetTrackingModesIfRequired bug (comparing current camera position with target camera position

* cherry pick #9133 and update CHANGELOG

* add null check to prevent null pointer exception

* add null check in custom location engine activity to prevent null pointer exception (#9159)

* [core] Make TransformState LatLngBounds optional

* [ios] Make annotation view rotation alignment configurable (#9147)

This commit adds `rotatesWithMap` property on `MGLAnnotationView`. This
property, when set to `YES` fixes the annotation to a map such that view
follows map's rotation angle. This is useful when user wants to display
rotation-dependent annotations (e.g. sector lights).

* [android] - validate if gestures should execute (#9173)

* [android] - only invoke callback if fling scrolling animation isn't going to be ignored. (#9192)

* [android] - dealing with infinite camera move callbacks (#9177) (#9194)

* [android] - keep location tracking mode after screen rotation (#9187)

* [android] - keep location tracking mode after screen rotation (#9186)

* [android] - using easeCamera to keep location tracking instead of overloaded moveCamera (#9187)

* [android] - checkstyle fix up

* fix #8300 flyTo for close points

The isClose threshold is switched from 0.000001 pixels to 1 pixel.
As a backup, it checks whether r0 and r1 are finite. It might be
possible to have just the threshold check or just the finiteness check,
but I don't see the harm in having both.

std::abs(w0 - w1) < 0.000001 is removed because it doesn't look like
it's needed. All calculations should run fine even if w0 === w1.

Finally, the point interpolation is tweaked so that at the end of the
flying (when k === 1) it ends up at the exact end point. I didn't see
any bugs related to this, but it seems like a good thing to have
explicitly.

* [android] - remove conversion from pixels to dp (#9205)

* [android] - option to disable camera animation while following position (#9210)

* [android] - invalidating MyLocationView bearing when not following position (#9212)

* Custom location source fix (#9142)

*  [android] - custom location engine fixes (#9139)

* Update to latest LOST dependency, fixup internal location source integration

* [android] - update components with camera values when animating (#9174)

* Cherry picks to release branch (#9230)

* [ios][macos] test remove source in use

* [android] test remove source in use

* [core] check source usage before remove

* [core] ensure layer::accept works with non-void return values on gcc

* [android] - remove upgrade runtime exceptions (#9191)

* [android] - update changelog for v5.1.0-beta.4 (#9232)

* [android] - run MapboxMap invocations to ui thread for instrumentation tests (#9198)

* [ios, macos] Fix MGLSphericalPosition.radial misleading type.

* [android] - correct source changed map event javadoc (#9243)

* Cherry pick release (#9263)

* [core] - bump earcut version dependency to handle  unused lamba warning (#9242)

* [android] - snapshot bitmap contains view based content (#9252)

* [core] store vertex attribute binding to prevent duplicate binds

We have an "oldBinding" value that we use for checking whether the vertex attribute was already
bound to the current VAO, but we never set the state. Additionally, we're also checking whether
the previous state was already any binding (optional is set), and don't re-enable the vertex
attribute array. Additionally, we now only disable the vertex attribute array when the previous
state was in fact an array attribute. We still don't deduplicate constant glVertexAttrib* calls,
but that's a little trickier.

* [core] add shader defines for enabling/disabling attributes/uniforms for DDS

* [core] only bind uniforms that exist in the program

* [core] add uniforms to DataDrivenPaintPropertys

* [core] add constant DDS values as uniforms

* [core] Dynamic program compilation for data-driven properties

* [core] Reduce number of varyings to 8 or less

For #pragmas, don't generate varyings for attributes that aren't used by the fragment shader. Pack other varyings more tightly.

* [core] Don't upload the FrameHistory texture in frames where it's not changing

* [core] cleanup ProgramParameters

* [ios, macos] Revised descriptions for abstract classes (#9095)

Addresses #8635

* [ios] Remove old Fabric build infrastructure

* MGLLight autogenerate scripts (#9260)

* [ios, macos] Add the MGLLight generation templates

* [ios, macos] Add MGLLight generation script

* [ios, macos] Add the auto-generation script for MGLLight.mm

* [ios, macos] Add the auto-generation script for MGLLightTest.mm

* [core] Add const to Position constructor.

* [ios, macos] Simplify MGLLightTest.mm autogenerate script.

* [ios] Update pods spec for iOS v3.6.0-beta.3

* [ios, macos] Updated changelogs

* [core] Fix composite function approximation for non-integer stops

* [ios] Update telemetry cert pinning (#9292)

* [core] Trigger repaint on source changes

* [android] - update activity test generation with newest classes, make FillExtrusionActivity conform to generated activity test setup. (#9276)

* Validate camera position before transforming (#9275)

* [android] - add camera position validation before transforming

* annotate CameraUpdate with nullability

* [android] fix custom marker views anchor issue (#9282)

* [android] fix pulse marker view options parcelable creator (#9283)

* fix trackball long press timeout calling the main thread method on a background thread (#9305)

* [android] Update to LOST 3.0.1 (#9302)

* Revisit Javadoc for 5.1.0 (#9266)

* [android] - revisit public API javadoc

* [android] fix javadoc minor mistakes and typos

* grammar tweak

* add missing public javadoc

* [android] update mapboxServicesVersion to 2.1.2 (#9311)

* [android] - update CHANGELOG for release 5.1.0-beta.5 (#9316)

* [android] - restore LatLngBounds conversion, add regression test (#9324)

* [build] Unbreak Travis

* 7910: cancel tracking if ongoing animation is stopped manually (#7916)

* 7910: cancel tracking if ongoing animation is stopped manually

* 7910 updating change log

* [ios] Fix map camera animation when a significant change occurs

* [ios] Update cancel tracking documentation.

* [ios, macos] Rewrote MGLStyle class documentation

The documentation comment now provides a high-level overview of the runtime styling API and its components, as well as the main workflow for using a style.

* [ios, macos] Corrected MGLSource subclassing documentation

* Boxing ObjC structs (#9343)

* [ios, macos] Make structs boxable

* [ios, macos] Update changelogs.

* [ios] Allow delegate to keep wandering pinch from panning map

MGLMapView consults MGLMapViewDelegate about whether to zoom the map in response to a pinch gesture, but it should also account for the delegate’s response when panning the map due to the pinch’s center point wandering.

Fixes #9168.

* [ios] Added Hungarian localization from Transifex

* [ios] Updated German localization

* [ios, macos] Updated changelogs

Also corrected the version number in the macOS changelog.

* [ios] Update pods spec for iOS v3.6.0-rc.1

* [ios] Fixed infinite loop zooming in past z23

At zoom levels where the minimum 1 meter or 4 feet would be wider than the scale bar’s maximum width, the local variable holding the preferred row was left undefined. A loop that later iterated based on this row would effectively iterate infinitely until memory pressure forces the system to quit the application.

* [ios, macos] Fix size and color of default marker image

* [ios] Minimize tilt gesture delay

* [core] Fix iterator invalidation in erase_if

vector::erase invalidates iterators. It's not safe for erase_if to cache the end iterator nor increment, then erase.

* OnCameraIdle hook into quickzoom gesture (#9339)

* [android] - OnCameraIdle hook into quickzoom gesture

* double tap fix

* show MyLocationView bearing for GPS when Compass is not available, only show error about missing compass once, fix test activity.

* fix accessor lint warning

* [ios] moved changes to darwin (#9387)

* [macos] Reorganized changelog

* [macos] Fixed cursor shifting after drag gesture

When redisplaying the mouse cursor after a modified drag gesture, incorporate the conversion from view coordinates to window coordinates. Previously, this code performed the conversion but threw away the results.

Fixes #8670.

* ios] Update pods spec for iOS v3.6.0

* [macos] Updated screenshot

The new screenshot features 3D extruded buildings, vertical CJK, and right-to-left Arabic, all via runtime styling.

* macos-v0.5.0

* Downgrade location provider dependency (#9394)

* [android] - downgrade LOST to Mapbox SDK 5.0.2 version.

* bump LOST back to Mapbox Android SDK version 4.x

* [android] - bump Mapbox Android Services to latest for 5.1.0 final release (#9402)

* [android] - update changelog for 5.1.0 release (#9405)

* [core] Fix iterator invalidation in erase_if

vector::erase invalidates iterators. It's not safe for erase_if to cache the end iterator nor increment, then erase.

* [android] - invible marker views performance fix #9419 (#9420)

* [darwin] - re-add swift documentation

* [macos] - add Styles header to CHANGELOG.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
beta blocker Blocks the next beta release GL JS parity For feature parity with Mapbox GL JS iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants