summaryrefslogtreecommitdiff
path: root/platform/darwin/include/MGLPolygon.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/darwin/include/MGLPolygon.h')
-rw-r--r--platform/darwin/include/MGLPolygon.h26
1 files changed, 26 insertions, 0 deletions
diff --git a/platform/darwin/include/MGLPolygon.h b/platform/darwin/include/MGLPolygon.h
new file mode 100644
index 0000000000..c5480264fb
--- /dev/null
+++ b/platform/darwin/include/MGLPolygon.h
@@ -0,0 +1,26 @@
+#import <Foundation/Foundation.h>
+#import <CoreLocation/CoreLocation.h>
+
+#import "MGLMultiPoint.h"
+#import "MGLOverlay.h"
+
+#import "MGLTypes.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** The `MGLPolygon` class represents a shape consisting of one or more points that define a closed polygon. The points are connected end-to-end in the order they are provided. The first and last points are connected to each other to create the closed shape. */
+@interface MGLPolygon : MGLMultiPoint <MGLOverlay>
+
+/**
+ Creates and returns an `MGLPolygon` object from the specified set of coordinates.
+
+ @param coords The array of coordinates defining the shape. The data in this array is copied to the new object.
+ @param count The number of items in the `coords` array.
+ @return A new polygon object.
+ */
++ (instancetype)polygonWithCoordinates:(CLLocationCoordinate2D *)coords
+ count:(NSUInteger)count;
+
+@end
+
+NS_ASSUME_NONNULL_END