From a383edaae8ec05a3b385b19576c7a9358672662b Mon Sep 17 00:00:00 2001 From: Jesse Bounds Date: Mon, 6 Feb 2017 15:07:13 -0800 Subject: [ios, macos] Add function and interpolation mode to style property docs --- platform/darwin/src/MGLFillStyleLayer.h | 134 ++++++++++++++++++++++++++++---- 1 file changed, 121 insertions(+), 13 deletions(-) (limited to 'platform/darwin/src/MGLFillStyleLayer.h') diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h index 86f3b1fab0..58bf3d9b6a 100644 --- a/platform/darwin/src/MGLFillStyleLayer.h +++ b/platform/darwin/src/MGLFillStyleLayer.h @@ -8,18 +8,36 @@ NS_ASSUME_NONNULL_BEGIN /** - Controls the translation reference point. + 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. + 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. + 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, }; @@ -63,7 +81,13 @@ MGL_EXPORT This attribute corresponds to the fill-antialias - layout property in the Mapbox Style Specification. + 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 *fillAntialiased; @@ -78,7 +102,19 @@ MGL_EXPORT value. This property is only applied to the style if `fillPattern` is set to `nil`. - Otherwise, it is ignored. + Otherwise, it is ignored.` + + This property can be set to one of the following values: + + - `MGLStyleConstantValue` + - `MGLCameraStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval` + - `MGLSourceStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`, + `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity` + - `MGLCompositeStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or + `MGLInterpolationModeCategorical` */ @property (nonatomic, null_resettable) MGLStyleValue *fillColor; #else @@ -90,7 +126,19 @@ MGL_EXPORT value. This property is only applied to the style if `fillPattern` is set to `nil`. - Otherwise, it is ignored. + Otherwise, it is ignored.` + + This property can be set to one of the following values: + + - `MGLStyleConstantValue` + - `MGLCameraStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval` + - `MGLSourceStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`, + `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity` + - `MGLCompositeStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or + `MGLInterpolationModeCategorical` */ @property (nonatomic, null_resettable) MGLStyleValue *fillColor; #endif @@ -101,7 +149,19 @@ MGL_EXPORT 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. + it to the default value.` + + This property can be set to one of the following values: + + - `MGLStyleConstantValue` + - `MGLCameraStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval` + - `MGLSourceStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`, + `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity` + - `MGLCompositeStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or + `MGLInterpolationModeCategorical` */ @property (nonatomic, null_resettable) MGLStyleValue *fillOpacity; @@ -111,7 +171,19 @@ MGL_EXPORT 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. + `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` or `MGLInterpolationModeInterval` + - `MGLSourceStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`, + `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity` + - `MGLCompositeStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or + `MGLInterpolationModeCategorical` */ @property (nonatomic, null_resettable) MGLStyleValue *fillOutlineColor; #else @@ -120,14 +192,32 @@ MGL_EXPORT 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. + `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` or `MGLInterpolationModeInterval` + - `MGLSourceStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`, + `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity` + - `MGLCompositeStyleFunction` with an interpolation mode of + `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or + `MGLInterpolationModeCategorical` */ @property (nonatomic, null_resettable) MGLStyleValue *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). + 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 *fillPattern; @@ -143,7 +233,13 @@ MGL_EXPORT This attribute corresponds to the fill-translate - layout property in the Mapbox Style Specification. + 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` or `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *fillTranslation; #else @@ -158,7 +254,13 @@ MGL_EXPORT This attribute corresponds to the fill-translate - layout property in the Mapbox Style Specification. + 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` or `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *fillTranslation; #endif @@ -177,7 +279,13 @@ MGL_EXPORT This attribute corresponds to the fill-translate-anchor - layout property in the Mapbox Style Specification. + 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 *fillTranslationAnchor; -- cgit v1.2.1