diff options
Diffstat (limited to 'platform/darwin/src/MGLMultiPoint.h')
| -rw-r--r-- | platform/darwin/src/MGLMultiPoint.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/platform/darwin/src/MGLMultiPoint.h b/platform/darwin/src/MGLMultiPoint.h index 31ab5744a3..ca08e5405a 100644 --- a/platform/darwin/src/MGLMultiPoint.h +++ b/platform/darwin/src/MGLMultiPoint.h @@ -9,12 +9,12 @@ NS_ASSUME_NONNULL_BEGIN /** The `MGLMultiPoint` class is an abstract superclass used to define shapes composed of multiple vertices. - + You do not create instances of this class directly. Instead, you create instances of the `MGLPolyline` or `MGLPolygon` classes. However, you can use the method and properties of this class to access information about the vertices of the line or polygon. - + Do not confuse `MGLMultiPoint` with `MGLPointCollection`, which represents a collection of related but disconnected points. */ @@ -23,7 +23,7 @@ MGL_EXPORT /** The array of vertices associated with the shape. - + This C array is a pointer to a structure inside the multipoint object, which may have a lifetime shorter than the multipoint object and will certainly not have a longer lifetime. Therefore, you should copy the C array if it needs to @@ -36,7 +36,7 @@ MGL_EXPORT /** Retrieves the vertices of part of the shape. - + @param coords On input, you must provide a C array of `CLLocationCoordinate2D` structures large enough to hold the desired number of coordinates. On output, this structure contains the requested coordinate data. @@ -50,7 +50,7 @@ MGL_EXPORT /** Sets the shape’s vertices to the given C array of vertices. - + @param coords The array of coordinates defining the shape. The data in this array is copied to the shape’s `coordinates` property. @param count The number of coordinates from the `coords` array. @@ -60,7 +60,7 @@ MGL_EXPORT /** Inserts the given vertices into the shape. If the shape is currently visible on the map, it is redrawn immediately. - + @param coords The array of coordinates to insert into the shape. The data in this array is copied to the shape’s `coordinates` property. @param count The number of items in the `coords` array. @@ -72,7 +72,7 @@ MGL_EXPORT /** Appends the given vertices to the shape. If the shape is currently visible on the map, it is redrawn immediately. - + @param coords The array of coordinates to add to the shape. The data in this array is copied to the shape’s `coordinates` property. @param count The number of items in the `coords` array. @@ -83,15 +83,15 @@ MGL_EXPORT Replaces the vertices at the given range in the shape with the same number of vertices from a given C array. If the shape is currently visible on the map, it is redrawn immediately. - + The number of coordinates in `coords` must be equal to the length of `range`. If you want to insert or delete one or more vertices, use the `-replaceCoordinatesInRange:withCoordinates:count:` method. - + If `range` extends beyond the shape’s `coordinates` property, an `NSRangeException` is raised. If you want to append new vertices to the shape, use the `-appendCoordinates:count:` method. - + @param range The range of vertices to replace. The `location` field indicates the first vertex you are replacing, with `0` being the first vertex, `1` being the second vertex, and so on. The `length` field indicates the number @@ -105,15 +105,15 @@ MGL_EXPORT Replaces the vertices at the given range in the shape with the specified number of vertices from a given C array. If the shape is currently visible on the map, it is redrawn immediately. - + If `count` is greater than the `length` field of `range`, some vertices will effectively be inserted into the shape. On the other hand, if `count` is less than the `length` field of `range`, some vertices will effectively be removed. - + If `range` extends beyond the shape’s `coordinates` property, an `NSRangeException` is raised. If you want to append new vertices to the shape, use the `-appendCoordinates:count:` method. - + @param range The range of vertices to replace. The `location` field indicates the first vertex you are replacing, with `0` being the first vertex, `1` being the second vertex, and so on. The `length` field indicates the number @@ -130,10 +130,10 @@ MGL_EXPORT /** Removes the vertices at the given range from the shape. If the shape is currently visible on the map, it is redrawn immediately. - + If `range` extends beyond the shape’s `coordinates` property, an `NSRangeException` is raised. - + @param range The range of vertices to remove. The `location` field indicates the first vertex you are removing, with `0` being the first vertex, `1` being the second vertex, and so on. The `length` field indicates the number |