Package com.esri.arcgisruntime.geometry
Class GeodesicEllipseParameters
- java.lang.Object
-
- com.esri.arcgisruntime.geometry.GeodesicEllipseParameters
-
public final class GeodesicEllipseParameters extends java.lang.Object
Defines parameters used to create a geodesic ellipse.- Since:
- 100.0.0
- See Also:
GeometryEngine.ellipseGeodesic(GeodesicEllipseParameters)
-
-
Constructor Summary
Constructors Constructor Description GeodesicEllipseParameters()
Creates an instance of GeodesicEllipseParameters.GeodesicEllipseParameters(double axisDirection, AngularUnit angularUnit, Point center, LinearUnit linearUnit, int maxPointCount, double maxSegmentLength, GeometryType geometryType, double semiAxis1Length, double semiAxis2Length)
Creates an instance of GeodesicEllipseParameters with provided values.GeodesicEllipseParameters(Point center, double semiAxis1Length, double semiAxis2Length)
Creates an instance of GeodesicEllipseParameters with the given center point and axis lengths.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AngularUnit
getAngularUnit()
Gets the unit of measurement forgetAxisDirection()
.double
getAxisDirection()
Gets the direction of the major axis of the ellipse as an angle, in units ofgetAngularUnit()
.Point
getCenter()
Gets the center of the ellipse.GeometryType
getGeometryType()
Gets the type of output geometry.LinearUnit
getLinearUnit()
Gets the unit of measurement for linear values.long
getMaxPointCount()
Gets the maximum number of vertices in the ellipse.double
getMaxSegmentLength()
Gets the maximum segment length in the ellipse, in units ofgetLinearUnit()
.double
getSemiAxis1Length()
Gets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.double
getSemiAxis2Length()
Gets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.void
setAngularUnit(AngularUnit angularUnit)
Sets the unit of measurement for axis direction.void
setAxisDirection(double direction)
Sets the direction of the major axis of the ellipse as an angle, in units ofgetAngularUnit()
.void
setCenter(Point center)
Sets the center of the ellipse.void
setGeometryType(GeometryType geometryType)
Sets the type of output geometry.void
setLinearUnit(LinearUnit linearUnit)
Sets the unit of measurement for linear values.void
setMaxPointCount(int maxPointCount)
Sets the maximum number of vertices in the ellipse.void
setMaxSegmentLength(double maxSegmentLength)
Sets the maximum segment length of the ellipse, in units ofgetLinearUnit()
.void
setSemiAxis1Length(double length)
Sets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.void
setSemiAxis2Length(double length)
Sets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.
-
-
-
Constructor Detail
-
GeodesicEllipseParameters
public GeodesicEllipseParameters()
Creates an instance of GeodesicEllipseParameters.- Since:
- 100.0.0
-
GeodesicEllipseParameters
public GeodesicEllipseParameters(double axisDirection, AngularUnit angularUnit, Point center, LinearUnit linearUnit, int maxPointCount, double maxSegmentLength, GeometryType geometryType, double semiAxis1Length, double semiAxis2Length)
Creates an instance of GeodesicEllipseParameters with provided values.- Parameters:
axisDirection
- the direction of the major axis of the ellipse as an angle in units ofangularUnit
angularUnit
- unit foraxisDirection
. If null, defaults to degreescenter
- center of the ellipse. It must have a spatial reference.linearUnit
- units for the linear values. If null, defaults to metersmaxPointCount
- maximum number of vertices in the ellipsemaxSegmentLength
- maximum segment length of the ellipse, in units oflinearUnit
geometryType
- type of output geometrysemiAxis1Length
- length of the semi-major or semi-minor axis of the ellipse, in units oflinearUnit
semiAxis2Length
- length of the semi-major or semi-minor axis of the ellipse, in units oflinearUnit
- Throws:
java.lang.IllegalArgumentException
- if center or geometryType is null- Since:
- 100.0.0
-
GeodesicEllipseParameters
public GeodesicEllipseParameters(Point center, double semiAxis1Length, double semiAxis2Length)
Creates an instance of GeodesicEllipseParameters with the given center point and axis lengths.The geodesic ellipse parameter set returned contains the following default values:
Property Value linearUnit meter angularUnit degree axisDirection 0 geometryType polygon maxSegmentLength 2 * pi * a / 360 maxPointCount 65536 - Parameters:
center
- the center point of the ellipsesemiAxis1Length
- the length of the semi-major or semi-minor axis of the ellipse in meterssemiAxis2Length
- the length of the semi-major or semi-minor axis of the ellipse in meters- Throws:
java.lang.IllegalArgumentException
- if center is null- Since:
- 100.3.0
-
-
Method Detail
-
getAxisDirection
public double getAxisDirection()
Gets the direction of the major axis of the ellipse as an angle, in units ofgetAngularUnit()
.- Returns:
- the axis direction
- Since:
- 100.0.0
- See Also:
getAngularUnit()
-
getAngularUnit
public AngularUnit getAngularUnit()
Gets the unit of measurement forgetAxisDirection()
. Default is ofAngularUnitId.DEGREES
type.- Returns:
- the unit for
getAxisDirection()
- Since:
- 100.0.0
-
getCenter
public Point getCenter()
Gets the center of the ellipse.- Returns:
- the center of the ellipse
- Since:
- 100.0.0
-
getGeometryType
public GeometryType getGeometryType()
Gets the type of output geometry. Default isGeometryType.POLYGON
.- Returns:
- the type of output geometry
- Since:
- 100.0.0
-
getMaxPointCount
public long getMaxPointCount()
Gets the maximum number of vertices in the ellipse.- Returns:
- the maximum number of vertices in the ellipse
- Since:
- 100.0.0
-
getMaxSegmentLength
public double getMaxSegmentLength()
Gets the maximum segment length in the ellipse, in units ofgetLinearUnit()
.- Returns:
- the maximum segment length in the ellipse, in units of
getLinearUnit()
- Since:
- 100.0.0
-
getSemiAxis1Length
public double getSemiAxis1Length()
Gets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.- Returns:
- the length of the semi-major or semi-minor axis of the ellipse, in units of
getLinearUnit()
- Since:
- 100.0.0
-
getSemiAxis2Length
public double getSemiAxis2Length()
Gets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.- Returns:
- the length of the semi-major or semi-minor axis of the ellipse, in units of
getLinearUnit()
- Since:
- 100.0.0
-
getLinearUnit
public LinearUnit getLinearUnit()
Gets the unit of measurement for linear values. Default is ofLinearUnitId.METERS
type.- Returns:
- the unit of measurement for linear values
- Since:
- 100.0.0
- See Also:
getMaxSegmentLength()
,getSemiAxis1Length()
,getSemiAxis2Length()
-
setAxisDirection
public void setAxisDirection(double direction)
Sets the direction of the major axis of the ellipse as an angle, in units ofgetAngularUnit()
.- Parameters:
direction
- the direction of the major axis of the ellipse as an angle, in units ofgetAngularUnit()
- Since:
- 100.0.0
-
setAngularUnit
public void setAngularUnit(AngularUnit angularUnit)
Sets the unit of measurement for axis direction.- Parameters:
angularUnit
- the unit of measurement for axis direction- Throws:
java.lang.IllegalArgumentException
- if angularUnit is null- Since:
- 100.0.0
- See Also:
setAxisDirection(double)
-
setCenter
public void setCenter(Point center)
Sets the center of the ellipse.- Parameters:
center
- center of the ellipse- Throws:
java.lang.IllegalArgumentException
- if center is null- Since:
- 100.0.0
-
setGeometryType
public void setGeometryType(GeometryType geometryType)
Sets the type of output geometry.- Parameters:
geometryType
- the type of output geometry- Throws:
java.lang.IllegalArgumentException
- if geometryType is null- Since:
- 100.0.0
-
setMaxPointCount
public void setMaxPointCount(int maxPointCount)
Sets the maximum number of vertices in the ellipse.- Parameters:
maxPointCount
- the maximum number of vertices in the ellipse- Since:
- 100.0.0
-
setMaxSegmentLength
public void setMaxSegmentLength(double maxSegmentLength)
Sets the maximum segment length of the ellipse, in units ofgetLinearUnit()
.- Parameters:
maxSegmentLength
- the maximum segment length of the ellipse, in units ofgetLinearUnit()
- Since:
- 100.0.0
-
setSemiAxis1Length
public void setSemiAxis1Length(double length)
Sets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.- Parameters:
length
- the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
- Since:
- 100.0.0
-
setSemiAxis2Length
public void setSemiAxis2Length(double length)
Sets the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
.- Parameters:
length
- the length of the semi-major or semi-minor axis of the ellipse, in units ofgetLinearUnit()
- Since:
- 100.0.0
-
setLinearUnit
public void setLinearUnit(LinearUnit linearUnit)
Sets the unit of measurement for linear values.- Parameters:
linearUnit
- the unit of measurement for linear values- Throws:
java.lang.IllegalArgumentException
- if angularUnit is null- Since:
- 100.0.0
- See Also:
setMaxSegmentLength(double)
,setSemiAxis1Length(double)
,setSemiAxis2Length(double)
-
-