agi.foundation.geometry.shapes

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

Class EllipsoidSurfaceCurve

java.lang.Object

agi.foundation.geometry.shapes.EllipsoidSurfaceCurve

All Implemented Interfaces:

IEquatable<EllipsoidSurfaceCurve>

Direct Known Subclasses:

EllipsoidComplexSurfaceCurve, EllipsoidGeodesic, EllipsoidRhumbLine

public abstract class EllipsoidSurfaceCurve
extends Object
implements IEquatable<EllipsoidSurfaceCurve>

Represents a curve on the surface of an ellipsoid.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EllipsoidSurfaceCurve() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
abstract CartographicExtent	computeCartographicExtent() Computes the cartographic bounding box which completely contains the surface curve.
protected int	computeHashCode() Computes the hash code for this curve.
EllipsoidSurfaceCurveIntersectionResults	computeIntersection(EllipsoidSurfaceCurve other) Computes the nearest intersection (if any) between two EllipsoidSurfaceCurves.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(EllipsoidSurfaceCurve other) Indicates whether the current object is equal to another object of the same type.
Cartographic	findClosestPointOnCurve(Cartographic point) Finds the closest point on the curve from the input point.
Cartographic	findClosestPointOnCurve(Cartographic point, double[] distance) Finds the closest point on the curve from the input point.
List<Cartographic>	getDiscretePoints(double granularity) Get a set of points which represent the curve discretely based on a given granularity.
abstract Ellipsoid	getEllipsoid() Gets the ellipsoid reference surface on which the curve lies.
abstract Cartographic	getFinalPoint() Gets the final planetodetic point on the path.
abstract Cartographic	getInitialPoint() Gets the initial planetodetic point on the path.
abstract double	getSurfaceDistance() Gets the total distance along the curve to the location of the final point.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
abstract Cartographic	interpolateUsingFraction(double fraction) Provides the location of a point at the indicated portion along the curve.
abstract Cartographic	interpolateUsingSurfaceDistance(double surfaceDistance) Provides the location of a point at the indicated distance along the curve.

Methods inherited from class java.lang.Object

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

Constructor Detail

EllipsoidSurfaceCurve

protected EllipsoidSurfaceCurve()

Initializes a new instance.

Method Detail

getEllipsoid

public abstract Ellipsoid getEllipsoid()

Gets the ellipsoid reference surface on which the curve lies.

getInitialPoint

@Nonnull
public abstract Cartographic getInitialPoint()

Gets the initial planetodetic point on the path.

getFinalPoint

@Nonnull
public abstract Cartographic getFinalPoint()

Gets the final planetodetic point on the path.

getSurfaceDistance

public abstract double getSurfaceDistance()

Gets the total distance along the curve to the location of the final point.

interpolateUsingFraction

@Nonnull
public abstract Cartographic interpolateUsingFraction(double fraction)

Provides the location of a point at the indicated portion along the curve.

Parameters:

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

Returns:

The planetodetic location of the point along the curve.

interpolateUsingSurfaceDistance

@Nonnull
public abstract Cartographic interpolateUsingSurfaceDistance(double surfaceDistance)

Provides the location of a point at the indicated distance along the curve.

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 curve.

computeCartographicExtent

@Nonnull
public abstract CartographicExtent computeCartographicExtent()

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

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.

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.

findClosestPointOnCurve

@Nonnull
public Cartographic findClosestPointOnCurve(@Nonnull
                                                      Cartographic point)

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

Parameters:

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

Returns:

The closest point on the curve.

Throws:

IllegalStateException - Thrown if this curve has any sub curves that are not geodesic, complex, or rhumb.

computeIntersection

@Nonnull
public EllipsoidSurfaceCurveIntersectionResults computeIntersection(@Nullable
                                                                              EllipsoidSurfaceCurve other)

Computes the nearest intersection (if any) between two EllipsoidSurfaceCurves.

Intersection algorithm convergence tolerance is 1 nm.

Parameters:

other - The other curve with which to compute intersection.

Returns:

The point representing the intersection of the two curves.

Throws:

IllegalStateException - Thrown if either this curve or the input curve has any sub curves that are not EllipsoidGeodesic, EllipsoidComplexSurfaceCurve, or EllipsoidRhumbLine.

ArgumentException - Thrown if the Ellipsoid (get) properties of both curves do not match.

getDiscretePoints

@Nonnull
public List<Cartographic> getDiscretePoints(double granularity)

Get a set of points which represent the curve discretely based on a given granularity.

If overriding this method, the set of points should accurately represent the curve using linear segments between points, using the given granularity as a measure of the maximum angular distance between points measured from the center of the Ellipsoid (get).

Parameters:

granularity - The maximum angular distance between the discrete points with respect to the center of the Ellipsoid (get). A small granularity will yield a more precise representation of the curve.

Returns:

A read only list of discrete planetodetic points which can approximate the curve as linear segments.

Throws:

ArgumentOutOfRangeException - The granularity must be positive and non zero.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

computeHashCode

protected int computeHashCode()

Computes the hash code for this curve.

Returns:

The hash code.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public boolean equalsType(EllipsoidSurfaceCurve other)

Description copied from interface: IEquatable

Indicates whether the current object is equal to another object of the same type.

Specified by:

equalsType in interface IEquatable<EllipsoidSurfaceCurve>

Parameters:

other - An object to compare with this object.

Returns:

true if the current object is equal to the other parameter; otherwise, false.