ArcGIS Runtime SDK for iOS
100.15
|
A geometry that represents a rectangular shape.
An AGSEnvelope
is an axis-aligned box described by the coordinates of the lower left corner and the coordinates of the upper right corner. They are commonly used to represent the spatial extent covered by layers or other geometries, or to define an area of interest. They can be used as the geometry for a graphic and as an input for many spatial operations. Although they both represent a geographic area, an AGSEnvelope
is distinct from an AGSPolygon
, and they cannot always be used interchangeably.
New instances of AGSEnvelope
are defined by specifying a minimum and maximum x-coordinate and minimum and maximum y-coordinate, and an AGSSpatialReference
. Optionally, a minimum and maximum z-value can be specified to define the depth of the envelope.
AGSGeometry
toBuilder (AGSEnvelope):
to get an envelope builder using a copy of this geometry as a starting off point. The builder can then be modified to produce a new geometry.AGSEnvelopeBuilder
to construct or modify envelopes programmatically. AGSSketchEditor
to construct or modify geometries interactively by sketching on a map. AGSGeometryEngine
to perform operations on geometries. Instance Methods | |
(instancetype) | - initWithCenter:width:height: |
(instancetype) | - initWithCenter:width:height:depth: |
(instancetype) | - initWithMin:max: |
(instancetype) | - initWithXMin:yMin:mMin:xMax:yMax:mMax:spatialReference: |
(instancetype) | - initWithXMin:yMin:xMax:yMax:spatialReference: |
(instancetype) | - initWithXMin:yMin:zMin:mMin:xMax:yMax:zMax:mMax:spatialReference: |
(instancetype) | - initWithXMin:yMin:zMin:xMax:yMax:zMax:spatialReference: |
(BOOL) | - isEqualToGeometry: |
(BOOL) | - isEqualToGeometry: |
(BOOL) | - isEqualToGeometry:tolerance: |
(AGSEnvelopeBuilder *) | - toBuilder |
(nullable id) | - toJSON: |
Class Methods | |
(instancetype) | + envelopeWithCenter:width:height: |
(instancetype) | + envelopeWithCenter:width:height:depth: |
(instancetype) | + envelopeWithMin:max: |
(instancetype) | + envelopeWithXMin:yMin:mMin:xMax:yMax:mMax:spatialReference: |
(instancetype) | + envelopeWithXMin:yMin:xMax:yMax:spatialReference: |
(instancetype) | + envelopeWithXMin:yMin:zMin:mMin:xMax:yMax:zMax:mMax:spatialReference: |
(instancetype) | + envelopeWithXMin:yMin:zMin:xMax:yMax:zMax:spatialReference: |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
AGSPoint * | center |
double | depth |
AGSGeometryDimension | dimension |
BOOL | empty |
AGSEnvelope * | extent |
AGSGeometryType | geometryType |
BOOL | hasCurves |
BOOL | hasM |
BOOL | hasZ |
double | height |
double | mMax |
double | mMin |
AGSSpatialReference * | spatialReference |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
double | width |
double | xMax |
double | xMin |
double | yMax |
double | yMin |
double | zMax |
double | zMin |
+ (instancetype) envelopeWithCenter: | (AGSPoint *) | center | |
width: | (double) | width | |
height: | (double) | height | |
+ (instancetype) envelopeWithCenter: | (AGSPoint *) | center | |
width: | (double) | width | |
height: | (double) | height | |
depth: | (double) | depth | |
Initializes an envelope geometry with the provided min and max points.
min | The min coordinate along x-axis (lower left corner) |
max | The min coordinate along y-axis (lower left corner) |
toBuilder:
to get a builder to further modify the geometry. + (instancetype) envelopeWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
mMin: | (double) | mMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
mMax: | (double) | mMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
mMin | The min measure value |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
mMax | The max measure value |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. + (instancetype) envelopeWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. + (instancetype) envelopeWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
zMin: | (double) | zMin | |
mMin: | (double) | mMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
zMax: | (double) | zMax | |
mMax: | (double) | mMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
zMin | The min coordinate along z-axis |
mMin | The min measure value |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
zMax | The max coordinate along z-axis |
mMax | The max measure value |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. + (instancetype) envelopeWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
zMin: | (double) | zMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
zMax: | (double) | zMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
zMin | The min coordinate along z-axis |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
zMax | The max coordinate along z-axis |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry.
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
- (instancetype) initWithCenter: | (AGSPoint *) | center | |
width: | (double) | width | |
height: | (double) | height | |
Initializes an envelope geometry with the provided center and dimensions.
center | The coorinates of the envelope's center |
width | of the envelope (in units specified by the center's spatial reference) |
height | of the envelope (in units specified by the center's spatial reference) |
toBuilder:
to get a builder to further modify the geometry. - (instancetype) initWithCenter: | (AGSPoint *) | center | |
width: | (double) | width | |
height: | (double) | height | |
depth: | (double) | depth | |
Initializes an envelope geometry with the provided center and dimensions.
center | The coorinates of the envelope's center |
width | of the envelope (in units specified by the center's spatial reference) |
height | of the envelope (in units specified by the center's spatial reference) |
depth | of the envelope (in meters) |
toBuilder:
to get a builder to further modify the geometry. Initializes an envelope geometry with the provided min and max points.
The spatial reference of both input points must match and will be the spatial reference of the resulting envelope. The min and max points can be any opposing corners of the envelope and the resulting envelope will always have min less than or equal to max.
min | The min corner of the envelope |
max | The max corner of the envelope |
toBuilder:
to get a builder to further modify the geometry. - (instancetype) initWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
mMin: | (double) | mMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
mMax: | (double) | mMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
mMin | The min measure value |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
mMax | The max measure value |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. - (instancetype) initWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. - (instancetype) initWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
zMin: | (double) | zMin | |
mMin: | (double) | mMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
zMax: | (double) | zMax | |
mMax: | (double) | mMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
zMin | The min coordinate along z-axis |
mMin | The min measure value |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
zMax | The max coordinate along z-axis |
mMax | The max measure value |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. - (instancetype) initWithXMin: | (double) | xMin | |
yMin: | (double) | yMin | |
zMin: | (double) | zMin | |
xMax: | (double) | xMax | |
yMax: | (double) | yMax | |
zMax: | (double) | zMax | |
spatialReference: | (nullable AGSSpatialReference *) | spatialReference | |
Initializes an envelope geometry with the provided coordinate values.
xMin | The min coordinate along x-axis (lower left corner) |
yMin | The min coordinate along y-axis (lower left corner) |
zMin | The min coordinate along z-axis |
xMax | The max coordinate along x-axis (upper right corner) |
yMax | The max coordinate along y-axis (upper right corner) |
zMax | The max coordinate along z-axis |
spatialReference | The coordinate system that the coordinate values use. |
toBuilder:
to get a builder to further modify the geometry. - (BOOL) isEqualToGeometry: | (AGSEnvelope *) | other |
Compares whether two envelope geometries are equal.
other | envelope to compare this envelope to |
- (BOOL) isEqualToGeometry: | (AGSGeometry *) | other |
Compares whether two geometries are equal.
other | The other geometry object to compare this geometry object to. |
YES
if the geometries are equal. - (BOOL) isEqualToGeometry: | (AGSGeometry *) | other | |
tolerance: | (double) | tolerance | |
Compares two geometry objects for equality to within some tolerance.
other | The other geometry object to compare this geometry object to. |
tolerance | The tolerance. |
YES
if the geometries are equal within the given tolerance, otherwise NO
. - (AGSEnvelopeBuilder*) toBuilder |
Returns a builder using a copy of this geometry as a starting off point. The builder can then be modified to produce a new geometry.
Implements AGSGeometry.
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
readnonatomicstrong |
The geographic center of the envelope.
|
readnonatomicassign |
|
readnonatomicassigninherited |
The dimension of this geometry object.
AGSGeometryDimension::AGSGeometryDimensionUnknown
if an error occurs.
|
readnonatomicassigninherited |
Indicates whether this geometry has any vertices.
|
readnonatomicstronginherited |
Smallest, rectangular bounding-box that covers the geometry.
|
readnonatomicassigninherited |
The type of this geometry.
|
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
.
AGSGeometryBuilder::hasCurves
, AGSPart::hasCurves
, AGSSegment::curve
, AGSCubicBezierSegment
, AGSEllipticArcSegment
|
readnonatomicassigninherited |
Indicates whether this geometry contains m (measure) values.
|
readnonatomicassigninherited |
Indicates whether this geometry contains z coordinate values. Only 3D geometries contain z values.
|
readnonatomicassign |
The height of the envelope (along y-axis)
|
readnonatomicassign |
The max measure value.
AGSGeometry::hasM
to check if the geometry has measure values.
|
readnonatomicassign |
The min measure value.
AGSGeometry::hasM
to check if the geometry has measure values.
|
readnonatomicstronginherited |
The spatial reference associated with the gometry. It specifies the coordinate system for the geometry's x, y, and z coordinate values.
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.
|
readnonatomicassign |
The width of the envelope (along x-axis).
|
readnonatomicassign |
The max coordinate along x-axis (upper right corner)
|
readnonatomicassign |
The min coordinate along x-axis (lower left corner)
|
readnonatomicassign |
The max coordinate along y-axis (upper right corner)
|
readnonatomicassign |
The min coordinate along y-axis (lower left corner)
|
readnonatomicassign |
The max coordinate along z-axis. Only applicable for 3D envelope geometries.
AGSGeometry::hasZ
to check if the geometry has z-values.
|
readnonatomicassign |
The min coordinate along z-axis. Only applicable for 3D envelope geometries.
AGSGeometry::hasZ
to check if the geometry has z-values.