summaryrefslogtreecommitdiff
path: root/include/mbgl/ios/MGLMultiPoint.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/mbgl/ios/MGLMultiPoint.h')
-rw-r--r--include/mbgl/ios/MGLMultiPoint.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/mbgl/ios/MGLMultiPoint.h b/include/mbgl/ios/MGLMultiPoint.h
new file mode 100644
index 0000000000..8da956b539
--- /dev/null
+++ b/include/mbgl/ios/MGLMultiPoint.h
@@ -0,0 +1,17 @@
+#import <Foundation/Foundation.h>
+#import <CoreLocation/CoreLocation.h>
+
+#import "MGLShape.h"
+
+/** The `MGLMultiPoint` class is an abstract superclass used to define shapes composed of multiple points. You should not create instances of this class directly. Instead, you should create instances of the `MGLPolyline` or `MGLPolygon` classes. However, you can use the method and properties of this class to access information about the specific points associated with the line or polygon. */
+@interface MGLMultiPoint : MGLShape
+
+/** The number of points associated with the shape. (read-only) */
+@property (nonatomic, readonly) NSUInteger pointCount;
+
+/** Retrieves one or more coordinates associated with the shape.
+* @param coords On input, you must provide a C array of structures large enough to hold the desired number of coordinates. On output, this structure contains the requested coordinate data.
+* @param range The range of points you want. The `location` field indicates the first point you are requesting, with `0` being the first point, `1` being the second point, and so on. The `length` field indicates the number of points you want. The array in _`coords`_ must be large enough to accommodate the number of requested coordinates. */
+- (void)getCoordinates:(CLLocationCoordinate2D *)coords range:(NSRange)range;
+
+@end