[ios, macos] possibility to set custom images to style (#6637)

* [ios, macos] possibility to set custom images to style

* [ios, macos] setImage:forName now supports MGLImage (UIImage/NSImage)

* [ios, macos] update documentation for setImage:forName: and removeImageForName:

* [ios, macos] rename method and fix prefix

* [ios, macos] change header visibility to project

* [ios, macos] update header imports

* [ios, macos] delete unnecessary whitespaces

* [ios, macos] remove unnecessary nil checks

* [ios, macos] delete unnecessary whitespaces

* [ios, macos] update documentation

* [ios, macos] make mgl_spriteImage a parameter-less instance method

* [ios, macos] add asserts

1 files changed, 53 insertions, 35 deletions

diff --git a/platform/darwin/src/MGLStyle.h b/platform/darwin/src/MGLStyle.h
index d4868681e1..7f01c230c5 100644
--- a/platform/darwin/src/MGLStyle.h
+++ b/platform/darwin/src/MGLStyle.h
@@ -12,14 +12,14 @@ NS_ASSUME_NONNULL_BEGIN
  A version number identifying the default version of the suite of default styles
  provided by Mapbox. This version number may be passed into one of the
  “StyleURLWithVersion” class methods of MGLStyle.
- 
+
  The value of this constant generally corresponds to the latest released version
  as of the date on which this SDK was published. You can use this constant to
  ascertain the style used by `MGLMapView` and `MGLTilePyramidOfflineRegion` when
  no style URL is specified. Consult the
  <a href="https://www.mapbox.com/api-documentation/#styles">Mapbox Styles API documentation</a>
  for the most up-to-date style versioning information.
- 
+
  @warning The value of this constant may change in a future release of the SDK.
     If you use any feature that depends on a specific aspect of a default style
     – for instance, the minimum zoom level that includes roads – you may use the
@@ -30,8 +30,8 @@ NS_ASSUME_NONNULL_BEGIN
 static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
- The proxy object for the current map style for customization purposes and a 
- set of convenience methods for creating style URLs of default styles provided 
+ The proxy object for the current map style for customization purposes and a
+ set of convenience methods for creating style URLs of default styles provided
  by Mapbox.
  <a href="https://www.mapbox.com/maps/">Learn more about Mapbox default styles</a>.
  */
@@ -42,9 +42,9 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
- 
+
  Streets is a general-purpose style with detailed road and transit networks.
- 
+
  `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style
  is specified explicitly.
  */
@@ -53,12 +53,12 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/streets/">Mapbox Streets</a> style.
- 
+
  Streets is a general-purpose style with detailed road and transit networks.
- 
+
  `MGLMapView` and `MGLTilePyramidOfflineRegion` use Mapbox Streets when no style
  is specified explicitly.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -67,7 +67,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/blog/emerald-gl/">Mapbox Emerald</a> style.
- 
+
  Emerald is a tactile style with subtle textures and dramatic hillshading.
  */
 + (NSURL *)emeraldStyleURL __attribute__((deprecated("Create an NSURL object with the string “mapbox://styles/mapbox/emerald-v8”.")));
@@ -75,9 +75,9 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/outdoors/">Mapbox Outdoors</a> style.
- 
+
  Outdoors is a general-purpose style tailored to outdoor activities.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -86,7 +86,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
- 
+
  Light is a subtle, light-colored backdrop for data visualizations.
  */
 + (NSURL *)lightStyleURL __attribute__((deprecated("Use -lightStyleURLWithVersion:.")));
@@ -94,9 +94,9 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Light</a> style.
- 
+
  Light is a subtle, light-colored backdrop for data visualizations.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -105,7 +105,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
- 
+
  Dark is a subtle, dark-colored backdrop for data visualizations.
  */
 + (NSURL *)darkStyleURL __attribute__((deprecated("Use -darkStyleURLWithVersion:.")));
@@ -113,9 +113,9 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/light-dark/">Mapbox Dark</a> style.
- 
+
  Dark is a subtle, dark-colored backdrop for data visualizations.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -124,7 +124,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
- 
+
  Satellite is high-resolution satellite and aerial imagery.
  */
 + (NSURL *)satelliteStyleURL __attribute__((deprecated("Use -satelliteStyleURLWithVersion:.")));
@@ -132,9 +132,9 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite</a> style.
- 
+
  Satellite is high-resolution satellite and aerial imagery.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -144,7 +144,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
  Returns the URL to version 8 of the
  <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a>
  style.
- 
+
  Satellite Streets combines the high-resolution satellite and aerial imagery of
  Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox
  Streets.
@@ -155,11 +155,11 @@ static const NSInteger MGLStyleDefaultVersion = 9;
  Returns the URL to the given version of the
  <a href="https://www.mapbox.com/maps/satellite/">Mapbox Satellite Streets</a>
  style.
- 
+
  Satellite Streets combines the high-resolution satellite and aerial imagery of
  Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox
  Streets.
- 
+
  @param version The style’s latest released version. As of publication, the
     current version is `9`.
  */
@@ -167,7 +167,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  The name of the style.
- 
+
  You can customize the style’s name in Mapbox Studio.
  */
 @property (readonly, copy, nullable) NSString *name;
@@ -177,7 +177,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns a layer that conforms to `MGLStyleLayer` if any layer with the given
  identifier was found.
- 
+
  @return An instance of a concrete subclass of `MGLStyleLayer` associated with
     the given identifier.
  */
@@ -186,7 +186,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Returns a source if any source with the given identifier was found.
- 
+
  @return An instance of a concrete subclass of `MGLSource` associated with the
     given identifier.
  */
@@ -194,7 +194,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Adds a new layer on top of existing layers.
- 
+
  @param layer The layer object to add to the map view. This object must be an
     instance of a concrete subclass of `MGLStyleLayer`.
  */
@@ -202,7 +202,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Inserts a new layer below another layer.
- 
+
  @param layer Layer to be inserted.
  @param belowLayer A layer that's already on the map view.
  */
@@ -210,7 +210,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Removes a layer from the map view.
- 
+
  @param layer The layer object to remove from the map view. This object
  must conform to the `MGLStyleLayer` protocol.
  */
@@ -218,14 +218,14 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Adds a new source to the map view.
- 
+
  @param source The source to add to the map view.
  */
 - (void)addSource:(MGLSource *)source;
 
 /**
  Removes a source from the map view.
- 
+
  @param source The source to remove.
  */
 - (void)removeSource:(MGLSource *)source;
@@ -238,7 +238,7 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 /**
  Returns a Boolean value indicating whether the style class with the given
  identifier is currently active.
- 
+
  @param styleClass The style class to query for.
  @return Whether the style class is currently active.
  */
@@ -246,18 +246,36 @@ static const NSInteger MGLStyleDefaultVersion = 9;
 
 /**
  Activates the style class with the given identifier.
- 
+
  @param styleClass The style class to activate.
  */
 - (void)addStyleClass:(NSString *)styleClass;
 
 /**
  Deactivates the style class with the given identifier.
- 
+
  @param styleClass The style class to deactivate.
  */
 - (void)removeStyleClass:(NSString *)styleClass;
 
+/**
+Adds or overrides an image used by the style’s layers.
+
+To use an image in a style layer, give it a unique name using this method,
+then set the `iconImage` property of an `MGLSymbolStyleLayer` object to that name.
+
+ @param image The image for the name.
+ @param name The name of the image to set to the style.
+ */
+- (void)setImage:(MGLImage *)image forName:(NSString *)name;
+
+/**
+ Removes a name and its associated image from the style.
+
+ @param name The name of the image to remove.
+ */
+- (void)removeImageForName:(NSString *)name;
+
 @end
 
 NS_ASSUME_NONNULL_END