AGSMultipart Class Reference

Description

Defines common members for polyline and polygon multipart geometries.

Multipart geometries are based upon the parent AGSGeometry class. The geometry class is immutable which means that you cannot change its shape once it is created. If you need to modify a multipart once it has been created, use the AGSMultipartBuilder class instead. The toGeometry (AGSGeometryBuilder) method will provide you with the base geometry object.

A multipart geometry is comprised of a collection of shapes (of the same type) that is managed as a single geometry. A classic example is a set of islands that represent a single country or state. The individual island shapes are distinct, but ArcGIS considers it a single geometry.

AGSPolygon and AGSPolyline inherit from AGSMultipart, which in turn inherits from AGSGeometry. AGSMultipart provides access to the geometry's AGSPartCollection via the AGSMultipart::parts property. Each AGSPart in the collection is a collection of AGSSegment objects. You can iterate through the segments or points in each part.

See also

AGSGeometry

Since

100

Inheritance diagram for AGSMultipart:

Instance Methods
(BOOL)	- isEqualToGeometry:
(BOOL)	- isEqualToGeometry:tolerance:
(AGSGeometryBuilder *)	- toBuilder
(nullable id)	- toJSON:

Class Methods
(nullable id< AGSJSONSerializable >)	+ fromJSON:error:

Properties
AGSGeometryDimension	dimension
BOOL	empty
AGSEnvelope *	extent
AGSGeometryType	geometryType
BOOL	hasCurves
BOOL	hasM
BOOL	hasZ
AGSPartCollection *	parts
AGSSpatialReference *	spatialReference
NSDictionary< NSString *, id > *	unknownJSON
NSDictionary< NSString *, id > *	unsupportedJSON

Method Documentation

fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject error: (NSError **)  error

staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters

JSONObject	NSDictionary or NSArray containing the JSON.
error	encountered during the operation, if any.

Since

100

isEqualToGeometry:

- (BOOL) isEqualToGeometry:

(AGSGeometry *)

other

Compares whether two geometries are equal.

Parameters

other

The other geometry object to compare this geometry object to.

Returns

YES if the geometries are equal.

Since

100

isEqualToGeometry:tolerance:

- (BOOL) isEqualToGeometry:		(AGSGeometry *)	other
tolerance:		(double)	tolerance

Compares two geometry objects for equality to within some tolerance.

Parameters

other	The other geometry object to compare this geometry object to.
tolerance	The tolerance.

Returns

YES if the geometries are equal within the given tolerance, otherwise NO.

Since

100

toBuilder

- (AGSGeometryBuilder*) toBuilder

Returns a builder using a copy of this geometry as a starting off point. The builder can be used to make modifications to the geometry.

Returns

A builder object.

Since

100

Note

Any changes you make using the builder modifies its own internal copy of the geometry. It does not affect this geometry.

Implemented in AGSPolyline, AGSPolygon, AGSPoint, AGSMultipoint, and AGSEnvelope.

toJSON:

- (nullable id) toJSON: (NSError **)  error

requiredinherited

Returns JSON representation for this object.

Parameters

error

encountered during the operation, if any.

Returns

NSDictionary or NSArray containing the JSON.

Since

100

Reimplemented in AGSPortalItem.

Property Documentation

dimension

- (AGSGeometryDimension) dimension

readnonatomicassigninherited

The dimension of this geometry object.

Note

The property will be AGSGeometryDimension::AGSGeometryDimensionUnknown if an error occurs.

Since

100

empty

- (BOOL) empty

readnonatomicassigninherited

Indicates whether this geometry has any vertices.

Since

100

extent

- (AGSEnvelope*) extent

readnonatomicstronginherited

Smallest, rectangular bounding-box that covers the geometry.

Since

100

geometryType

- (AGSGeometryType) geometryType

readnonatomicassigninherited

The type of this geometry.

Since

100

hasCurves

- (BOOL) hasCurves

readnonatomicassigninherited

YES if this geometry contains curve segments, NO otherwise.

The ArcGIS Platform supports polygon and polyline geometries that contain curve segments (where AGSSegment::curve is YES, sometimes known as true curves or nonlinear segments). Curves may be present in certain types of data - for example Mobile Map Packages (MMPK) or geometry JSON. When connecting to ArcGIS feature services that support curves (AGSArcGISFeatureServiceInfo::supportsTrueCurve), ArcGIS Runtime retrieves densified versions of curve feature geometries by default.

If a polygon or polyline geometry contains curve segments, this property is YES. Prior to v100.12, it was not possible to access curve segments, and only AGSLineSegment instances would be returned when iterating through the segments in an AGSPolygon or AGSPolyline object, irrespective of this property.

From v100.12, you can use curve segments when using an AGSMultipartBuilder to create or edit polygon and polyline geometries, and also get curve segments when iterating through the segments of existing AGSMultipart geometries when this property returns YES. You can also choose to return true curves from feature services by using AGSArcGISRuntimeEnvironment::serviceCurveGeometryMode.

See also

AGSGeometryBuilder::hasCurves, AGSPart::hasCurves, AGSSegment::curve, AGSCubicBezierSegment, AGSEllipticArcSegment

Since

100

hasM

- (BOOL) hasM

readnonatomicassigninherited

Indicates whether this geometry contains m (measure) values.

Since

100

hasZ

- (BOOL) hasZ

readnonatomicassigninherited

Indicates whether this geometry contains z coordinate values. Only 3D geometries contain z values.

Since

100

parts

- (AGSPartCollection*) parts

readnonatomicstrong

The parts of this geometry.

Can be iterated through a for-in loop.

AGSPolygon* polygon = ... ; //polygon with 2 parts (rings)
for (AGSPart* part in polygon.parts) {
  ...
}

Since

100

spatialReference

- (AGSSpatialReference*) spatialReference

readnonatomicstronginherited

The spatial reference associated with the 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.

unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON

readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns

NSDictionary containing the unknown JSON.

Since

100

unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON

readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns

NSDictionary containing the unsupported JSON.

Since

100