* [ios, macos] Import headers, not implementation files * [core] Added accessors for various expression parameters Added missing parameter accessors to various expression operator classes, as well as a method on InterpolatorBase and Step that enumerates the stops and their values. * [ios, macos] Silenced warning in test of error condition * [ios, macos] Made MGLSphericalPosition boxable * [ios, macos] Implemented array enumeration during conversion * [ios, macos] Temporarily ignore heatmap layer type * [ios, macos] Migrated MGLSymbolStyleLayer.text to NSExpression MGLSymbolStyleLayer.text is now of type NSExpression instead of MGLStyleValue, as a first step toward migrating the entire layer API from style values to expressions. Implemented conversions from NSExpression to JSON arrays and vice versa. The most common NSExpression functions are now converted into style expressions, but not all of the most common style expression operators are supported yet. * [ios, macos] Implemented string coercion * [ios, macos] Color literals * [ios, macos] Null constant expressions * [ios, macos] Convert dictionary literals * [ios, macos] Interpolation expressions * [ios, macos] to-boolean, to-number, get from object * [ios, macos] Variable expressions Implemented custom expression functions for assigning and referring to variables within the context of an expression. Variables are assigned via a “context dictionary” and applied to an subexpression that is given as another argument to the same expression. Also implemented built-in variable expressions for zoom level and heatmap density. * [ios, macos] Convert colors, offsets, padding in expressions to JSON objects * [ios, macos] Expression-based style property getters Implemented a conversion from mbgl::style::PropertyValues to Objective-C JSON objects, which are then converted to NSExpressions. * [ios, macos] Consolidated property value–expression conversion in MGLStyleValueTransformer * [ios, macos] Predicate and expression guide Extracted documentation about predicates from a documentation comment in MGLVectorStyleLayer.h to a new jazzy guide. Added details about NSExpression support as well. Began updating the “For Style Authors” guide to reflect the transition from style values to expressions. * [ios, macos] Updated style authoring guide Updated the Information for Style Authors guide to discuss expressions instead of style functions. Included a table mapping style specification expression operators to NSExpression syntaxes. * [ios, macos] Migrated codegen templates to expressions * [ios, macos] Applied expression changes via codegen Ran make darwin-style-code. * [macos] Migrated macosapp to expressions * [ios, macos] Updated style function guide This guide needs to be thoroughly rewritten, but for now the example code has been migrated to expressions. * [ios, macos] Eviscerated style function tests * [ios, macos] Updated changelogs * [ios] Migrated iosapp to expressions * [ios, macos] Exposed JSON conversion methods publicly * [ios, macos] Removed MGLStyleValue, MGLStyleFunction
334 lines
13 KiB
Objective-C
334 lines
13 KiB
Objective-C
// This file is generated.
|
||
// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`.
|
||
|
||
#import "MGLFoundation.h"
|
||
#import "MGLVectorStyleLayer.h"
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
/**
|
||
Controls the frame of reference for
|
||
`MGLFillExtrusionStyleLayer.fillExtrusionTranslation`.
|
||
|
||
Values of this type are used in the `MGLFillExtrusionStyleLayer.fillExtrusionTranslationAnchor`
|
||
property.
|
||
*/
|
||
typedef NS_ENUM(NSUInteger, MGLFillExtrusionTranslationAnchor) {
|
||
/**
|
||
The fill extrusion is translated relative to the map.
|
||
*/
|
||
MGLFillExtrusionTranslationAnchorMap,
|
||
/**
|
||
The fill extrusion is translated relative to the viewport.
|
||
*/
|
||
MGLFillExtrusionTranslationAnchorViewport,
|
||
};
|
||
|
||
/**
|
||
An `MGLFillExtrusionStyleLayer` is a style layer that renders one or more 3D
|
||
extruded polygons on the map.
|
||
|
||
Use a fill-extrusion 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-extrusion 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-extrusion style layer and add it to the style using a method such as
|
||
`-[MGLStyle addLayer:]`.
|
||
|
||
### Example
|
||
|
||
```swift
|
||
let layer = MGLFillExtrusionStyleLayer(identifier: "buildings", source: buildings)
|
||
layer.sourceLayerIdentifier = "building"
|
||
layer.fillExtrusionHeight = NSExpression(forKeyPath: "height")
|
||
layer.fillExtrusionBase = NSExpression(forKeyPath: "min_height")
|
||
layer.predicate = NSPredicate(format: "extrude == 'true'")
|
||
mapView.style?.addLayer(layer)
|
||
```
|
||
*/
|
||
MGL_EXPORT
|
||
@interface MGLFillExtrusionStyleLayer : MGLVectorStyleLayer
|
||
|
||
/**
|
||
Returns a fill-extrusion style layer initialized with an identifier and source.
|
||
|
||
After initializing and configuring the style layer, add it to a map view’s
|
||
style using the `-[MGLStyle addLayer:]` or
|
||
`-[MGLStyle insertLayer:belowLayer:]` method.
|
||
|
||
@param identifier A string that uniquely identifies the source in the style to
|
||
which it is added.
|
||
@param source The source from which to obtain the data to style. If the source
|
||
has not yet been added to the current style, the behavior is undefined.
|
||
@return An initialized foreground style layer.
|
||
*/
|
||
- (instancetype)initWithIdentifier:(NSString *)identifier source:(MGLSource *)source;
|
||
|
||
#pragma mark - Accessing the Paint Attributes
|
||
|
||
/**
|
||
The height with which to extrude the base of this layer. Must be less than or
|
||
equal to `fillExtrusionHeight`.
|
||
|
||
This property is measured in meters.
|
||
|
||
The default value of this property is an expression that evaluates to the float
|
||
`0`. Set this property to `nil` to reset it to the default value.
|
||
|
||
This property is only applied to the style if `fillExtrusionHeight` is
|
||
non-`nil`. Otherwise, it is ignored.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant numeric values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable and/or
|
||
feature attributes
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionBase;
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionBase` property.
|
||
|
||
This property corresponds to the `fill-extrusion-base-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionBaseTransition;
|
||
|
||
/**
|
||
The base color of this layer. The extrusion's surfaces will be shaded
|
||
differently based on this color in combination with the `light` settings. If
|
||
this color is specified with an alpha component, the alpha component will be
|
||
ignored; use `fillExtrusionOpacity` to set layer opacityco.
|
||
|
||
The default value of this property is an expression that evaluates to
|
||
`UIColor.blackColor`. Set this property to `nil` to reset it to the default
|
||
value.
|
||
|
||
This property is only applied to the style if `fillExtrusionPattern` is set to
|
||
`nil`. Otherwise, it is ignored.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant `UIColor` values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable and/or
|
||
feature attributes
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionColor;
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionColor` property.
|
||
|
||
This property corresponds to the `fill-extrusion-color-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionColorTransition;
|
||
|
||
/**
|
||
The height with which to extrude this layer.
|
||
|
||
This property is measured in meters.
|
||
|
||
The default value of this property is an expression that evaluates to the float
|
||
`0`. Set this property to `nil` to reset it to the default value.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant numeric values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable and/or
|
||
feature attributes
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionHeight;
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionHeight` property.
|
||
|
||
This property corresponds to the `fill-extrusion-height-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionHeightTransition;
|
||
|
||
/**
|
||
The opacity of the entire fill extrusion layer. This is rendered on a
|
||
per-layer, not per-feature, basis, and data-driven styling is not available.
|
||
|
||
The default value of this property is an expression that evaluates to the float
|
||
`1`. Set this property to `nil` to reset it to the default value.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant numeric values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable
|
||
|
||
This property does not support applying interpolation or step functions to
|
||
feature attributes.
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionOpacity;
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionOpacity` property.
|
||
|
||
This property corresponds to the `fill-extrusion-opacity-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionOpacityTransition;
|
||
|
||
/**
|
||
Name of image in style images to use for drawing image fill-extrusions. For
|
||
seamless patterns, image width and height must be a factor of two (2, 4, 8,
|
||
..., 512).
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant string values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Step functions applied to the `$zoomLevel` variable
|
||
|
||
This property does not support applying interpolation functions to the
|
||
`$zoomLevel` variable or applying interpolation or step functions to feature
|
||
attributes.
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionPattern;
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionPattern` property.
|
||
|
||
This property corresponds to the `fill-extrusion-pattern-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionPatternTransition;
|
||
|
||
#if TARGET_OS_IPHONE
|
||
/**
|
||
The geometry's offset.
|
||
|
||
This property is measured in points.
|
||
|
||
The default value of this property is an expression that evaluates to 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-extrusion-translate"><code>fill-extrusion-translate</code></a>
|
||
layout property in the Mapbox Style Specification.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant `CGVector` values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable
|
||
|
||
This property does not support applying interpolation or step functions to
|
||
feature attributes.
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionTranslation;
|
||
#else
|
||
/**
|
||
The geometry's offset.
|
||
|
||
This property is measured in points.
|
||
|
||
The default value of this property is an expression that evaluates to 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-extrusion-translate"><code>fill-extrusion-translate</code></a>
|
||
layout property in the Mapbox Style Specification.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant `CGVector` values
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Interpolation and step functions applied to the `$zoomLevel` variable
|
||
|
||
This property does not support applying interpolation or step functions to
|
||
feature attributes.
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionTranslation;
|
||
#endif
|
||
|
||
/**
|
||
The transition affecting any changes to this layer’s `fillExtrusionTranslation` property.
|
||
|
||
This property corresponds to the `fill-extrusion-translate-transition` property in the style JSON file format.
|
||
*/
|
||
@property (nonatomic) MGLTransition fillExtrusionTranslationTransition;
|
||
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionTranslate __attribute__((unavailable("Use fillExtrusionTranslation instead.")));
|
||
|
||
/**
|
||
Controls the frame of reference for `fillExtrusionTranslation`.
|
||
|
||
The default value of this property is an expression that evaluates to `map`.
|
||
Set this property to `nil` to reset it to the default value.
|
||
|
||
This property is only applied to the style if `fillExtrusionTranslation` is
|
||
non-`nil`. Otherwise, it is ignored.
|
||
|
||
This attribute corresponds to the <a
|
||
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-fill-extrusion-translate-anchor"><code>fill-extrusion-translate-anchor</code></a>
|
||
layout property in the Mapbox Style Specification.
|
||
|
||
You can set this property to an expression containing any of the following:
|
||
|
||
* Constant `MGLFillExtrusionTranslationAnchor` values
|
||
* Any of the following constant string values:
|
||
* `map`: The fill extrusion is translated relative to the map.
|
||
* `viewport`: The fill extrusion is translated relative to the viewport.
|
||
* Predefined functions, including mathematical and string operators
|
||
* Conditional expressions
|
||
* Variable assignments and references to assigned variables
|
||
* Step functions applied to the `$zoomLevel` variable
|
||
|
||
This property does not support applying interpolation functions to the
|
||
`$zoomLevel` variable or applying interpolation or step functions to feature
|
||
attributes.
|
||
*/
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionTranslationAnchor;
|
||
|
||
@property (nonatomic, null_resettable) NSExpression *fillExtrusionTranslateAnchor __attribute__((unavailable("Use fillExtrusionTranslationAnchor instead.")));
|
||
|
||
@end
|
||
|
||
/**
|
||
Methods for wrapping an enumeration value for a style layer attribute in an
|
||
`MGLFillExtrusionStyleLayer` object and unwrapping its raw value.
|
||
*/
|
||
@interface NSValue (MGLFillExtrusionStyleLayerAdditions)
|
||
|
||
#pragma mark Working with Fill extrusion Style Layer Attribute Values
|
||
|
||
/**
|
||
Creates a new value object containing the given `MGLFillExtrusionTranslationAnchor` enumeration.
|
||
|
||
@param fillExtrusionTranslationAnchor The value for the new object.
|
||
@return A new value object that contains the enumeration value.
|
||
*/
|
||
+ (instancetype)valueWithMGLFillExtrusionTranslationAnchor:(MGLFillExtrusionTranslationAnchor)fillExtrusionTranslationAnchor;
|
||
|
||
/**
|
||
The `MGLFillExtrusionTranslationAnchor` enumeration representation of the value.
|
||
*/
|
||
@property (readonly) MGLFillExtrusionTranslationAnchor MGLFillExtrusionTranslationAnchorValue;
|
||
|
||
@end
|
||
|
||
NS_ASSUME_NONNULL_END
|