AGSGeometry.h File Reference

Defines
#define	WKID_EQUAL_AREA 54034
#define	WKID_POPULAR_VISUALISATION_CRS_MERCATOR 3785
#define	WKID_WGS84 4326
#define	WKID_WGS_1984_WEB_MERCATOR 102113
#define	WKID_WGS_1984_WEB_MERCATOR_AUXILIARY_SPHERE 102100
#define	WKID_WGS_1984_WEB_MERCATOR_AUXILIARY_SPHERE_10 3857
Enumerations
enum	AGSAreaUnits { AGSAreaUnitsSquareInches = 0, AGSAreaUnitsSquareFeet, AGSAreaUnitsSquareYards, AGSAreaUnitsAcres, AGSAreaUnitsSquareMiles, AGSAreaUnitsSquareMillimeters, AGSAreaUnitsSquareCentimeters, AGSAreaUnitsSquareDecimeters, AGSAreaUnitsSquareMeters, AGSAreaUnitsAres, AGSAreaUnitsHectares, AGSAreaUnitsSquareKilometers }
enum	AGSGeometryType { AGSGeometryTypePoint, AGSGeometryTypePolyline, AGSGeometryTypePolygon, AGSGeometryTypeMultipoint, AGSGeometryTypeEnvelope }
enum	AGSSRUnit { AGSSRUnitMeter = 9001, AGSSRUnitGermanMeter = 9031, AGSSRUnitFoot = 9002, AGSSRUnitSurveyFoot = 9003, AGSSRUnitClarkeFoot = 9005, AGSSRUnitFathom = 9014, AGSSRUnitNauticalMile = 9030, AGSSRUnitSurveyChain = 9033, AGSSRUnitSurveyLink = 9034, AGSSRUnitSurveyMile = 9035, AGSSRUnitKilometer = 9036, AGSSRUnitClarkeYard = 9037, AGSSRUnitClarkeChain = 9038, AGSSRUnitClarkeLink = 9039, AGSSRUnitSearsYard = 9040, AGSSRUnitSearsFoot = 9041, AGSSRUnitSearsChain = 9042, AGSSRUnitSearsLink = 9043, AGSSRUnitBenoit1895AYard = 9050, AGSSRUnitBenoit1895AFoot = 9051, AGSSRUnitBenoit1895AChain = 9052, AGSSRUnitBenoit1895ALink = 9053, AGSSRUnitBenoit1895BYard = 9060, AGSSRUnitBenoit1895BFoot = 9061, AGSSRUnitBenoit1895BChain = 9062, AGSSRUnitBenoit1895BLink = 9063, AGSSRUnitIndianFoot = 9080, AGSSRUnitIndian1937Foot = 9081, AGSSRUnitIndian1962Foot = 9082, AGSSRUnitIndian1975Foot = 9083, AGSSRUnitIndianYard = 9084, AGSSRUnitIndian1937Yard = 9085, AGSSRUnitIndian1962Yard = 9086, AGSSRUnitIndian1975Yard = 9087, AGSSRUnitFoot1865 = 9070, AGSSRUnitRadian = 9101, AGSSRUnitDegree = 9102, AGSSRUnitArcMinute = 9103, AGSSRUnitArcSecond = 9104, AGSSRUnitGrad = 9105, AGSSRUnitGon = 9106, AGSSRUnitMicroradian = 9109, AGSSRUnitArcMinuteCentesimal = 9112, AGSSRUnitArcSecondCentesimal = 9113, AGSSRUnitMil6400 = 9114, AGSSRUnitBritish1936Foot = 9095, AGSSRUnitGoldCoastFoot = 9094, AGSSRUnitInternationalChain = 109003, AGSSRUnitInternationalLink = 109004, AGSSRUnitInternationalYard = 109001, AGSSRUnitStatuteMile = 9093, AGSSRUnitSurveyYard = 109002, AGSSRUnit50KilometerLength = 109030, AGSSRUnit150KilometerLength = 109031, AGSSRUnitDecimeter = 109005, AGSSRUnitCentimeter = 109006, AGSSRUnitMillimeter = 109007, AGSSRUnitInternationalInch = 109008, AGSSRUnitUSsurveyInch = 109009, AGSSRUnitInternationalRod = 109010, AGSSRUnitUSsurveyRod = 109011, AGSSRUnitUSNauticalMile = 109012, AGSSRUnitUKNauticalMile = 109013 }
enum	AGSUnits { AGSUnitsCentimeters = 0, AGSUnitsDecimalDegrees, AGSUnitsDecimeters, AGSUnitsFeet, AGSUnitsInches, AGSUnitsKilometers, AGSUnitsMeters, AGSUnitsMiles, AGSUnitsMillimeters, AGSUnitsNauticalMiles, AGSUnitsPoints, AGSUnitsUnknown, AGSUnitsYards }
Functions
NSString *	AGSAreaUnitsAbbreviatedString (AGSAreaUnits unit)
NSString *	AGSAreaUnitsDisplayString (AGSAreaUnits unit)
AGSAreaUnits	AGSAreaUnitsFromString (NSString *unit)
NSString *	AGSAreaUnitsString (AGSAreaUnits unit)
double	AGSAreaUnitsToAreaUnits (double val, AGSAreaUnits fromUnits, AGSAreaUnits toUnits)
BOOL	AGSGeometryCGPathIntersectsRectangle (CGPathRef path, CGRect pathBBox, CGRect rectangle)
AGSGeometry *	AGSGeometryGeographicToWebMercator (AGSGeometry *geometry)
AGSGeometryType	AGSGeometryTypeForGeometry (AGSGeometry *geometry)
AGSGeometryType	AGSGeometryTypeFromString (NSString *geometryType)
NSString *	AGSGeometryTypeString (AGSGeometryType geometryType)
AGSGeometry *	AGSGeometryWebMercatorToGeographic (AGSGeometry *geometry)
AGSGeometry *	AGSGeometryWithJSON (NSDictionary *json)
AGSGeometry *	AGSGeometryWithJSONAndSR (NSDictionary json, AGSSpatialReference sr)
NSString *	AGSUnitsAbbreviatedString (AGSUnits unit)
NSString *	AGSUnitsDisplayString (AGSUnits unit)
AGSUnits	AGSUnitsFromString (NSString *unit)
NSString *	AGSUnitsString (AGSUnits unit)
double	AGSUnitsToUnits (double val, AGSUnits fromUnits, AGSUnits toUnits)

Define Documentation

#define WKID_EQUAL_AREA 54034

The WKID for World Cylindrical Equal Area.

Since:: 1.0

#define WKID_POPULAR_VISUALISATION_CRS_MERCATOR 3785

The WKID for Popular Visualisation CRS Mercator (3785). It was deprecated by EPSG in favor of 3857.

Since:: 1.0

#define WKID_WGS84 4326

The WKID for WGS 84.

Since:: 1.0

#define WKID_WGS_1984_WEB_MERCATOR 102113

The WKID for WGS 1984 Web Mercator (102113). It was added at 9.3, deprecated in favor of 3857 (added at 10.0).

Since:: 1.0

#define WKID_WGS_1984_WEB_MERCATOR_AUXILIARY_SPHERE 102100

The WKID for WGS 1984 Web Mercator Auxiliary Sphere (102100).

Since:: 1.0

#define WKID_WGS_1984_WEB_MERCATOR_AUXILIARY_SPHERE_10 3857

The WKID for WGS 1984 Web Mercator Auxiliary Sphere starting at ArcGIS 10.0.

Availability:: This feature is only available with services from ArcGIS Server 10.0 or above

Since:: 1.0

Enumeration Type Documentation

enum AGSAreaUnits

Supported area units.

Since:: 1.0

Enumerator:

AGSAreaUnitsSquareInches
AGSAreaUnitsSquareFeet
AGSAreaUnitsSquareYards
AGSAreaUnitsAcres
AGSAreaUnitsSquareMiles
AGSAreaUnitsSquareMillimeters
AGSAreaUnitsSquareCentimeters
AGSAreaUnitsSquareDecimeters
AGSAreaUnitsSquareMeters
AGSAreaUnitsAres
AGSAreaUnitsHectares
AGSAreaUnitsSquareKilometers

enum AGSGeometryType

Supported geometry types.

Since:: 1.0

Enumerator:

AGSGeometryTypePoint
AGSGeometryTypePolyline
AGSGeometryTypePolygon
AGSGeometryTypeMultipoint
AGSGeometryTypeEnvelope

enum AGSSRUnit

Supported esriSRUnits.

Since:: 1.0

Enumerator:

AGSSRUnitMeter	International meter.
AGSSRUnitGermanMeter	German legal meter.
AGSSRUnitFoot	International foot.
AGSSRUnitSurveyFoot	US survey foot.
AGSSRUnitClarkeFoot	Clarke's foot.
AGSSRUnitFathom	Fathom.
AGSSRUnitNauticalMile	International nautical mile.
AGSSRUnitSurveyChain	US survey chain.
AGSSRUnitSurveyLink	US survey link.
AGSSRUnitSurveyMile	US survey mile.
AGSSRUnitKilometer	Kilometer.
AGSSRUnitClarkeYard	Yard (Clarke's ratio).
AGSSRUnitClarkeChain	Chain (Clarke's ratio).
AGSSRUnitClarkeLink	Link (Clarke's ratio).
AGSSRUnitSearsYard	Yard (Sears).
AGSSRUnitSearsFoot	Sears' foot.
AGSSRUnitSearsChain	Chain (Sears).
AGSSRUnitSearsLink	Link (Sears).
AGSSRUnitBenoit1895AYard	Yard (Benoit 1895 A).
AGSSRUnitBenoit1895AFoot	Foot (Benoit 1895 A).
AGSSRUnitBenoit1895AChain	Chain (Benoit 1895 A).
AGSSRUnitBenoit1895ALink	Link (Benoit 1895 A).
AGSSRUnitBenoit1895BYard	Yard (Benoit 1895 B).
AGSSRUnitBenoit1895BFoot	Foot (Benoit 1895 B).
AGSSRUnitBenoit1895BChain	Chain (Benoit 1895 B).
AGSSRUnitBenoit1895BLink	Link (Benoit 1895 B).
AGSSRUnitIndianFoot	Indian geodetic foot.
AGSSRUnitIndian1937Foot	Indian foot (1937).
AGSSRUnitIndian1962Foot	Indian foot (1962).
AGSSRUnitIndian1975Foot	Indian foot (1975).
AGSSRUnitIndianYard	Indian yard.
AGSSRUnitIndian1937Yard	Indian yard (1937).
AGSSRUnitIndian1962Yard	Indian yard (1962).
AGSSRUnitIndian1975Yard	Indian yard (1975).
AGSSRUnitFoot1865	Foot (1865).
AGSSRUnitRadian	Radian.
AGSSRUnitDegree	Degree.
AGSSRUnitArcMinute	Arc-minute.
AGSSRUnitArcSecond	Arc-second.
AGSSRUnitGrad	Grad.
AGSSRUnitGon	Gon.
AGSSRUnitMicroradian	Microradian.
AGSSRUnitArcMinuteCentesimal	Centesimal arc-minute.
AGSSRUnitArcSecondCentesimal	Centesimal arc-second.
AGSSRUnitMil6400	Mil.
AGSSRUnitBritish1936Foot	British Foot (1936).
AGSSRUnitGoldCoastFoot	Gold Coast Foot.
AGSSRUnitInternationalChain	International Chain.
AGSSRUnitInternationalLink	International Link.
AGSSRUnitInternationalYard	International Yard.
AGSSRUnitStatuteMile	Statute Mile.
AGSSRUnitSurveyYard	US survey Yard.
AGSSRUnit50KilometerLength	50 Kilometer Length.
AGSSRUnit150KilometerLength	150 Kilometer Length.
AGSSRUnitDecimeter	Decimeter.
AGSSRUnitCentimeter	Centimeter.
AGSSRUnitMillimeter	Millimeter.
AGSSRUnitInternationalInch	International inch.
AGSSRUnitUSsurveyInch	US survey inch.
AGSSRUnitInternationalRod	International rod.
AGSSRUnitUSsurveyRod	US survey rod.
AGSSRUnitUSNauticalMile	US nautical mile (pre-1954).
AGSSRUnitUKNauticalMile	UK nautical mile (pre-1970).

enum AGSUnits

Supported linear units.

Since:: 1.0

Enumerator:

AGSUnitsCentimeters
AGSUnitsDecimalDegrees
AGSUnitsDecimeters
AGSUnitsFeet
AGSUnitsInches
AGSUnitsKilometers
AGSUnitsMeters
AGSUnitsMiles
AGSUnitsMillimeters
AGSUnitsNauticalMiles
AGSUnitsPoints
AGSUnitsUnknown
AGSUnitsYards

Function Documentation

NSString* AGSAreaUnitsAbbreviatedString ( AGSAreaUnits unit )

Get the abbreviated string for AGSAreaUnits. For example, AGSAreaUnitsSquareKilometers would return "sq. km".

Parameters:

unit

The unit type to return as an abbreviated string.

Returns:: Abbreviated string of unit.

Since:: 1.0

NSString* AGSAreaUnitsDisplayString ( AGSAreaUnits unit )

Get the display string for AGSAreaUnits.

Parameters:

unit

The unit type to return as a string.

Returns:: Display string of unit.

Since:: 1.0

AGSAreaUnits AGSAreaUnitsFromString ( NSString * unit )

Get AGSAreaUnits from string representation. For example, "esriSquareKilometers" would return AGSAreaUnitsSquareKilometers.

Parameters:

unit The string representation of unit.

Returns:: AGSAreaUnits from string.

Since:: 1.0

Get AGSAreaUnits from string representation.

Parameters:

unit The string representation of unit.

Returns:: AGSAreaUnits from string.

Since:: 1.0

NSString* AGSAreaUnitsString ( AGSAreaUnits unit )

Get string representation of the area unit.

Parameters:

unit

The unit type to return as a string.

Returns:: String representation of AGSAreaUnits.

Since:: 1.0

double AGSAreaUnitsToAreaUnits	(	double	val,
		AGSAreaUnits	fromUnits,
		AGSAreaUnits	toUnits
	)

Converts val from one unit to another.

Parameters:

	val	The value to be converted.
	fromUnits	The initial units of `val`.
	toUnits	The units `val` is to be converted to.

Returns:: val in the units specified by toUnits.

Since:: 1.0

BOOL AGSGeometryCGPathIntersectsRectangle	(	CGPathRef	path,
		CGRect	pathBBox,
		CGRect	rectangle
	)

Returns whether path intersects rectangle.

Parameters:

	path	The input path that may or may not intersect rectangle.
	pathBBox	The bounding box of `path`.
	rectangle	The rectangle to test intersection relation.

Returns:: YES if path intersects rectangle.

AGSGeometry* AGSGeometryGeographicToWebMercator ( AGSGeometry * geometry )

Returns a geometry converted from geographic to web mercator.

Parameters:

geometry

The geometry to convert to web mercator.

Returns:: An AGSGeometry object in web mercator.

Since:: 1.0

AGSGeometryType AGSGeometryTypeForGeometry ( AGSGeometry * geometry )

Return AGSGeometryType from geometry.

Parameters:

geometry

The geometry to determine geometry type.

Returns:: AGSGeometryType for geometry.

See also:: AGSGeometryType

AGSGeometryType AGSGeometryTypeFromString ( NSString * geometryType )

Return geometry type for type string.

Parameters:

geometryType

The string representation of a geometry type.

Returns:: AGSGeometryType for geometryType string.

See also:: AGSGeometryType

NSString* AGSGeometryTypeString ( AGSGeometryType geometryType )

Return geometry type string for AGSGeometryType.

Parameters:

geometryType

The type for geometry.

Returns:: String representation of geometryType.

See also:: AGSGeometryType

AGSGeometry* AGSGeometryWebMercatorToGeographic ( AGSGeometry * geometry )

Returns a geometry converted from web mercator to geographic.

Parameters:

geometry

The geometry to convert to geographic.

Returns:: An AGSGeometry object in geographic.

Since:: 1.0

AGSGeometry* AGSGeometryWithJSON ( NSDictionary * json )

Return autoreleased geometry, initialized from JSON representation.

Parameters:

json

The JSON representation.

Returns:: A new geometry object.

AGSGeometry* AGSGeometryWithJSONAndSR	(	NSDictionary *	json,
		AGSSpatialReference *	sr
	)

Return autoreleased geometry, initialized from JSON representation and spatial reference.

Parameters:

	json	The JSON representation.
	sr	The spatial reference of the geometry.

Returns:: A new geometry object.

NSString* AGSUnitsAbbreviatedString ( AGSUnits unit )

Get the abbreviated string for AGSUnits. For example, AGSUnitsMeters would return "m".

Parameters:

unit

The unit type to return as a string.

Returns:: Abbreviated string of unit.

Since:: 1.0

NSString* AGSUnitsDisplayString ( AGSUnits unit )

Get the display string for AGSUnits.

Parameters:

unit

The unit type to return as a string.

Returns:: Display string of unit.

Since:: 1.0

AGSUnits AGSUnitsFromString ( NSString * unit )

Get AGSUnits from string representation. For example, "esriMeters" would return AGSUnitsMeters.

Parameters:

unit

The string representation of unit to be converted.

Returns:: AGSUnits from string.

See also:: AGSUnits

Since:: 1.0

NSString* AGSUnitsString ( AGSUnits unit )

Get string representation of unit.

Parameters:

unit

The unit type to return as a string.

Returns:: String representation of AGSUnits.

See also:: AGSUnits

Since:: 1.0

double AGSUnitsToUnits	(	double	val,
		AGSUnits	fromUnits,
		AGSUnits	toUnits
	)

Converts val from one unit to another.

Parameters:

	val	The value to be converted.
	fromUnits	The units of `val`.
	toUnits	The units `val` is to be converted to.

Returns:: val in units specified by toUnits.

Since:: 1.0

AGSGeometry.h File Reference

Defines

Enumerations

Functions

Define Documentation

Enumeration Type Documentation

Function Documentation