summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLFillStyleLayer.h
blob: 92d922c0966bb79ba439c61a54c17f4df8ba0ad8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
// This file is generated.
// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`.

#import "MGLFoundation.h"
#import "MGLStyleValue.h"
#import "MGLVectorStyleLayer.h"

NS_ASSUME_NONNULL_BEGIN

/**
 Controls the translation reference point.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of
 `MGLInterpolationModeInterval`

 Values of this type are used in the `MGLFillStyleLayer.fillTranslationAnchor`
 property.
 */
typedef NS_ENUM(NSUInteger, MGLFillTranslationAnchor) {
    /**
     The fill is translated relative to the map.
     
     This property can be set to one of the following values:
     
     - `MGLStyleConstantValue`
     - `MGLCameraStyleFunction` with an interpolation mode of
     `MGLInterpolationModeInterval`
     */
    MGLFillTranslationAnchorMap,
    /**
     The fill is translated relative to the viewport.
     
     This property can be set to one of the following values:
     
     - `MGLStyleConstantValue`
     - `MGLCameraStyleFunction` with an interpolation mode of
     `MGLInterpolationModeInterval`
     */
    MGLFillTranslationAnchorViewport,
};

/**
 An `MGLFillStyleLayer` is a style layer that renders one or more filled (and
 optionally stroked) polygons on the map.
 
 Use a fill style layer to configure the visual appearance of polygon or
 multipolygon features in vector tiles loaded by an `MGLVectorSource` object or
 `MGLPolygon`, `MGLPolygonFeature`, `MGLMultiPolygon`, or
 `MGLMultiPolygonFeature` instances in an `MGLShapeSource` object.

 You can access an existing fill style layer using the
 `-[MGLStyle layerWithIdentifier:]` method if you know its identifier;
 otherwise, find it using the `MGLStyle.layers` property. You can also create a
 new fill style layer and add it to the style using a method such as
 `-[MGLStyle addLayer:]`.

 ### Example

 ```swift
 let layer = MGLFillStyleLayer(identifier: "parks", source: parks)
 layer.sourceLayerIdentifier = "parks"
 layer.fillColor = MGLStyleValue(rawValue: .green)
 layer.predicate = NSPredicate(format: "type == %@", "national-park")
 mapView.style?.addLayer(layer)
 ```
 */
MGL_EXPORT
@interface MGLFillStyleLayer : MGLVectorStyleLayer

#pragma mark - Accessing the Paint Attributes

/**
 Whether or not the fill should be antialiased.
 
 The default value of this property is an `MGLStyleValue` object containing an
 `NSNumber` object containing `YES`. Set this property to `nil` to reset it to
 the default value.
 
 This attribute corresponds to the <a
 href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-fill-antialias"><code>fill-antialias</code></a>
 layout property in the Mapbox Style Specification.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of
 `MGLInterpolationModeInterval`
 */
@property (nonatomic, null_resettable, getter=isFillAntialiased) MGLStyleValue<NSNumber *> *fillAntialiased;

@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *fillAntialias __attribute__((unavailable("Use fillAntialiased instead.")));

#if TARGET_OS_IPHONE
/**
 The color of the filled part of this layer.
 
 The default value of this property is an `MGLStyleValue` object containing
 `UIColor.blackColor`. Set this property to `nil` to reset it to the default
 value.
 
 This property is only applied to the style if `fillPattern` is set to `nil`.
 Otherwise, it is ignored.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 - `MGLSourceStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
   - `MGLInterpolationModeIdentity`
 - `MGLCompositeStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
 */
@property (nonatomic, null_resettable) MGLStyleValue<UIColor *> *fillColor;
#else
/**
 The color of the filled part of this layer.
 
 The default value of this property is an `MGLStyleValue` object containing
 `NSColor.blackColor`. Set this property to `nil` to reset it to the default
 value.
 
 This property is only applied to the style if `fillPattern` is set to `nil`.
 Otherwise, it is ignored.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 - `MGLSourceStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
   - `MGLInterpolationModeIdentity`
 - `MGLCompositeStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSColor *> *fillColor;
#endif

/**
 The opacity of the entire fill layer. In contrast to the `fillColor`, this
 value will also affect the 1pt stroke around the fill, if the stroke is used.
 
 The default value of this property is an `MGLStyleValue` object containing an
 `NSNumber` object containing the float `1`. Set this property to `nil` to reset
 it to the default value.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 - `MGLSourceStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
   - `MGLInterpolationModeIdentity`
 - `MGLCompositeStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *fillOpacity;

#if TARGET_OS_IPHONE
/**
 The outline color of the fill. Matches the value of `fillColor` if unspecified.
 
 This property is only applied to the style if `fillPattern` is set to `nil`,
 and `fillAntialiased` is set to an `MGLStyleValue` object containing an
 `NSNumber` object containing `YES`. Otherwise, it is ignored.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 - `MGLSourceStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
   - `MGLInterpolationModeIdentity`
 - `MGLCompositeStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
 */
@property (nonatomic, null_resettable) MGLStyleValue<UIColor *> *fillOutlineColor;
#else
/**
 The outline color of the fill. Matches the value of `fillColor` if unspecified.
 
 This property is only applied to the style if `fillPattern` is set to `nil`,
 and `fillAntialiased` is set to an `MGLStyleValue` object containing an
 `NSNumber` object containing `YES`. Otherwise, it is ignored.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 - `MGLSourceStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
   - `MGLInterpolationModeIdentity`
 - `MGLCompositeStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
   - `MGLInterpolationModeCategorical`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSColor *> *fillOutlineColor;
#endif

/**
 Name of image in sprite to use for drawing image fills. For seamless patterns,
 image width and height must be a factor of two (2, 4, 8, ..., 512).
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of
 `MGLInterpolationModeInterval`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSString *> *fillPattern;

#if TARGET_OS_IPHONE
/**
 The geometry's offset.
 
 This property is measured in points.
 
 The default value of this property is an `MGLStyleValue` object containing an
 `NSValue` object containing a `CGVector` struct set to 0 points rightward and 0
 points downward. Set this property to `nil` to reset it to the default value.
 
 This attribute corresponds to the <a
 href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-fill-translate"><code>fill-translate</code></a>
 layout property in the Mapbox Style Specification.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslation;
#else
/**
 The geometry's offset.
 
 This property is measured in points.
 
 The default value of this property is an `MGLStyleValue` object containing an
 `NSValue` object containing a `CGVector` struct set to 0 points rightward and 0
 points upward. Set this property to `nil` to reset it to the default value.
 
 This attribute corresponds to the <a
 href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-fill-translate"><code>fill-translate</code></a>
 layout property in the Mapbox Style Specification.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of:
   - `MGLInterpolationModeExponential`
   - `MGLInterpolationModeInterval`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslation;
#endif

@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslate __attribute__((unavailable("Use fillTranslation instead.")));

/**
 Controls the translation reference point.
 
 The default value of this property is an `MGLStyleValue` object containing an
 `NSValue` object containing `MGLFillTranslationAnchorMap`. Set this property to
 `nil` to reset it to the default value.
 
 This property is only applied to the style if `fillTranslation` is non-`nil`.
 Otherwise, it is ignored.
 
 This attribute corresponds to the <a
 href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-fill-translate-anchor"><code>fill-translate-anchor</code></a>
 layout property in the Mapbox Style Specification.
 
 This property can be set to one of the following values:
 
 - `MGLStyleConstantValue`
 - `MGLCameraStyleFunction` with an interpolation mode of
 `MGLInterpolationModeInterval`
 */
@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslationAnchor;

@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslateAnchor __attribute__((unavailable("Use fillTranslationAnchor instead.")));

@end

/**
 Methods for wrapping an enumeration value for a style layer attribute in an
 `MGLFillStyleLayer` object and unwrapping its raw value.
 */
@interface NSValue (MGLFillStyleLayerAdditions)

#pragma mark Working with Fill Style Layer Attribute Values

/**
 Creates a new value object containing the given `MGLFillTranslationAnchor` enumeration.

 @param fillTranslationAnchor The value for the new object.
 @return A new value object that contains the enumeration value.
 */
+ (instancetype)valueWithMGLFillTranslationAnchor:(MGLFillTranslationAnchor)fillTranslationAnchor;

/**
 The `MGLFillTranslationAnchor` enumeration representation of the value.
 */
@property (readonly) MGLFillTranslationAnchor MGLFillTranslationAnchorValue;

@end

NS_ASSUME_NONNULL_END