AGSMultipoint Class Reference

---

Description

Instances of this class represent a multipoint. A multipoint is defined by ordered collection of points, and an optional spatial reference.

AGSMultipoint represents an immutable multipoint, it cannot be altered after being created. Use AGSMutablePoint for a mutable multipoint. You can get a mutable version from AGSMultipoint by passing the mutableCopy message to an instance.

Defined in:

AGSMultipoint.h ( ArcGIS library)

Since:

1.0

See also:

AGSMutableMultipoint for a mutable version.

Inheritance diagram for AGSMultipoint:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
(id)	- initWithJSON:spatialReference:
(id)	- initWithSpatialReference:
(BOOL)	- intersectsWithEnvelope:
(BOOL)	- isEmpty
(BOOL)	- isEqualToMultipoint:
(BOOL)	- isValid
(AGSPoint *)	- pointAtIndex:
Properties
AGSEnvelope *	envelope
NSUInteger	numPoints
AGSSpatialReference *	spatialReference
Protected Attributes
struct BORGMultiPoint *	_borg

---

Member Function Documentation

- (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 AGSGeometry with.
	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

- (BOOL) intersectsWithEnvelope:

(AGSEnvelope *)

envelope

Returns true if envelope intersects this geometry.

Parameters:

envelope

The envelope to test intersection relation.

Returns:

True if envelopes intersects.

Since:

1.0

Reimplemented in AGSEnvelope.

- (BOOL) isEmpty

Returns whether or not the geometry is empty.

Since:

1.8

Reimplemented in AGSEnvelope.

- (BOOL) isEqualToMultipoint:

(AGSMultipoint*)

other

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

Parameters:

other

The other multipoint to compare to.

Returns:

Whether or not the other multipoint is equal to this multipoint.

Since:

1.8

- (BOOL) isValid

Returns whether or not the geometry is valid.

Since:

1.8

- (AGSPoint *) pointAtIndex:

(NSUInteger)

index

Return point from collection at index.

Parameters:

index

The index of a point in collection.

Returns:

Point in collection.

Since:

1.0

---

Property Documentation

- (NSUInteger) numPoints [read, assign]

Number of points in collection.

Since:

1.0

- (AGSSpatialReference*) spatialReference [read, retain, inherited]

Geometry's spatial reference.

Since:

1.0

Reimplemented in AGSMutableEnvelope, AGSMutableMultipoint, AGSMutablePoint, AGSMutablePolygon, and AGSMutablePolyline.