agi.foundation.geometry.shapes

(agi.foundation.core-2024r2.jar)

Class EllipsoidRhumbLine

java.lang.Object

agi.foundation.geometry.shapes.EllipsoidSurfaceCurve

agi.foundation.geometry.shapes.EllipsoidRhumbLine

All Implemented Interfaces:

IEquatable<EllipsoidSurfaceCurve>

public class EllipsoidRhumbLine
extends EllipsoidSurfaceCurve

A path of constant heading conforming to the surface of an ellipsoid and connecting two planetodetic surface points.

Constructor Summary

Constructors

Constructor and Description
EllipsoidRhumbLine(Ellipsoid ellipsoid, Cartographic initial, Cartographic _final) Initializes a rhumb line (a line of constant heading) on the ellipsoid connecting the two provided planetodetic points.
EllipsoidRhumbLine(Ellipsoid ellipsoid, Cartographic initial, double heading, double distance) Initializes a rhumb line (a line of constant heading) on the ellipsoid starting at the provided planetodetic point which has the indicated heading at that point and ends at a point located at the provided distance from the starting point.

Method Summary

Modifier and Type	Method and Description
CartographicExtent	computeCartographicExtent() Computes the cartographic bounding box which completely contains the surface curve.
Cartographic	findClosestPointOnCurve(Cartographic point, double[] distance) Finds the closest point on the curve from the input point.
Ellipsoid	getEllipsoid() Gets the ellipsoid on which the rhumb line lies.
Cartographic	getFinalPoint() Gets the final planetodetic point on the path.
double	getHeading() Gets the heading of the rhumb line.
Cartographic	getInitialPoint() Gets the initial planetodetic point on the path.
double	getSurfaceDistance() Gets the total distance along the rhumb line to the location of the final point.
Cartographic	interpolateUsingFraction(double fraction) Provides the location of a point at the indicated portion along the rhumb line.
Cartographic	interpolateUsingSurfaceDistance(double surfaceDistance) Provides the location of a point at the indicated distance along the rhumb line.
Motion1<Cartesian>	surfaceMotion(double distance, double groundSpeed, double groundAcceleration) Converts the motion given in terms of motion on the rhumb line curve to motion of the surface point.

Methods inherited from class agi.foundation.geometry.shapes.EllipsoidSurfaceCurve

computeHashCode, computeIntersection, equals, equalsType, findClosestPointOnCurve, getDiscretePoints, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

EllipsoidRhumbLine

public EllipsoidRhumbLine(@Nonnull
                          Ellipsoid ellipsoid,
                          @Nonnull
                          Cartographic initial,
                          @Nonnull
                          Cartographic _final)

Initializes a rhumb line (a line of constant heading) on the ellipsoid connecting the two provided planetodetic points.

Parameters:

ellipsoid - The ellipsoid on which the rhumb line lies.

initial - The initial planetodetic point on the path. The InitialPoint (get) will be on the ellipsoid surface at this location.

_final - The final planetodetic point on the path. The FinalPoint (get) will be on the ellipsoid surface at this location.

Throws:

ArgumentNullException - Thrown when ellipsoid is null.

UnsupportedCaseException - The scalene case of a rhumb line is not currently modeled and will be in a future release.

EllipsoidRhumbLine

public EllipsoidRhumbLine(@Nonnull
                          Ellipsoid ellipsoid,
                          @Nonnull
                          Cartographic initial,
                          double heading,
                          double distance)

Initializes a rhumb line (a line of constant heading) on the ellipsoid starting at the provided planetodetic point which has the indicated heading at that point and ends at a point located at the provided distance from the starting point.

Parameters:

ellipsoid - The ellipsoid on which the rhumb line lies.

initial - The initial planetodetic point on the path. The InitialPoint (get) will be on the ellipsoid surface at this location.

heading - The heading at the initial point.

distance - The distance along the rhumb line to the location of the final point.

Throws:

ArgumentNullException - Thrown when ellipsoid is null.

UnsupportedCaseException - The scalene case of a rhumb line is not currently modeled and will be in a future release.

Method Detail

getEllipsoid

@Nonnull
public Ellipsoid getEllipsoid()

Gets the ellipsoid on which the rhumb line lies.

Specified by:

getEllipsoid in class EllipsoidSurfaceCurve

getInitialPoint

@Nonnull
public Cartographic getInitialPoint()

Gets the initial planetodetic point on the path.

Specified by:

getInitialPoint in class EllipsoidSurfaceCurve

getFinalPoint

@Nonnull
public Cartographic getFinalPoint()

Gets the final planetodetic point on the path.

Specified by:

getFinalPoint in class EllipsoidSurfaceCurve

getHeading

public final double getHeading()

Gets the heading of the rhumb line.

getSurfaceDistance

public double getSurfaceDistance()

Gets the total distance along the rhumb line to the location of the final point.

Specified by:

getSurfaceDistance in class EllipsoidSurfaceCurve

computeCartographicExtent

public CartographicExtent computeCartographicExtent()

Computes the cartographic bounding box which completely contains the surface curve.

Specified by:

computeCartographicExtent in class EllipsoidSurfaceCurve

Returns:

An object representing the bounding box.

findClosestPointOnCurve

@Nonnull
public Cartographic findClosestPointOnCurve(@Nonnull
                                                      Cartographic point,
                                                      @Nonnull
                                                      double[] distance)

Finds the closest point on the curve from the input point.

The default implementation is a golden section search on the curve. The built-in types (geodesic, rhumb, and complex) have their own precise algorithms.

Overrides:

findClosestPointOnCurve in class EllipsoidSurfaceCurve

Parameters:

point - The input point. The point will be on the ellipsoid surface at this location.

distance - The surface distance between the point and the point on the curve.

Returns:

The closest point on the curve.

interpolateUsingFraction

@Nonnull
public Cartographic interpolateUsingFraction(double fraction)

Provides the location of a point at the indicated portion along the rhumb line.

Specified by:

interpolateUsingFraction in class EllipsoidSurfaceCurve

Parameters:

fraction - The portion of the distance between the initial and final points.

Returns:

The planetodetic location of the point along the rhumb line.

interpolateUsingSurfaceDistance

@Nonnull
public Cartographic interpolateUsingSurfaceDistance(double surfaceDistance)

Provides the location of a point at the indicated distance along the rhumb line.

Specified by:

interpolateUsingSurfaceDistance in class EllipsoidSurfaceCurve

Parameters:

surfaceDistance - The distance from the initial point to the point of interest along the rhumb line.

Returns:

The planetodetic location of the point along the rhumb line.

surfaceMotion

@Nonnull
public final Motion1<Cartesian> surfaceMotion(double distance,
                                                        double groundSpeed,
                                                        double groundAcceleration)

Converts the motion given in terms of motion on the rhumb line curve to motion of the surface point.

Parameters:

distance - The distance from the initial point to the point of interest along the rhumb line.

groundSpeed - The velocity on the rhumb line.

groundAcceleration - The acceleration on the rhumb line.

Returns:

The motion of the surface point.