AGSPoint.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */

#import <ArcGIS/AGSGeometry.h>
#import <ArcGIS/AGSDefines.h>
#import <CoreLocation/CLLocation.h>

@class AGSSpatialReference;
@class AGSPointBuilder;



@interface AGSPoint : AGSGeometry

#pragma mark -
#pragma mark initializers



-(instancetype)initWithX:(double)x y:(double)y spatialReference:(nullable AGSSpatialReference*)spatialReference;

-(instancetype)initWithX:(double)x y:(double)y z:(double)z spatialReference:(nullable AGSSpatialReference*)spatialReference;

-(instancetype)initWithX:(double)x y:(double)y m:(double)m spatialReference:(nullable AGSSpatialReference*)spatialReference;

-(instancetype)initWithX:(double)x y:(double)y z:(double)z m:(double)m spatialReference:(nullable AGSSpatialReference*)spatialReference;

-(instancetype)initWithCLLocationCoordinate2D:(CLLocationCoordinate2D)locationCoordinate;

+(instancetype)pointWithX:(double)x y:(double)y spatialReference:(nullable AGSSpatialReference*)spatialReference;

+(instancetype)pointWithX:(double)x y:(double)y z:(double)z spatialReference:(nullable AGSSpatialReference*)spatialReference;

+(instancetype)pointWithX:(double)x y:(double)y m:(double)m spatialReference:(nullable AGSSpatialReference*)spatialReference;

+(instancetype)pointWithX:(double)x y:(double)y z:(double)z m:(double)m spatialReference:(nullable AGSSpatialReference*)spatialReference;

+(instancetype)pointWithCLLocationCoordinate2D:(CLLocationCoordinate2D)locationCoordinate;

#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) double x;

@property (nonatomic, assign, readonly) double y;

@property (nonatomic, assign, readonly) double m;

@property (nonatomic, assign, readonly) double z;

#pragma mark -
#pragma mark methods

-(AGSPointBuilder*)toBuilder;

-(BOOL)isEqualToGeometry:(AGSPoint*)other;

-(CLLocationCoordinate2D)toCLLocationCoordinate2D;

@end


//
// The following are C-style factory methods
// Usage:
//    AGSPoint *p = AGSPointMake(-117.123, 34.123, [AGSSpatialReference spatialReferenceWithWKID:4326]);
//    AGSPoint *p = AGSPointMake3D(1.123e6, 234e6, 789, 987, [AGSSpatialReference webMercator]);
//    AGSPoint *p = AGSPointMakeWGS84(34.123, -117.123);
//    AGSPoint *p = AGSPointMakeWebMercator(1.123e6, 234e6);

AGS_EXTERN AGSPoint* AGSPointMake(double x, double y, AGSSpatialReference *__nullable spatialReference);
AGS_EXTERN AGSPoint* AGSPointMake3D(double x, double y, double z, double m, AGSSpatialReference *__nullable spatialReference);
AGS_EXTERN AGSPoint* AGSPointMakeWGS84(double latitude, double longitude);
AGS_EXTERN AGSPoint* AGSPointMakeWebMercator(double x, double y);