diff options
Diffstat (limited to 'platform/darwin/src/MGLLineStyleLayer.h')
-rw-r--r-- | platform/darwin/src/MGLLineStyleLayer.h | 326 |
1 files changed, 130 insertions, 196 deletions
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h index e1b621a215..23a1f8f131 100644 --- a/platform/darwin/src/MGLLineStyleLayer.h +++ b/platform/darwin/src/MGLLineStyleLayer.h @@ -9,12 +9,6 @@ NS_ASSUME_NONNULL_BEGIN /** The display of line endings. - - 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 `MGLLineStyleLayer.lineCap` property. @@ -23,47 +17,23 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) { /** A cap with a squared-off end which is drawn to the exact endpoint of the line. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineCapButt, /** A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineCapRound, /** A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineCapSquare, }; /** The display of lines when joining. - - 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 `MGLLineStyleLayer.lineJoin` property. @@ -72,47 +42,23 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) { /** A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineJoinBevel, /** A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineJoinRound, /** A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet. - - This property can be set to one of the following values: - - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of - `MGLInterpolationModeInterval` */ MGLLineJoinMiter, }; /** 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 `MGLLineStyleLayer.lineTranslationAnchor` property. @@ -120,22 +66,10 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) { typedef NS_ENUM(NSUInteger, MGLLineTranslationAnchor) { /** The line 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` */ MGLLineTranslationAnchorMap, /** The line 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` */ MGLLineTranslationAnchorViewport, }; @@ -182,10 +116,10 @@ MGL_EXPORT `NSValue` object containing `MGLLineCapButt`. Set this property to `nil` to reset it to the default value. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *lineCap; @@ -197,10 +131,10 @@ MGL_EXPORT `NSValue` object containing `MGLLineJoinMiter`. Set this property to `nil` to reset it to the default value. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *lineJoin; @@ -216,12 +150,12 @@ MGL_EXPORT `MGLStyleValue` object containing an `NSValue` object containing `MGLLineJoinMiter`. Otherwise, it is ignored. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of: - - `MGLInterpolationModeExponential` - - `MGLInterpolationModeInterval` + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of: + * `MGLInterpolationModeExponential` + * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *lineMiterLimit; @@ -236,12 +170,12 @@ MGL_EXPORT `MGLStyleValue` object containing an `NSValue` object containing `MGLLineJoinRound`. Otherwise, it is ignored. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of: - - `MGLInterpolationModeExponential` - - `MGLInterpolationModeInterval` + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of: + * `MGLInterpolationModeExponential` + * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *lineRoundLimit; @@ -256,21 +190,21 @@ MGL_EXPORT `NSNumber` object containing the float `0`. 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` + You can set this property to an instance of: + + * `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 *> *lineBlur; @@ -285,21 +219,21 @@ MGL_EXPORT This property is only applied to the style if `linePattern` 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` + You can set this property to an instance of: + + * `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 *> *lineColor; #else @@ -313,21 +247,21 @@ MGL_EXPORT This property is only applied to the style if `linePattern` 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` + You can set this property to an instance of: + + * `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 *> *lineColor; #endif @@ -346,10 +280,10 @@ MGL_EXPORT href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-dasharray"><code>line-dasharray</code></a> layout property in the Mapbox Style Specification. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSArray<NSNumber *> *> *lineDashPattern; @@ -366,21 +300,21 @@ MGL_EXPORT `NSNumber` object containing the float `0`. 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` + You can set this property to an instance of: + + * `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 *> *lineGapWidth; @@ -396,21 +330,21 @@ MGL_EXPORT `NSNumber` object containing the float `0`. 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` + You can set this property to an instance of: + + * `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 *> *lineOffset; @@ -421,21 +355,21 @@ MGL_EXPORT `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` + You can set this property to an instance of: + + * `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 *> *lineOpacity; @@ -443,10 +377,10 @@ MGL_EXPORT Name of image in style images to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSString *> *linePattern; @@ -465,12 +399,12 @@ MGL_EXPORT href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate"><code>line-translate</code></a> layout property in the Mapbox Style Specification. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of: - - `MGLInterpolationModeExponential` - - `MGLInterpolationModeInterval` + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of: + * `MGLInterpolationModeExponential` + * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *lineTranslation; #else @@ -487,12 +421,12 @@ MGL_EXPORT href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate"><code>line-translate</code></a> layout property in the Mapbox Style Specification. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of: - - `MGLInterpolationModeExponential` - - `MGLInterpolationModeInterval` + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of: + * `MGLInterpolationModeExponential` + * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *lineTranslation; #endif @@ -513,10 +447,10 @@ MGL_EXPORT href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate-anchor"><code>line-translate-anchor</code></a> layout property in the Mapbox Style Specification. - This property can be set to one of the following values: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *lineTranslationAnchor; @@ -532,12 +466,12 @@ MGL_EXPORT `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: + You can set this property to an instance of: - - `MGLStyleConstantValue` - - `MGLCameraStyleFunction` with an interpolation mode of: - - `MGLInterpolationModeExponential` - - `MGLInterpolationModeInterval` + * `MGLStyleConstantValue` + * `MGLCameraStyleFunction` with an interpolation mode of: + * `MGLInterpolationModeExponential` + * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *lineWidth; |