agi.foundation.graphics

(agi.foundation.graphics-2025r1.jar)

Class GreatArcInterpolator

java.lang.Object

agi.foundation.graphics.PositionInterpolator

agi.foundation.graphics.GreatArcInterpolator

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class GreatArcInterpolator
extends PositionInterpolator
implements IDisposable

The great arc interpolator computes interpolated positions along a great arc. A great arc is the shortest path between two positions on an ellipsoid.

See Also:

Polyline Primitive topic - Great Arcs

Constructor Summary

Constructors

Constructor and Description
GreatArcInterpolator() Initializes a default great arc interpolator.
GreatArcInterpolator(CentralBody centralBody) Initializes a great arc interpolator with the specified centralBody and a Granularity of 1 degree.
GreatArcInterpolator(CentralBody centralBody, double granularity) Initializes a great arc interpolator with the specified centralBody and granularity.

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
CentralBody	getCentralBody() Gets or sets the central body used when interpolating with Interpolate.
double	getGranularity() Gets or sets the granularity, in radians, used when interpolating with Interpolate.
PolylineType	getPolylineType() Gets the PolylineType of positions returned from Interpolate
BaseCollection<Cartesian>	interpolate(Iterable<Cartesian> positions) Computes a great arc based on the input positions.
void	setCentralBody(CentralBody value) Gets or sets the central body used when interpolating with Interpolate.
void	setGranularity(double value) Gets or sets the granularity, in radians, used when interpolating with Interpolate.

Methods inherited from class agi.foundation.graphics.PositionInterpolator

dispose

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

GreatArcInterpolator

public GreatArcInterpolator()

Initializes a default great arc interpolator. This is equivalent to constructing a great arc interpolator with a CentralBody equal to an instance of EarthCentralBody and a Granularity of 1 degree.

See Also:

GreatArcInterpolator.GreatArcInterpolator(agi.foundation.celestial.CentralBody,double)

GreatArcInterpolator

public GreatArcInterpolator(CentralBody centralBody)

Initializes a great arc interpolator with the specified centralBody and a Granularity of 1 degree.

Parameters:

centralBody - The central body used when interpolating with Interpolate.

Throws:

ArgumentNullException - centralBody is null.

See Also:

GreatArcInterpolator.GreatArcInterpolator(agi.foundation.celestial.CentralBody,double)

GreatArcInterpolator

public GreatArcInterpolator(CentralBody centralBody,
                            double granularity)

Initializes a great arc interpolator with the specified centralBody and granularity.

Parameters:

centralBody - The central body used when interpolating with Interpolate.

granularity - The granularity, in radians, used when interpolating with Interpolate.

Throws:

ArgumentNullException - centralBody is null.

ArgumentOutOfRangeException - granularity must be greater than zero.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class PositionInterpolator

getCentralBody

public final CentralBody getCentralBody()

Gets or sets the central body used when interpolating with Interpolate.

Throws:

ArgumentNullException - The central body must not be null.

setCentralBody

public final void setCentralBody(CentralBody value)

Gets or sets the central body used when interpolating with Interpolate.

Throws:

ArgumentNullException - The central body must not be null.

getGranularity

public final double getGranularity()

Gets or sets the granularity, in radians, used when interpolating with Interpolate. Lower granularities are more precise but create more positions.

Throws:

ArgumentOutOfRangeException - The granularity must be greater than zero.

See Also:

Polyline Primitive topic - Interpolator Granularity

setGranularity

public final void setGranularity(double value)

Gets or sets the granularity, in radians, used when interpolating with Interpolate. Lower granularities are more precise but create more positions.

Throws:

ArgumentOutOfRangeException - The granularity must be greater than zero.

See Also:

Polyline Primitive topic - Interpolator Granularity

interpolate

public BaseCollection<Cartesian> interpolate(Iterable<Cartesian> positions)

Computes a great arc based on the input positions.

Overrides:

interpolate in class PositionInterpolator

Parameters:

positions - Positions along the great arc to use for interpolation.

Returns:

A great arc computed from the input positions with the specified CentralBody and Granularity.

Throws:

ArgumentNullException - positions is null.

See Also:

CentralBody, Granularity

getPolylineType

public PolylineType getPolylineType()

Description copied from class: PositionInterpolator

Gets the PolylineType of positions returned from Interpolate

Overrides:

getPolylineType in class PositionInterpolator

See Also:

Interpolate