AGSEnvelope Class Reference

Description

Instances of this class represent an envelope. An envelope is defined by a pair of X-Y coordinates representing the lower-left and upper-right corners of a rectangular bounding-box.

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

Defined in:
AGSEnvelope.h ( ArcGIS library)
Since:
1.0
See also:
AGSMutableEnvelope for a mutable version.
Inheritance diagram for AGSEnvelope:
AGSGeometry <AGSCoding> AGSMutableEnvelope

List of all members.

Public Member Functions

(BOOL) - containsEnvelope:
(BOOL) - containsPoint:
(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:
(id) - initWithJSON:spatialReference:
(id) - initWithSpatialReference:
(id) - initWithXmin:ymin:xmax:ymax:spatialReference:
(AGSEnvelope *) - intersectionWithEnvelope:
(BOOL) - intersectsWithEnvelope:
(BOOL) - isEmpty
(BOOL) - isEqualToEnvelope:
(BOOL) - isValid
(NSString *) - simpleRepresentation

Static Public Member Functions

(id) + envelopeWithXmin:ymin:xmax:ymax:spatialReference:

Properties

AGSPoint * center
CGRect cgRect
AGSEnvelope * envelope
double height
CGPathRef path
AGSSpatialReference * spatialReference
double width
double xmax
double xmin
double ymax
double ymin

Protected Attributes

struct BORGEnvelope * _borg

Member Function Documentation

- (BOOL) containsEnvelope: (AGSEnvelope *)  env  

Returns true if envelope fully contains the argument env. Both envelopes must have the same spatial reference.

Parameters:
env The envelope to test containment.
Returns:
true if envelope is contained.
Since:
1.0
- (BOOL) containsPoint: (AGSPoint *)  point  

Returns true if argument point is contained within or intersects the envelope. The point and the envelope must have the same spatial reference.

Parameters:
point The point to test containment.
Returns:
true if point is contained within envelope.
Since:
1.0
- (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) envelopeWithXmin: (double)  xmin
ymin: (double)  ymin
xmax: (double)  xmax
ymax: (double)  ymax
spatialReference: (AGSSpatialReference *)  spatialReference 

Initialize an autoreleased envelope object.

Parameters:
xmin The bottom-left x-coordinate in map units.
ymin The bottom-left y-coordinate in map units.
xmax The top-right x-coordinate in map units.
ymax The top-right y-coordinate in map units.
spatialReference The spatial reference of envelope.
Returns:
A new, autoreleased, envelope object.
Since:
1.0
See also:
- initWithXmin:ymin:xmax:ymax:spatialReference:
- (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) initWithXmin: (double)  xmin
ymin: (double)  ymin
xmax: (double)  xmax
ymax: (double)  ymax
spatialReference: (AGSSpatialReference *)  spatialReference 

Initialize a new envelope object.

Parameters:
xmin The bottom-left x-coordinate in map units.
ymin The bottom-left y-coordinate in map units.
xmax The top-right x-coordinate in map units.
ymax The top-right y-coordinate in map units.
spatialReference The spatial reference of envelope.
Returns:
A new envelope object.
Since:
1.0
- (AGSEnvelope *) intersectionWithEnvelope: (AGSEnvelope *)  envelope  

Returns the intersection between this envelope and the argument envelope. Both envelopes must have the same spatial reference.

Parameters:
envelope The envelope to test intersection relation.
Returns:
Intersecting envelope else nil.
Since:
1.0
- (BOOL) intersectsWithEnvelope: (AGSEnvelope *)  envelope  

Returns true if argument envelope intersects this envelope. Both envelopes must have the same spatial reference.

Parameters:
envelope The envelope to test intersection relation.
Returns:
true if envelopes intersects.
Since:
1.0

Reimplemented from AGSGeometry.

- (BOOL) isEmpty  

Returns true if envelope width and height are 0.

Since:
1.0

Reimplemented from AGSGeometry.

- (BOOL) isEqualToEnvelope: (AGSEnvelope*)  other  

Returns whether another envelope is equal to this envelope.

Parameters:
other The other envelope.
Returns:
Whether the other envelope is equal to this envelope.
Since:
1.8
- (BOOL) isValid  

Returns whether or not the geometry is valid.

Since:
1.8
- (NSString *) simpleRepresentation  

Simple string representation of envelope.

Returns:
Simple representation.
Since:
1.0

Property Documentation

- (AGSPoint*) center [read, retain]

Center point of envelope.

Since:
1.0
- (AGSEnvelope*) envelope [read, retain, inherited]

Smallest, rectangular bounding-box that covers the geometry.

Since:
1.0
- (double) height [read, write, assign]

Height of the envelope.

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

Geometry's spatial reference.

Since:
1.0

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

- (double) width [read, write, assign]

Width of the envelope.

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

X-coordinate of upper-right corner.

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

X-coordinate of lower-left corner.

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

Y-cooridnate of upper-right corner.

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

Y-coordinate of lower-left corner.

Since:
1.0
Copyright © 1995-2010 Esri. All rights reserved.