summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLLineStyleLayer.h
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@users.noreply.github.com>2016-09-30 15:55:46 -0700
committerGitHub <noreply@github.com>2016-09-30 15:55:46 -0700
commitee4715a821437e6ed374231fad2ca6193eeac499 (patch)
treea1572535dae544aea91c963d3577a4ecb99c5e2c /platform/darwin/src/MGLLineStyleLayer.h
parent5b28ebbeca8f28e4a8d415911c51eb5070c3362a (diff)
downloadqtlocation-mapboxgl-ee4715a821437e6ed374231fad2ca6193eeac499.tar.gz
update style generation code for new style spec enum values docs (#6508)
Documentation for enum values landed in mapbox/mapbox-gl-style-spec#510. This updates Android, iOS, and macOS documentation code gen scripts to capitalize on them.
Diffstat (limited to 'platform/darwin/src/MGLLineStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLLineStyleLayer.h35
1 files changed, 34 insertions, 1 deletions
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h
index 58c601d53c..d0a341d024 100644
--- a/platform/darwin/src/MGLLineStyleLayer.h
+++ b/platform/darwin/src/MGLLineStyleLayer.h
@@ -6,20 +6,53 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ The display of line endings.
+ */
typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineCap) {
+ /**
+ A cap with a squared-off end which is drawn to the exact endpoint of the line.
+ */
MGLLineStyleLayerLineCapButt,
+ /**
+ 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.
+ */
MGLLineStyleLayerLineCapRound,
+ /**
+ 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.
+ */
MGLLineStyleLayerLineCapSquare,
};
+/**
+ The display of lines when joining.
+ */
typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineJoin) {
+ /**
+ 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.
+ */
MGLLineStyleLayerLineJoinBevel,
+ /**
+ 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.
+ */
MGLLineStyleLayerLineJoinRound,
+ /**
+ A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
+ */
MGLLineStyleLayerLineJoinMiter,
};
+/**
+ Controls the translation reference point.
+ */
typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineTranslateAnchor) {
+ /**
+ The line is translated relative to the map.
+ */
MGLLineStyleLayerLineTranslateAnchorMap,
+ /**
+ The line is translated relative to the viewport.
+ */
MGLLineStyleLayerLineTranslateAnchorViewport,
};
@@ -116,7 +149,7 @@ typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineTranslateAnchor) {
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineTranslate;
/**
- Control whether the translation is relative to the map (north) or viewport (screen)
+ Controls the translation reference point.
The default value of this property is an `NSValue` object containing `MGLLineStyleLayerLineTranslateAnchorMap`. Set this property to `nil` to reset it to the default value.