AGSGeometryEngine.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/AGSObject.h>

@class AGSSpatialReference;
@class AGSGeometry;
@class AGSPolygon;
@class AGSEnvelope;
@class AGSPolyline;
@class AGSPoint;
@class AGSProximityResult;
@class AGSUnit;
@class AGSAreaUnit;
@class AGSLinearUnit;
@class AGSAngularUnit;
@class AGSGeodesicEllipseParameters;
@class AGSGeodeticDistanceResult;
@class AGSMutablePointCollection;
@class AGSGeodesicSectorParameters;
@class AGSMultipart;
@class AGSDatumTransformation;

typedef NS_ENUM(NSInteger, AGSGeometryOffsetType) {
    AGSGeometryOffsetTypeMitered = 0,       
    AGSGeometryOffsetTypeBevelled = 1,      
    AGSGeometryOffsetTypeRounded = 2,       
    AGSGeometryOffsetTypeSquared = 3        
};

typedef NS_ENUM(NSInteger, AGSGeodeticCurveType) {
    AGSGeodeticCurveTypeGeodesic = 0,       
    AGSGeodeticCurveTypeLoxodrome,          
    AGSGeodeticCurveTypeGreatElliptic,      
    AGSGeodeticCurveTypeNormalSection,      
    AGSGeodeticCurveTypeShapePreserving     
};

typedef NS_OPTIONS(NSInteger, AGSGeometryExtendOption) {
    AGSGeometryExtendOptionDefault = 0,                             
    AGSGeometryExtendOptionRelocateEnds = 1 << 0,                   
    AGSGeometryExtendOptionKeepEndAttributes = 1 << 1,              
    AGSGeometryExtendOptionNoEndAttributes = 1 << 2,                
    AGSGeometryExtendOptionDoNotExtendFromStartPoint = 1 << 3,      
    AGSGeometryExtendOptionDoNotExtendFromEndPoint = 1 << 4         
};
 //Required for Globals API doc

@interface AGSGeometryEngine : AGSObject


#pragma mark - Geodetic/Geodesic Operators

+ (double)geodeticAreaOfGeometry:(AGSGeometry*)geometry areaUnit:(AGSAreaUnit*)areaUnit curveType:(AGSGeodeticCurveType)curveType;

+ (nullable AGSPolygon*)geodeticBufferGeometry:(AGSGeometry*)geometry distance:(double)distance distanceUnit:(AGSLinearUnit*)distanceUnit maxDeviation:(double)maxDeviation curveType:(AGSGeodeticCurveType)curveType;

+ (nullable NSArray<AGSGeometry*>*)geodeticBufferGeometries:(NSArray<AGSGeometry*>*)geometries distances:(NSArray<NSNumber*>*)distances distanceUnit:(AGSLinearUnit*)distanceUnit maxDeviation:(double)maxDeviation curveType:(AGSGeodeticCurveType)curveType unionResults:(BOOL)unionResults;

+ (nullable AGSGeometry*)geodeticDensifyGeometry:(AGSGeometry*)geometry maxSegmentLength:(double)maxSegmentLength lengthUnit:(AGSLinearUnit*)lengthUnit curveType:(AGSGeodeticCurveType)curveType;

+ (nullable AGSGeodeticDistanceResult*)geodeticDistanceBetweenPoint1:(AGSPoint*)point1 point2:(AGSPoint*)point2 distanceUnit:(AGSLinearUnit*)distanceUnit azimuthUnit:(AGSAngularUnit*)azimuthUnit curveType:(AGSGeodeticCurveType)curveType;

+ (nullable AGSGeometry*)geodesicEllipseWithParameters:(AGSGeodesicEllipseParameters*)params;

+ (double)geodeticLengthOfGeometry:(AGSGeometry*)geometry lengthUnit:(AGSLinearUnit*)lengthUnit curveType:(AGSGeodeticCurveType)curveType;

+ (nullable NSArray<AGSPoint*>*)geodeticMovePoints:(NSArray<AGSPoint*>*)points distance:(double)distance distanceUnit:(AGSLinearUnit*)distanceUnit azimuth:(double)azimuth azimuthUnit:(AGSAngularUnit*)azimuthUnit curveType:(AGSGeodeticCurveType)curveType;

+ (nullable AGSGeometry*)geodesicSectorWithParameters:(AGSGeodesicSectorParameters*)params;


#pragma mark - Topological Query Operators

+ (BOOL)geometry:(AGSGeometry*)geometry1 containsGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometry:(AGSGeometry*)geometry1 crossesGeometry:(AGSGeometry*)geometry2;

+ (nullable NSArray<AGSGeometry *> *)cutGeometry:(AGSGeometry*)geometry withCutter:(AGSPolyline*)cutter;

+ (BOOL)geometry:(AGSGeometry*)geometry1 disjointToGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometry:(AGSGeometry*)geometry1 equalsGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometry:(AGSGeometry*)geometry1 intersectsGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometryIsSimple:(AGSGeometry*)geometry;

+ (BOOL)geometry:(AGSGeometry*)geometry1 overlapsGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometry:(AGSGeometry*)geometry1 relatesToGeometry:(AGSGeometry*)geometry2 byRelation:(NSString*)relation;

+ (BOOL)geometry:(AGSGeometry*)geometry1 touchesGeometry:(AGSGeometry*)geometry2;

+ (BOOL)geometry:(AGSGeometry*)geometry1 withinGeometry:(AGSGeometry*)geometry2;


#pragma mark - Topological Analysis Operators

+ (double)areaOfGeometry:(AGSGeometry*)geometry;

+ (nullable AGSGeometry*)boundaryOfGeometry:(AGSGeometry*)geometry;

+ (nullable AGSPolygon*)bufferGeometry:(AGSGeometry*)geometry byDistance:(double)distance;

+ (nullable NSArray<AGSGeometry*>*)bufferGeometries:(NSArray<AGSGeometry*>*)geometries distances:(NSArray<NSNumber*>*)distances unionResults:(BOOL)unionResults;

+ (nullable AGSGeometry*)clipGeometry:(AGSGeometry*)geometry withEnvelope:(AGSEnvelope*)envelope;

+ (nullable AGSEnvelope*)combineExtentsOfGeometry:(AGSGeometry*)geometry1 andGeometry:(AGSGeometry*)geometry2;

+ (nullable AGSEnvelope*)combineExtentsOfGeometries:(NSArray<AGSGeometry*>*)geometries;

+ (nullable AGSGeometry*)convexHullForGeometry:(AGSGeometry*)geometry;

+ (nullable NSArray<AGSGeometry*>*)convexHullForGeometries:(NSArray<AGSGeometry*>*)geometries mergeInputs:(BOOL)mergeInputs;

+ (nullable AGSGeometry*)densifyGeometry:(AGSGeometry*)geometry maxSegmentLength:(double)maxSegmentLength;

+ (nullable AGSGeometry*)differenceOfGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;

+ (double)distanceBetweenGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;


+ (nullable AGSPolyline*)extendPolyline:(AGSPolyline*)polyline withPolyline:(AGSPolyline*)extender options:(AGSGeometryExtendOption)options;

+ (nullable AGSGeometry*)generalizeGeometry:(AGSGeometry*)geometry maxDeviation:(double)maxDeviation removeDegenerateParts:(BOOL)removeDegenerateParts;

+ (nullable AGSGeometry*)intersectionOfGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;

+ (nullable NSArray*)intersectionsOfGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;

+ (double)lengthOfGeometry:(AGSGeometry*)geometry;

+ (AGSGeometry*)geometryByRemovingMFromGeometry:(AGSGeometry*)geometry;


+ (AGSGeometry*)geometryByRemovingZFromGeometry:(AGSGeometry*)geometry;


+ (AGSGeometry*)geometryByRemovingZAndMFromGeometry:(AGSGeometry*)geometry;

+ (nullable AGSMultipart*)reshapeGeometry:(AGSMultipart*)geometry withPolyline:(AGSPolyline*)reshaper;

+ (AGSGeometry*)geometryBySettingM:(double)m inGeometry:(AGSGeometry*)geometry;

+ (AGSGeometry*)geometryBySettingZ:(double)z inGeometry:(AGSGeometry*)geometry;

+ (AGSGeometry*)geometryBySettingZ:(double)z M:(double)m inGeometry:(AGSGeometry*)geometry;

+ (nullable AGSGeometry*)simplifyGeometry:(AGSGeometry*)geometry;

+ (nullable AGSGeometry*)symmetricDifferenceOfGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;

+ (nullable AGSGeometry*)unionOfGeometry1:(AGSGeometry*)geometry1 geometry2:(AGSGeometry*)geometry2;

+ (nullable AGSGeometry*)unionGeometries:(NSArray<AGSGeometry*>*)geometries;

#pragma mark - Other

+ (nullable NSArray<AGSPolygon*>*)autoCompleteForExistingBoundaries:(NSArray<AGSGeometry*>*)existingBoundaries newBoundaries:(NSArray<AGSPolyline*>*)newBoundaries;

+ (nullable AGSPoint*)labelPointForPolygon:(AGSPolygon*)polygon;

+ (nullable AGSGeometry*)normalizeCentralMeridianOfGeometry:(AGSGeometry*)geometry;

+ (nullable AGSGeometry*)offsetGeometry:(AGSGeometry*)geometry distance:(double)distance offsetType:(AGSGeometryOffsetType)offsetType bevelRatio:(double)bevelRatio flattenError:(double)flattenError;

+ (nullable AGSGeometry*)projectGeometry:(AGSGeometry*)geometry toSpatialReference:(AGSSpatialReference*)spatialReference;

+ (nullable AGSGeometry*)projectGeometry:(AGSGeometry *)geometry
                      toSpatialReference:(AGSSpatialReference *)toSpatialReference
                     datumTransformation:(nullable AGSDatumTransformation *)datumTransformation;

+ (nullable AGSProximityResult*)nearestCoordinateInGeometry:(AGSGeometry*)geometry toPoint:(AGSPoint*)point;

+ (nullable AGSProximityResult*)nearestVertexInGeometry:(AGSGeometry*)geometry toPoint:(AGSPoint*)point;

+ (nullable AGSPoint *)pointAlongPolyline:(AGSPolyline *)polyline distance:(double)distance;

+(double)fractionAlongLine:(AGSPolyline *)line
                   toPoint:(AGSPoint *)point
                 tolerance:(double)tolerance;


@end