ArcGIS Runtime SDK for iOS: AGSEnvelope.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSEnvelope.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSGeometry.h>
27 
28 @class AGSEnvelopeBuilder;
29 @class AGSPoint;
30 
55 
56 
57 #pragma mark -
58 #pragma mark initializers
59 
60 
61 
72 -(instancetype)initWithCenter:(AGSPoint *)center width:(double)width height:(double)height;
73 
85 -(instancetype)initWithCenter:(AGSPoint *)center width:(double)width height:(double)height depth:(double)depth;
86 
98 -(instancetype)initWithMin:(AGSPoint*)min max:(AGSPoint*)max;
99 
112 -(instancetype)initWithXMin:(double)xMin
113  yMin:(double)yMin
114  xMax:(double)xMax
115  yMax:(double)yMax
116  spatialReference:(nullable AGSSpatialReference *)spatialReference;
117 
132 -(instancetype)initWithXMin:(double)xMin
133  yMin:(double)yMin
134  zMin:(double)zMin
135  xMax:(double)xMax
136  yMax:(double)yMax
137  zMax:(double)zMax
138  spatialReference:(nullable AGSSpatialReference *)spatialReference;
139 
154 -(instancetype)initWithXMin:(double)xMin
155  yMin:(double)yMin
156  mMin:(double)mMin
157  xMax:(double)xMax
158  yMax:(double)yMax
159  mMax:(double)mMax
160  spatialReference:(nullable AGSSpatialReference *)spatialReference;
161 
178 -(instancetype)initWithXMin:(double)xMin
179  yMin:(double)yMin
180  zMin:(double)zMin
181  mMin:(double)mMin
182  xMax:(double)xMax
183  yMax:(double)yMax
184  zMax:(double)zMax
185  mMax:(double)mMax
186  spatialReference:(nullable AGSSpatialReference *)spatialReference;
187 
188 
189 +(instancetype)envelopeWithCenter:(AGSPoint *)center width:(double)width height:(double)height;
190 
191 +(instancetype)envelopeWithCenter:(AGSPoint *)center width:(double)width height:(double)height depth:(double)depth;
192 
202 +(instancetype)envelopeWithMin:(AGSPoint*)min max:(AGSPoint*)max;
203 
216 +(instancetype)envelopeWithXMin:(double)xMin
217  yMin:(double)yMin
218  xMax:(double)xMax
219  yMax:(double)yMax
220  spatialReference:(nullable AGSSpatialReference *)spatialReference;
221 
236 +(instancetype)envelopeWithXMin:(double)xMin
237  yMin:(double)yMin
238  zMin:(double)zMin
239  xMax:(double)xMax
240  yMax:(double)yMax
241  zMax:(double)zMax
242  spatialReference:(nullable AGSSpatialReference *)spatialReference;
243 
258 +(instancetype)envelopeWithXMin:(double)xMin
259  yMin:(double)yMin
260  mMin:(double)mMin
261  xMax:(double)xMax
262  yMax:(double)yMax
263  mMax:(double)mMax
264  spatialReference:(nullable AGSSpatialReference *)spatialReference;
265 
282 +(instancetype)envelopeWithXMin:(double)xMin
283  yMin:(double)yMin
284  zMin:(double)zMin
285  mMin:(double)mMin
286  xMax:(double)xMax
287  yMax:(double)yMax
288  zMax:(double)zMax
289  mMax:(double)mMax
290  spatialReference:(nullable AGSSpatialReference *)spatialReference;
291 
292 #pragma mark -
293 #pragma mark properties
294 
300 @property (nonatomic, readonly) double xMin;
301 
307 @property (nonatomic, readonly) double xMax;
308 
314 @property (nonatomic, readonly) double yMin;
315 
321 @property (nonatomic, readonly) double yMax;
322 
330 @property (nonatomic, readonly) double zMin;
331 
339 @property (nonatomic, readonly) double zMax;
340 
347 @property (nonatomic, readonly) double mMin;
348 
355 @property (nonatomic, readonly) double mMax;
356 
362 @property (nonatomic, strong, readonly) AGSPoint *center;
363 
369 @property (nonatomic, assign, readonly) double width;
370 
376 @property (nonatomic, assign, readonly) double height;
377 
378 @property (nonatomic, assign, readonly) double depth;
379 
380 
381 #pragma mark -
382 #pragma mark methods
383 
393 
401 -(BOOL)isEqualToGeometry:(AGSEnvelope*)other;
402 
403 
404 @end
405 
The envelope builder object is used to create an envelope.
Definition: AGSEnvelopeBuilder.h:43
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
double mMax
Definition: AGSEnvelope.h:355
double depth
Definition: AGSEnvelope.h:378
double width
Definition: AGSEnvelope.h:369
double zMin
Definition: AGSEnvelope.h:330
double mMin
Definition: AGSEnvelope.h:347
AGSPoint * center
Definition: AGSEnvelope.h:362
double xMax
Definition: AGSEnvelope.h:307
double zMax
Definition: AGSEnvelope.h:339
double yMax
Definition: AGSEnvelope.h:321
double height
Definition: AGSEnvelope.h:376
AGSEnvelopeBuilder * toBuilder()
double xMin
Definition: AGSEnvelope.h:300
double yMin
Definition: AGSEnvelope.h:314
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:49