ArcGIS Runtime SDK for iOS: AGSGeodesicEllipseParameters Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSGeodesicEllipseParameters Class Reference

Description

Parameters for geodesicEllipseWithParameters: (AGSGeometryEngine)

This class holds options for the geodesicEllipseWithParameters: (AGSGeometryEngine) operation.

@define{AGSGeodesicEllipseParameters.h, ArcGIS}

Since
100
Inheritance diagram for AGSGeodesicEllipseParameters:
AGSObject

Instance Methods

(instancetype) - initWithAxisDirection:angularUnit:center:linearUnit:maxPointCount:maxSegmentLength:geometryType:semiAxis1Length:semiAxis2Length:
 
(instancetype) - initWithCenter:maxSegmentLength:semiAxisLength:
 
(instancetype) - initWithCenter:semiAxis1Length:semiAxis2Length:
 

Class Methods

(instancetype) + geodesicEllipseParameters
 
(instancetype) + parametersWithAxisDirection:angularUnit:center:linearUnit:maxPointCount:maxSegmentLength:geometryType:semiAxis1Length:semiAxis2Length:
 
(instancetype) + parametersWithCenter:maxSegmentLength:semiAxisLength:
 
(instancetype) + parametersWithCenter:semiAxis1Length:semiAxis2Length:
 

Properties

AGSAngularUnitangularUnit
 
double axisDirection
 
AGSPointcenter
 
AGSGeometryType geometryType
 
AGSLinearUnitlinearUnit
 
NSInteger maxPointCount
 
double maxSegmentLength
 
double semiAxis1Length
 
double semiAxis2Length
 

Method Documentation

◆ geodesicEllipseParameters

+ (instancetype) geodesicEllipseParameters

Initializes an AGSGeodesicEllipseParameters object.

Returns
A new geodesic ellipse parameter object.
Since
100

◆ initWithAxisDirection:angularUnit:center:linearUnit:maxPointCount:maxSegmentLength:geometryType:semiAxis1Length:semiAxis2Length:

- (instancetype) initWithAxisDirection: (double)  axisDirection
angularUnit: (nullable AGSAngularUnit *)  angularUnit
center: (AGSPoint *)  center
linearUnit: (nullable AGSLinearUnit *)  linearUnit
maxPointCount: (NSInteger)  maxPointCount
maxSegmentLength: (double)  maxSegmentLength
geometryType: (AGSGeometryType geometryType
semiAxis1Length: (double)  semiAxis1Length
semiAxis2Length: (double)  semiAxis2Length 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
axisDirectionThe direction of the major axis of the ellipse as an angle, in units of angularUnit.
angularUnitThe optional angular unit of measure. If null, degrees will be assumed.
centerThe center point of the ellipse.
linearUnitThe optional linear unit of measure. If null, meters will be assumed.
maxPointCountThe maximum number of points permitted in the constructed ellipse.
maxSegmentLengthThe maximum distance between vertices used to construct the ellipse.
geometryTypeThe type of output geometry. Acceptable values are Multipoint, Polyline, and Polygon.
semiAxis1LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
semiAxis2LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
Returns
A new geodesic ellipse parameter object.
Since
100.4

◆ initWithCenter:maxSegmentLength:semiAxisLength:

- (instancetype) initWithCenter: (AGSPoint *)  center
maxSegmentLength: (double)  maxSegmentLength
semiAxisLength: (double)  semiAxisLength 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
centerThe center point of the ellipse.
maxSegmentLengthThe maximum distance between vertices used to construct the ellipse.
semiAxisLengthThe length of the semi-major or the semi-minor axis of the ellipse.
Returns
A new geodesic ellipse parameter object.
Since
100

◆ initWithCenter:semiAxis1Length:semiAxis2Length:

- (instancetype) initWithCenter: (nullable AGSPoint *)  center
semiAxis1Length: (double)  semiAxis1Length
semiAxis2Length: (double)  semiAxis2Length 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
centerThe center point of the ellipse.
semiAxis1LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
semiAxis2LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
Returns
A new geodesic ellipse parameter object.
Since
100.1.1

◆ parametersWithAxisDirection:angularUnit:center:linearUnit:maxPointCount:maxSegmentLength:geometryType:semiAxis1Length:semiAxis2Length:

+ (instancetype) parametersWithAxisDirection: (double)  axisDirection
angularUnit: (nullable AGSAngularUnit *)  angularUnit
center: (AGSPoint *)  center
linearUnit: (nullable AGSLinearUnit *)  linearUnit
maxPointCount: (NSInteger)  maxPointCount
maxSegmentLength: (double)  maxSegmentLength
geometryType: (AGSGeometryType geometryType
semiAxis1Length: (double)  semiAxis1Length
semiAxis2Length: (double)  semiAxis2Length 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
axisDirectionThe direction of the major axis of the ellipse as an angle, in units of angularUnit.
angularUnitThe optional angular unit of measure. If null, degrees will be assumed.
centerThe center point of the ellipse.
linearUnitThe optional linear unit of measure. If null, meters will be assumed.
maxPointCountThe maximum number of points permitted in the constructed ellipse.
maxSegmentLengthThe maximum distance between vertices used to construct the ellipse.
geometryTypeThe type of output geometry. Acceptable values are Multipoint, Polyline, and Polygon.
semiAxis1LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
semiAxis2LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
Returns
A new geodesic ellipse parameter object.
Since
100.4

◆ parametersWithCenter:maxSegmentLength:semiAxisLength:

+ (instancetype) parametersWithCenter: (AGSPoint *)  center
maxSegmentLength: (double)  maxSegmentLength
semiAxisLength: (double)  semiAxisLength 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
centerThe center AGSPoint of the ellipse.
maxSegmentLengthThe maximum distance between vertices used to construct the ellipse.
semiAxisLengthThe length of the semi-major or the semi-minor axis of the ellipse.
Returns
A new, autoreleased, geodesic ellipse parameter object.
Since
100

◆ parametersWithCenter:semiAxis1Length:semiAxis2Length:

+ (instancetype) parametersWithCenter: (nullable AGSPoint *)  center
semiAxis1Length: (double)  semiAxis1Length
semiAxis2Length: (double)  semiAxis2Length 

Initializes an AGSGeodesicEllipseParameters object.

Parameters
centerThe center point of the ellipse.
semiAxis1LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
semiAxis2LengthThe length of the semi-major or semi-minor axis of the ellipse, in units of linearUnit.
Returns
A new geodesic ellipse parameter object.
Since
100.1.1

Property Documentation

◆ angularUnit

- (AGSAngularUnit*) angularUnit
readwritenonatomicstrong

The angular unit of the sectorAngle. The default is AGSAngularUnitIDDegrees.

Since
100

◆ axisDirection

- (double) axisDirection
readwritenonatomicassign

The direction of the longest axis of the ellipse as an angle (in degrees).

Since
100

◆ center

- (AGSPoint*) center
readwritenonatomicstrong

The center AGSPoint of the ellipse.

Since
100

◆ geometryType

- (AGSGeometryType) geometryType
readwritenonatomicassign

The type of output geometry created. Acceptable values are AGSMultipoint, AGSPolyline and AGSPolygon. Defaults to AGSGeometryTypePolgon.

Since
100

◆ linearUnit

- (AGSLinearUnit*) linearUnit
readwritenonatomicstrong

The linear units of the lengths maxSegment, semiAxis1 and semiAxis2. The default is AGSLinearUnitIDMeters.

Since
100

◆ maxPointCount

- (NSInteger) maxPointCount
readwritenonatomicassign

The maximum number of points permitted in the constructed ellipse.

Since
100

◆ maxSegmentLength

- (double) maxSegmentLength
readwritenonatomicassign

The maximum distance between vertices used to construct the ellipse.

Since
100

◆ semiAxis1Length

- (double) semiAxis1Length
readwritenonatomicassign

The length of the semi-major or the semi-minor axis of the ellipse.

Since
100

◆ semiAxis2Length

- (double) semiAxis2Length
readwritenonatomicassign

The length of the semi-major or the semi-minor axis of the ellipse. If semiAxis1 = semiAxis2 then a geodesic circle is created.

Since
100