agi.foundation.geometry.discrete

(agi.foundation.graphics-2024r3.jar)

Class SurfaceShapes

java.lang.Object

agi.foundation.geometry.discrete.SurfaceShapes

public final class SurfaceShapes
extends Object

Computes boundary positions for shapes on the surface such as circles, ellipses, and sectors.

See Also:

Triangle Mesh Primitive topic - Surface Shapes, SurfaceShapesResult

Method Summary

Modifier and Type	Method and Description
static SurfaceShapesResult	computeCircle(CentralBody centralBody, Cartesian center, double radius) Computes boundary positions for a circle on the specified centralBody with the specified center and radius.
static SurfaceShapesResult	computeCircle(CentralBody centralBody, Cartesian center, double radius, double granularity) Computes boundary positions for a circle on the specified centralBody with the specified center, radius and granularity.
static SurfaceShapesResult	computeCircleCartographic(CentralBody centralBody, Cartographic center, double radius) For convenience.
static SurfaceShapesResult	computeCircleCartographic(CentralBody centralBody, Cartographic center, double radius, double granularity) For convenience.
static SurfaceShapesResult	computeEllipse(CentralBody centralBody, Cartesian center, double majorAxisRadius, double minorAxisRadius, double bearing) Computes boundary positions for an ellipse on the specified centralBody This is equivalent to calling SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double) with a granularity of 1 degree.
static SurfaceShapesResult	computeEllipse(CentralBody centralBody, Cartesian center, double majorAxisRadius, double minorAxisRadius, double bearing, double granularity) Computes boundary positions for an ellipse on the specified centralBody.
static SurfaceShapesResult	computeEllipseCartographic(CentralBody centralBody, Cartographic center, double majorAxisRadius, double minorAxisRadius, double bearing) For convenience.
static SurfaceShapesResult	computeEllipseCartographic(CentralBody centralBody, Cartographic center, double majorAxisRadius, double minorAxisRadius, double bearing, double granularity) For convenience.
static SurfaceShapesResult	computeSector(CentralBody centralBody, Cartesian center, double innerRadius, double outerRadius, double startBearing, double endBearing) Computes boundary positions for a sector on the specified centralBody This is equivalent to calling SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double) with a granularity of 1 degree.
static SurfaceShapesResult	computeSector(CentralBody centralBody, Cartesian center, double innerRadius, double outerRadius, double startBearing, double endBearing, double granularity) Computes boundary positions for a sector on the specified centralBody.
static SurfaceShapesResult	computeSectorCartographic(CentralBody centralBody, Cartographic center, double innerRadius, double outerRadius, double startBearing, double endBearing) For convenience.
static SurfaceShapesResult	computeSectorCartographic(CentralBody centralBody, Cartographic center, double innerRadius, double outerRadius, double startBearing, double endBearing, double granularity) For convenience.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

computeCircle

public static final SurfaceShapesResult computeCircle(CentralBody centralBody,
                                                      Cartesian center,
                                                      double radius,
                                                      double granularity)

Computes boundary positions for a circle on the specified centralBody with the specified center, radius and granularity.

The computed positions are at the same altitude as the input center.

Lower granularities are more precise but result in more positions.

Parameters:

centralBody - The central body to compute the circle on.

center - The center of the circle, in the centralBody's fixed reference frame.

radius - The radius of the circle, in meters.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the circle, in the centralBody's fixed reference frame.

Throws:

ArgumentNullException - centralBody is null.

ArgumentOutOfRangeException - radius and granularity must be greater than zero.

See Also:

Triangle Mesh Primitive topic - Surface Shapes

computeCircle

public static final SurfaceShapesResult computeCircle(CentralBody centralBody,
                                                      Cartesian center,
                                                      double radius)

Computes boundary positions for a circle on the specified centralBody with the specified center and radius. This is equivalent to calling SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double) with a granularity of 1 degree.

See SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the circle on.

center - The center of the circle, in the centralBody's fixed reference frame.

radius - The radius of the circle, in meters.

Returns:

A SurfaceShapesResult object representing the boundary of the circle, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double)

computeCircleCartographic

public static final SurfaceShapesResult computeCircleCartographic(CentralBody centralBody,
                                                                  Cartographic center,
                                                                  double radius,
                                                                  double granularity)

For convenience. Computes boundary positions for a circle on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double)

See SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the circle on.

center - The center of the circle.

radius - The radius of the circle, in meters.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the circle, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double)

computeCircleCartographic

public static final SurfaceShapesResult computeCircleCartographic(CentralBody centralBody,
                                                                  Cartographic center,
                                                                  double radius)

For convenience. Computes boundary positions for a circle on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double)

See SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double) for a full discussion.

Parameters:

centralBody - The central body to compute the circle on.

center - The center of the circle.

radius - The radius of the circle, in meters.

Returns:

A SurfaceShapesResult object representing the boundary of the circle, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeCircle(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double)

computeEllipse

public static final SurfaceShapesResult computeEllipse(CentralBody centralBody,
                                                       Cartesian center,
                                                       double majorAxisRadius,
                                                       double minorAxisRadius,
                                                       double bearing,
                                                       double granularity)

Computes boundary positions for an ellipse on the specified centralBody.

The computed positions are at the same altitude as the input center.

Lower granularities are more precise but result in more positions.

Parameters:

centralBody - The central body to compute the ellipse on.

center - The center of the ellipse, in the centralBody's fixed reference frame.

majorAxisRadius - The radius of the ellipse's major axis, in meters.

minorAxisRadius - The radius of the ellipse's minor axis, in meters.

bearing - An angle, in radians, measured clockwise from north.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the ellipse, in the centralBody's fixed reference frame.

Throws:

ArgumentNullException - centralBody is null.

ArgumentOutOfRangeException - majorAxisRadius, minorAxisRadius, and granularity must be greater than zero.

See Also:

Triangle Mesh Primitive topic - Surface Shapes

computeEllipse

public static final SurfaceShapesResult computeEllipse(CentralBody centralBody,
                                                       Cartesian center,
                                                       double majorAxisRadius,
                                                       double minorAxisRadius,
                                                       double bearing)

Computes boundary positions for an ellipse on the specified centralBody This is equivalent to calling SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double) with a granularity of 1 degree.

See SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the ellipse on.

center - The center of the ellipse, in the centralBody's fixed reference frame.

majorAxisRadius - The radius of the ellipse's major axis, in meters.

minorAxisRadius - The radius of the ellipse's minor axis, in meters.

bearing - An angle, in radians, measured clockwise from north.

Returns:

A SurfaceShapesResult object representing the boundary of the ellipse, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double)

computeEllipseCartographic

public static final SurfaceShapesResult computeEllipseCartographic(CentralBody centralBody,
                                                                   Cartographic center,
                                                                   double majorAxisRadius,
                                                                   double minorAxisRadius,
                                                                   double bearing,
                                                                   double granularity)

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double)

See SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the ellipse on.

center - The center of the ellipse, in the centralBody's fixed reference frame.

majorAxisRadius - The radius of the ellipse's major axis, in meters.

minorAxisRadius - The radius of the ellipse's minor axis, in meters.

bearing - An angle, in radians, measured clockwise from north.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the ellipse, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double)

computeEllipseCartographic

public static final SurfaceShapesResult computeEllipseCartographic(CentralBody centralBody,
                                                                   Cartographic center,
                                                                   double majorAxisRadius,
                                                                   double minorAxisRadius,
                                                                   double bearing)

For convenience. Computes boundary positions for an ellipse on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double)

See SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the ellipse on.

center - The center of the ellipse, in the centralBody's fixed reference frame.

majorAxisRadius - The radius of the ellipse's major axis, in meters.

minorAxisRadius - The radius of the ellipse's minor axis, in meters.

bearing - An angle, in radians, measured clockwise from north.

Returns:

A SurfaceShapesResult object representing the boundary of the ellipse, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeEllipse(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double)

computeSector

public static final SurfaceShapesResult computeSector(CentralBody centralBody,
                                                      Cartesian center,
                                                      double innerRadius,
                                                      double outerRadius,
                                                      double startBearing,
                                                      double endBearing,
                                                      double granularity)

Computes boundary positions for a sector on the specified centralBody.

For most inputs, a sector looks like a slice of a flattened donut. innerRadius and outerRadius are distances from center that define the length of the sector. innerRadius and outerRadius are angles from north that define the angular width of the sector.

The computed positions are at the same altitude as the input center.

Lower granularities are more precise but result in more positions.

Parameters:

centralBody - The central body to compute the sector on.

center - The center of the sector, in the centralBody's fixed reference frame.

innerRadius - The inner radius of the sector, in meters.

outerRadius - The outer radius of the sector, in meters.

startBearing - An angle, in radians, measured clockwise from north indicating the start bearing for the sector.

endBearing - An angle, in radians, measured clockwise from north indicating the end bearing for the sector.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the sector, in the centralBody's fixed reference frame.

Throws:

ArgumentNullException - centralBody is null.

ArgumentOutOfRangeException - innerRadius, outerRadius, and granularity must be greater than zero.

ArgumentException - outerRadius must be greater than innerRadius and endBearing must be greater than startBearing.

See Also:

Triangle Mesh Primitive topic - Surface Shapes

computeSector

public static final SurfaceShapesResult computeSector(CentralBody centralBody,
                                                      Cartesian center,
                                                      double innerRadius,
                                                      double outerRadius,
                                                      double startBearing,
                                                      double endBearing)

Computes boundary positions for a sector on the specified centralBody This is equivalent to calling SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double) with a granularity of 1 degree.

See SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the sector on.

center - The center of the sector, in the centralBody's fixed reference frame.

innerRadius - The inner radius of the sector, in meters.

outerRadius - The outer radius of the sector, in meters.

startBearing - An angle, in radians, measured clockwise from north indicating the start bearing for the sector.

endBearing - An angle, in radians, measured clockwise from north indicating the end bearing for the sector.

Returns:

A SurfaceShapesResult object representing the boundary of the sector, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double,double)

computeSectorCartographic

public static final SurfaceShapesResult computeSectorCartographic(CentralBody centralBody,
                                                                  Cartographic center,
                                                                  double innerRadius,
                                                                  double outerRadius,
                                                                  double startBearing,
                                                                  double endBearing,
                                                                  double granularity)

For convenience. Computes boundary positions for a sector on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double,double)

See SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the sector on.

center - The center of the sector, in the centralBody's fixed reference frame.

innerRadius - The inner radius of the sector, in meters.

outerRadius - The outer radius of the sector, in meters.

startBearing - An angle, in radians, measured clockwise from north indicating the start bearing for the sector.

endBearing - An angle, in radians, measured clockwise from north indicating the end bearing for the sector.

granularity - The angular separation, in radians, of positions along the boundary.

Returns:

A SurfaceShapesResult object representing the boundary of the sector, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double,double)

computeSectorCartographic

public static final SurfaceShapesResult computeSectorCartographic(CentralBody centralBody,
                                                                  Cartographic center,
                                                                  double innerRadius,
                                                                  double outerRadius,
                                                                  double startBearing,
                                                                  double endBearing)

For convenience. Computes boundary positions for a sector on the specified centralBody using a Cartographic center. Longitude and latitude are in radians, and altitude is in meters. This is equivalent to converting center to Cartesian and calling SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double)

See SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double) for a full discussion.

Parameters:

centralBody - The central body to compute the sector on.

center - The center of the sector, in the centralBody's fixed reference frame.

innerRadius - The inner radius of the sector, in meters.

outerRadius - The outer radius of the sector, in meters.

startBearing - An angle, in radians, measured clockwise from north indicating the start bearing for the sector.

endBearing - An angle, in radians, measured clockwise from north indicating the end bearing for the sector.

Returns:

A SurfaceShapesResult object representing the boundary of the sector, in the centralBody's fixed reference frame.

See Also:

SurfaceShapes.computeSector(agi.foundation.celestial.CentralBody,agi.foundation.coordinates.Cartesian,double,double,double,double)