AGSMutablePolyline Class Reference
Description
A mutable version of AGSPolyline.
- Defined in:
- AGSPolyline.h ( ArcGIS library)
- Since:
- 1.0
Inheritance diagram for AGSMutablePolyline:
Public Member Functions | |
| (void) | - addPathToPolyline |
| (void) | - addPoint:toPath: |
| (void) | - addPointToPath: |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
| (id) | - initWithJSON:spatialReference: |
| (id) | - initWithSpatialReference: |
| (void) | - insertPathAtIndex: |
| (void) | - insertPoint:onPath:atIndex: |
| (BOOL) | - intersectsWithEnvelope: |
| (BOOL) | - isEmpty |
| (BOOL) | - isEqualToPolyline: |
| (BOOL) | - isValid |
| (NSUInteger) | - numPointsInPath: |
| (AGSPoint *) | - pointOnPath:atIndex: |
| (void) | - removePathAtIndex: |
| (void) | - removePointOnPath:atIndex: |
| (void) | - updatePoint:onPath:atIndex: |
Static Public Member Functions | |
| (id) | + polylineWithJSON: |
Properties | |
| NSUInteger | numPaths |
| AGSSpatialReference * | spatialReference |
Member Function Documentation
| - (void) addPathToPolyline |
Create new path and add it to the polyline.
- Since:
- 1.0
| - (void) addPoint: | (AGSPoint *) | point | ||
| toPath: | (NSUInteger) | path | ||
Add point to the end of path.
- Parameters:
-
point The point to be added. path The index of the path to add pointto.
- Since:
- 1.0
| - (void) addPointToPath: | (AGSPoint *) | point |
Add point to end of current path.
- Parameters:
-
point The point to be added.
- Since:
- 1.0
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | ||
| spatialReference: | (AGSSpatialReference*) | sr | ||
Initialize geometry object with json and a spatial reference.
- Parameters:
-
json The JSON to initialize an AGSGeometrywith.sr The spatial reference of geometry represented in json.
- Returns:
- A new geometry object.
- Since:
- 1.0
| - (id) initWithSpatialReference: | (AGSSpatialReference *) | spatialReference |
Initialize geometry object with spatial reference.
- Parameters:
-
spatialReference The spatial referenc of geometry.
- Returns:
- A new geometry object.
- Since:
- 1.0
| - (void) insertPathAtIndex: | (int) | pathIndex |
Inserts a path at a specific index.
- Since:
- 1.8
| - (void) insertPoint: | (AGSPoint *) | point | ||
| onPath: | (NSUInteger) | path | ||
| atIndex: | (NSUInteger) | index | ||
Insert point into path at specific index.
- Parameters:
-
point The point to be added. path The index of the path to add pointto.index The index to add pointat.
- Since:
- 1.0
| - (BOOL) intersectsWithEnvelope: | (AGSEnvelope *) | envelope |
Returns true if envelope intersects this geometry.
- Parameters:
-
envelope The envelope to test intersection relation.
- Returns:
Trueif envelopes intersects.
- Since:
- 1.0
Reimplemented in AGSEnvelope.
| - (BOOL) isEmpty |
| - (BOOL) isEqualToPolyline: | (AGSPolyline*) | other |
Returns a value whether another polyline is equal to this polyline.
- Parameters:
-
other The other polyline to compare to.
- Returns:
- Whether or not the other polyline is equal to this polyline.
- Since:
- 1.8
| - (BOOL) isValid |
Returns whether or not the geometry is valid.
- Since:
- 1.8
| - (NSUInteger) numPointsInPath: | (NSUInteger) | path |
Get number of points in the specified path.
- Parameters:
-
path The index of the desired path.
- Returns:
- Number of points in path.
- Since:
- 1.0
| - (AGSPoint *) pointOnPath: | (NSUInteger) | path | ||
| atIndex: | (NSUInteger) | index | ||
Get point from path at specified index.
- Parameters:
-
path The index of desired path. index The index of the desired point.
- Returns:
- Point in
pathatindex.
- Since:
- 1.0
| + (id) polylineWithJSON: | (NSDictionary *) | json |
Initialize a new autoreleased polyline geometry.
- Parameters:
-
json The JSON representation for polyline. See REST API documentation for JSON syntax.
- Returns:
- A new, autoreleased, polyline geometry object.
- Since:
- 1.0
| - (void) removePathAtIndex: | (NSUInteger) | index |
Remove path from polyline.
- Parameters:
-
index The index of the path to be removed.
- Since:
- 1.0
| - (void) removePointOnPath: | (NSUInteger) | path | ||
| atIndex: | (NSUInteger) | index | ||
Remove point from specified path.
- Parameters:
-
path The index of the path to remove point from. index The index to remove point from.
- Since:
- 1.0
| - (void) updatePoint: | (AGSPoint *) | point | ||
| onPath: | (NSUInteger) | pathIndex | ||
| atIndex: | (NSUInteger) | ptIndex | ||
Update point on specified path and index with point.
- Parameters:
-
point The point to update current point. pathIndex The index of the path that contains the point to be updated. ptIndex The index to update point at.
- Since:
- 1.0
Property Documentation
- (NSUInteger) numPaths [read, assign, inherited] |
Number of paths in polyline.
- Since:
- 1.0
- (AGSSpatialReference*) spatialReference [read, write, retain] |