ArcGIS Runtime SDK for iOS: AGSPolylineBuilder Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSPolylineBuilder Class Reference

Description

A builder to build polyline geometries.

Instances of this class represent a builder that can build polyline geometries. Polyline geometries are immutable, they cannot be modified after they are created. Use builders to create new geometries either from scratch, or by using an existing geometry as a starting off point. Modifications made through the builder affect only its own internal copy of the geometry. They do not affect the original geometry.

Since
100
See also
AGSSketchEditor to construct or modify geometries interactively by sketching on a map
Inheritance diagram for AGSPolylineBuilder:
AGSMultipartBuilder AGSGeometryBuilder AGSObject

Instance Methods

(instancetype) - addPartWithPoints:
 
(instancetype) - addPoint:
 
(instancetype) - addPoints:toPartAtIndex:
 
(instancetype) - addPointWithX:y:
 
(instancetype) - addPointWithX:y:z:
 
(instancetype) - initWithPoints:
 
(instancetype) - initWithPolyline:
 
(instancetype) - initWithSpatialReference:
 
(BOOL) - isEmpty
 
(instancetype) - replaceGeometry:
 
(instancetype) - replaceGeometry:
 
(AGSPolyline *) - toGeometry
 

Class Methods

(AGSGeometryBuilder *) + builderWithGeometry:
 
(AGSGeometryBuilder *) + builderWithGeometryType:spatialReference:
 
(instancetype) + polylineBuilderWithPoints:
 
(instancetype) + polylineBuilderWithPolyline:
 
(instancetype) + polylineBuilderWithSpatialReference:
 

Properties

AGSEnvelopeextent
 
AGSGeometryType geometryType
 
BOOL hasCurves
 
BOOL hasM
 
BOOL hasZ
 
AGSMutablePartCollectionparts
 
AGSSpatialReferencespatialReference
 

Method Documentation

◆ addPartWithPoints:

- (instancetype) addPartWithPoints: (NSArray< AGSPoint * > *)  points

Add new part with given points to the builder's multipart geometry.

Returns
The builder so you can easily chain method calls.
Since
100

◆ addPoint:

- (instancetype) addPoint: (AGSPoint *)  point

Appends a vertex to the builder's multipart geometry.

Returns
The builder so you can easily chain method calls.
Since
100

◆ addPoints:toPartAtIndex:

- (instancetype) addPoints: (NSArray< AGSPoint * > *)  points
toPartAtIndex: (NSInteger)  partIndex 

Add points to the builder's multipart geometry at given part index.

Returns
The builder so you can easily chain method calls.
Since
100

◆ addPointWithX:y:

- (instancetype) addPointWithX: (double)  x
y: (double)  y 

Appends a vertex to the builder's multipart geometry.

Returns
The builder so you can easily chain method calls.
Since
100

◆ addPointWithX:y:z:

- (instancetype) addPointWithX: (double)  x
y: (double)  y
z: (double)  z 

Appends a vertex to the builder's multipart geometry.

Returns
The builder so you can easily chain method calls.
Since
100

◆ builderWithGeometry:

+ (AGSGeometryBuilder*) builderWithGeometry: (nullable AGSGeometry *)  geometry

Factory method to create a geometry builder from a geometry.

Parameters
geometryThe geometry to be used as the starting point for further modifications.
Since
100
See also
AGSGeometryBuilder::hasCurves

◆ builderWithGeometryType:spatialReference:

+ (AGSGeometryBuilder*) builderWithGeometryType: (AGSGeometryType geometryType
spatialReference: (nullable AGSSpatialReference *)  sr 

Factory method to create a geometry builder from a geometry type and spatial reference.

Prior to v100.12, only geometries without curves could be used. Passing in a geometry where AGSGeometry::hasCurves is YES would fail to replace the geometry.

From v100.12, geometries with curves are supported.

Parameters
geometryTypeThe type of geometry to be constructed.
srThe spatial reference for the geometry to be constructed.
Since
100
See also
AGSGeometryBuilder::hasCurves

◆ initWithPoints:

- (instancetype) initWithPoints: (NSArray< AGSPoint * > *)  points

Initializes a polyline builder.

Parameters
pointsfor the geometry to be constructed
Since
100

◆ initWithPolyline:

- (instancetype) initWithPolyline: (nullable AGSPolyline *)  polyline

Creates a polyline builder.

Prior to v100.12, only polylines without curves could be used. Passing in a polygon where AGSGeometry::hasCurves is YES would throw an exception.

From v100.12, polylines with curves are supported.

Parameters
polylineThe geometry to be used as the starting point for further modifications. Can be nil.
Since
100
See also
AGSGeometryBuilder::hasCurves

◆ initWithSpatialReference:

- (instancetype) initWithSpatialReference: (nullable AGSSpatialReference *)  sr

Initializes a builder.

Parameters
srThe spatial reference for the geometry to be constructed
Since
100

◆ isEmpty

- (BOOL) isEmpty

Indicates whether the builder's geometry is empty.

Returns
If the geometry is empty.
Since
100
See also
AGSGeometry::isEmpty

◆ polylineBuilderWithPoints:

+ (instancetype) polylineBuilderWithPoints: (NSArray< AGSPoint * > *)  points

Initializes a polyline builder.

Parameters
pointsfor the geometry to be constructed
Since
100

◆ polylineBuilderWithPolyline:

+ (instancetype) polylineBuilderWithPolyline: (nullable AGSPolyline *)  polyline

Creates a polyline builder.

Prior to v100.12, only polylines without curves could be used; passing in a polygon where AGSGeometry::hasCurves is YES would throw an exception.

From v100.12, polylines with curves are supported.

Parameters
polylineThe geometry to be used as the starting point for further modifications. Can be nil.
Since
100
See also
AGSGeometryBuilder::hasCurves

◆ polylineBuilderWithSpatialReference:

+ (instancetype) polylineBuilderWithSpatialReference: (nullable AGSSpatialReference *)  sr

Initializes a builder.

Parameters
srThe spatial reference for the geometry to be constructed
Since
100

◆ replaceGeometry: [1/2]

- (instancetype) replaceGeometry: (nullable AGSGeometry *)  geometry

Replaces the builder's geometry with the provided one.

This does not update the spatial reference of the builder. If the geometry is nil, the builder is cleared.

Prior to v100.12, only geometries without curves could be used. Passing in a geometry where AGSGeometry::hasCurves is YES would fail to replace the geometry.

From v100.12, geometries with curves are supported.

Parameters
geometryThe geometry object to replace with.
Returns
The builder so you can easily chain method calls.
Since
100

◆ replaceGeometry: [2/2]

- (instancetype) replaceGeometry: (nullable AGSPolyline *)  geometry

Replaces the builder's geometry with the provided one.

Parameters
geometryto replace with
Returns
the builder so you can easily chain method calls
Since
100

◆ toGeometry

- (AGSPolyline*) toGeometry

Returns the polyline geometry this builder is constructing or modifying.

Returns
geometry
Since
100

Implements AGSGeometryBuilder.

Property Documentation

◆ extent

- (AGSEnvelope*) extent
readnonatomicstronginherited

Smallest, rectangular bounding-box that covers the builder's geometry.

Since
100
See also
AGSGeometry::extent

◆ geometryType

- (AGSGeometryType) geometryType
readnonatomicassigninherited

The type of geometry the builder will construct or modify.

Since
100

◆ hasCurves

- (BOOL) hasCurves
readnonatomicassigninherited

A value indicating whether the geometry builder currently contains any curve segments.

The ArcGIS Platform supports polygon and polyline geometries that contain curve segments (sometimes known as true curves or nonlinear segments). Curves may be present in certain types of data - for example Mobile Map Packages (MMPKs), or geometry JSON.

Prior to v100.12, only AGSLineSegment instances were supported when creating new geometries using an AGSMultipartBuilder. Attempting to add curve geometries to an AGSMultipartBuilder would cause an error.

From v100.12, you can use curves in an AGSMultipartBuilder. New segment types AGSCubicBezierSegment and AGSEllipticArcSegment represent different types of curve that can be added to polygon and polyline geometries.

See also
AGSMutablePart::hasCurves, AGSGeometry::hasCurves, AGSSegment::curve
Since
100.12

◆ hasM

- (BOOL) hasM
readnonatomicassigninherited

Indicates whether the builder's geometry contains m (measure) values.

Since
100
See also
AGSGeometry::hasM

◆ hasZ

- (BOOL) hasZ
readnonatomicassigninherited

Indicates whether the builder's geometry contains z coordinate values.

Since
100
See also
AGSGeometry::hasZ

◆ parts

- (AGSMutablePartCollection*) parts
readwritenonatomicstronginherited

The parts of the builder's geometry. Can be iterated through a for-in loop.

AGSPolygonBuilder* polygonBuilder = ... ; //builder whose polygon contains 2 parts (rings)
for (AGSMutablePart *part in polygonBuilder.parts){
...
}
AGSMutablePartCollection * parts
Definition: AGSMultipartBuilder.h:62
A mutable part of a multipart geometry.
Definition: AGSMutablePart.h:67
A builder to build polygon geometries.
Definition: AGSPolygonBuilder.h:42
Since
100

◆ spatialReference

- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference associated with the builder's gometry. It specifies the coordinate system for the geometry's x, y, and z coordinate values.

Since
100
Note
Geometries that represent geographic locations should always have a spatial reference. Otherwise the coordinates of the geometry are meaningless.
See also
AGSGeometry::spatialReference