AGSPoint Class Reference

---

Description

Instances of this class represent a point. The point is defined by a pair of x and y coordinates, and an optional spatial reference.

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

Defined in:

AGSPoint.h ( ArcGIS library)

Since:

1.0

See also:

AGSMutablePoint for a mutable version.

Inheritance diagram for AGSPoint:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(double)	- distanceToPoint:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
(id)	- initWithJSON:spatialReference:
(id)	- initWithSpatialReference:
(id)	- initWithX:y:spatialReference:
(BOOL)	- intersectsWithEnvelope:
(BOOL)	- isEmpty
(BOOL)	- isEqualToPoint:
(BOOL)	- isValid
Static Public Member Functions
(id)	+ pointWithX:y:spatialReference:
Properties
CGPoint	cgPoint
AGSEnvelope *	envelope
AGSSpatialReference *	spatialReference
double	x
double	y

---

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

- (double) distanceToPoint:

(AGSPoint*)

other

Calculates the distance between this point and another point.

Parameters:

other

The other point to get the distance to.

Returns:

The distance between the points, in the units of the spatial reference of the points.

- (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

- (id) initWithX:		(double)	x
y:		(double)	y
spatialReference:		(AGSSpatialReference *)	spatialReference

Initialize a new point geometry.

Parameters:

	x	The x coordinate in map units.
	y	The y coordinate in map units.
	spatialReference	The coordinates' spatial reference.

Returns:

A new point 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) isEqualToPoint:

(AGSPoint*)

other

Returns whether or not the other point is equal to this point.

Parameters:

other

The other point to compare.

Returns:

Whether or not the two points are equal.

Since:

1.8

- (BOOL) isValid

Returns whether or not the geometry is valid.

Since:

1.8

+ (id) pointWithX:		(double)	x
y:		(double)	y
spatialReference:		(AGSSpatialReference *)	spatialReference

Initialize a new autoreleased point geometry.

Parameters:

	x	The x coordinate in map units.
	y	The y coordinate in map units.
	spatialReference	The coordinates' spatial reference.

Returns:

A new, autoreleased, point geometry object.

Since:

1.0

---

Property Documentation

- (CGPoint) cgPoint [read, assign]

CGPoint representation of this point made by calling CGPointMake(self.x, self.y).

Since:

1.0

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

Geometry's spatial reference.

Since:

1.0

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

- (double) x [read, assign]

X coordinate for point in map units.

Since:

1.0

- (double) y [read, assign]

Y coordinate for point in map units.

Since:

1.0