AGSMutablePoint Class Reference


Description

A mutable version of AGSPoint.

Defined in:
AGSPoint.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSMutablePoint:
AGSPoint AGSGeometry <AGSCoding>

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
(void) - normalize
(void) - normalizeToEnvelope:
(void) - offsetByX:y:
(void) - updateWithX:y:

Static Public Member Functions

(id) + pointWithX:y:spatialReference:

Properties

CGPoint cgPoint
AGSEnvelopeenvelope
AGSSpatialReferencespatialReference
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
- (void) normalize  
Since:
1.8
- (void) normalizeToEnvelope: (AGSEnvelope*)  env  
Since:
1.8
- (void) offsetByX: (double)  xOffset
y: (double)  yOffset 

Offset current coordinates by argument x and y values.

Parameters:
xOffset The offset along x coordinate.
yOffset The offset along y coordinate.
Since:
1.0
+ (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
- (void) updateWithX: (double)  x
y: (double)  y 

Update current coordinates with x and y.

Parameters:
x The x coordinate in map units.
y The y coordinate in map units.
Since:
1.0

Property Documentation

- (CGPoint) cgPoint [read, assign, inherited]

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

Since:
1.0
- (AGSSpatialReference*) spatialReference [read, write, retain]

Geometry's spatial reference.

Since:
1.0

Reimplemented from AGSGeometry.

- (double) x [read, assign, inherited]

X coordinate for point in map units.

Since:
1.0
- (double) y [read, assign, inherited]

Y coordinate for point in map units.

Since:
1.0