10.2.5: AGSMutablePolyline Class Reference
10.2.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
AGSMutablePolyline Class Reference

Description

A mutable version of AGSPolyline.

Defined in:
AGSPolyline.h ( ArcGIS library)

Since
1.0
Inheritance diagram for AGSMutablePolyline:
AGSPolyline AGSGeometry <AGSCoding>

Instance Methods

(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
 
(NSInteger) - numPoints
 
(NSInteger) - numPointsInPath:
 
(AGSPoint *) - pointOnPath:atIndex:
 
(void) - removePathAtIndex:
 
(void) - removePointOnPath:atIndex:
 
(void) - updatePoint:onPath:atIndex:
 

Class Methods

(id) + polylineWithJSON:
 

Properties

AGSEnvelopeenvelope
 
NSInteger numPaths
 
AGSSpatialReferencespatialReference
 

Method Documentation

- (void) addPathToPolyline

Create new path and add it to the polyline.

Since
1.0
- (void) addPoint: (AGSPoint *)  point
toPath: (NSInteger)  path 

Add point to the end of path.

Parameters
pointThe point to be added.
pathThe index of the path to add point to.
Since
1.0
- (void) addPointToPath: (AGSPoint *)  point

Add point to end of current path.

Parameters
pointThe point to be added.
Since
1.0
- (void) decodeWithJSON: (NSDictionary *)  json
optionalinherited

Decode object from JSON representation.

Parameters
jsonThe JSON representation of the object to be decoded.
Since
1.0
- (NSDictionary *) encodeToJSON
optionalinherited

Encode and return JSON representation for object.

Returns
JSON representation of object.
Since
1.0
- (id) initWithJSON: (NSDictionary *)  json
optionalinherited

Initialize and return object from JSON representation.

Parameters
jsonThe JSON representation of the object to be created.
Returns
Object decoded from JSON representation.
Since
1.0

Reimplemented in AGSWebMapFeatureCollection.

- (id) initWithJSON: (NSDictionary *)  json
spatialReference: (AGSSpatialReference *)  sr 

Initialize geometry object with json and a spatial reference.

Parameters
jsonThe JSON to initialize an AGSGeometry with.
srThe 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
spatialReferenceThe spatial referenc of geometry.
Returns
A new geometry object.
Since
1.0
- (void) insertPathAtIndex: (NSInteger)  pathIndex

Inserts a path at a specific index.

Since
1.8
- (void) insertPoint: (AGSPoint *)  point
onPath: (NSInteger)  path
atIndex: (NSInteger)  index 

Insert point into path at specific index.

Parameters
pointThe point to be added.
pathThe index of the path to add point to.
indexThe index to add point at.
Since
1.0
- (BOOL) intersectsWithEnvelope: (AGSEnvelope *)  envelope

Returns true if envelope intersects this geometry.

Parameters
envelopeThe envelope to test intersection relation.
Returns
True if envelopes intersects.
Since
1.0

Implemented in AGSEnvelope.

- (BOOL) isEmpty

Returns whether or not the geometry is empty.

Since
1.8

Implemented in AGSEnvelope.

- (BOOL) isEqualToPolyline: (AGSPolyline *)  other

Returns a value whether another polyline is equal to this polyline.

Parameters
otherThe 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
- (NSInteger) numPoints

Returns the total number for points in the polyline.

Since
10.1.1
- (NSInteger) numPointsInPath: (NSInteger)  path

Get number of points in the specified path.

Parameters
pathThe index of the desired path.
Returns
Number of points in path.
Since
1.0
- (AGSPoint *) pointOnPath: (NSInteger)  path
atIndex: (NSInteger)  index 

Get point from path at specified index.

Parameters
pathThe index of desired path.
indexThe index of the desired point.
Returns
Point in path at index.
Since
1.0
+ (id) polylineWithJSON: (NSDictionary *)  json

Initialize a new autoreleased polyline geometry.

Parameters
jsonThe JSON representation for polyline. REST API documentation for JSON syntax.
Returns
A new, autoreleased, polyline geometry object.
Since
1.0
- (void) removePathAtIndex: (NSInteger)  index

Remove path from polyline.

Parameters
indexThe index of the path to be removed.
Since
1.0
- (void) removePointOnPath: (NSInteger)  path
atIndex: (NSInteger)  index 

Remove point from specified path.

Parameters
pathThe index of the path to remove point from.
indexThe index to remove point from.
Since
1.0
- (void) updatePoint: (AGSPoint *)  point
onPath: (NSInteger)  pathIndex
atIndex: (NSInteger)  ptIndex 

Update point on specified path and index with point.

Parameters
pointThe point to update current point.
pathIndexThe index of the path that contains the point to be updated.
ptIndexThe index to update point at.
Since
1.0

Property Documentation

- (AGSEnvelope*) envelope
readnonatomiccopyinherited

Smallest, rectangular bounding-box that covers the geometry.

Since
1.0
- (NSInteger) numPaths
readnonatomicassigninherited

Number of paths in polyline.

Since
1.0
- (AGSSpatialReference*) spatialReference
readwritenonatomicstrong

Geometry's spatial reference.

Since
1.0