agi.foundation.routedesign.advanced

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

Class SurfaceArc

java.lang.Object

agi.foundation.routedesign.advanced.SurfaceArc

public class SurfaceArc
extends Object

A mutable definition for a generic nearly-circular arc on the ellipsoid surface used when configuring procedure surface geometry.

Constructor Summary

Constructors

Constructor and Description
SurfaceArc(Ellipsoid shape, Cartographic center, double radius, ClosedTurnDirection turnDirection) Create a new instance based on the given center point.
SurfaceArc(Ellipsoid shape, Cartographic point, double heading, double radius, ClosedTurnDirection turnDirection) Create a new instance based on the given point and heading.
SurfaceArc(SurfaceArc existingInstance) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
boolean	checkIsInside(Cartographic target) Check whether the given target point lies within the radius of this arc.
double	configureConnection(ConfigurableConnection connection, KindOfTangent tangentBehavior) Given a connection, configure it so that it is tangent to the surface arc.
double	estimateSurfaceDistance() Get an estimate of the surface distance of the result of SurfaceArc.getSegment(double), in meters.
Cartographic	getCenter() Gets the center of the surface arc.
double	getHeadingFromParameter(double arcParameter) Get the heading of the arc at a point specified by the given parameter.
double	getRadius() Gets the turning radius of the arc measured from the Center (get), in meters.
SurfaceSegment	getSegment(double revs) Get the corresponding immutable surface geometry.
double	getStartParameter() Gets a parameter along the closed arc that represents the entry into the arc.
double	getStopParameter() Gets a parameter along the closed arc that represents the exit from the arc.
Cartographic	getSurfacePointFromParameter(double arcParameter) Get the point on the surface along the surface arc at the given parameter.
Ellipsoid	getSurfaceShape() Gets the shape of the surface on which the arc is defined.
ClosedTurnDirection	getTurnDirection() Gets the direction in which the path turns over the surface.
boolean	isSameDefinition(SurfaceArc other) Determines if this arc has the same orientation and parameters as another arc.
void	setStartParameter(double value) Sets a parameter along the closed arc that represents the entry into the arc.
void	setStopParameter(double value) Sets a parameter along the closed arc that represents the exit from the arc.
EllipsoidSurfaceCurve	targetPoint(ConnectionStrategy curve, Cartographic target, KindOfTangent tangentBehavior) Given a target point outside of the arc, find the heading that is tangent to the EllipsoidSurfaceCurve connecting the target point and the arc.

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceArc

public SurfaceArc(Ellipsoid shape,
                  @Nonnull
                  Cartographic point,
                  double heading,
                  double radius,
                  @Nonnull
                  ClosedTurnDirection turnDirection)

Create a new instance based on the given point and heading.

Parameters:

shape - The shape of the surface on which to define the arc.

point - The starting point for the arc.

heading - The initial heading along the arc, in radians.

radius - The turning radius of the arc measured from the center point, in meters.

turnDirection - The direction in which to turn on the surface.

SurfaceArc

public SurfaceArc(Ellipsoid shape,
                  @Nonnull
                  Cartographic center,
                  double radius,
                  @Nonnull
                  ClosedTurnDirection turnDirection)

Create a new instance based on the given center point.

Parameters:

shape - The shape of the surface on which to define the arc.

center - The center point for the arc.

radius - The turning radius of the arc measured from the center, in meters.

turnDirection - The direction in which to turn on the surface.

SurfaceArc

public SurfaceArc(@Nonnull
                  SurfaceArc existingInstance)

Initializes a new instance as a copy of an existing instance.

Parameters:

existingInstance - The existing instance to copy.

Throws:

ArgumentNullException - Thrown when existingInstance is null.

Method Detail

isSameDefinition

public final boolean isSameDefinition(SurfaceArc other)

Determines if this arc has the same orientation and parameters as another arc.

Parameters:

other - The other arc to test.

Returns:

True if the other arc has the same orientation and parameters as this arc.

getCenter

@Nonnull
public final Cartographic getCenter()

Gets the center of the surface arc.

getRadius

public final double getRadius()

Gets the turning radius of the arc measured from the Center (get), in meters.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the shape of the surface on which the arc is defined.

getTurnDirection

@Nonnull
public final ClosedTurnDirection getTurnDirection()

Gets the direction in which the path turns over the surface.

getStartParameter

public double getStartParameter()

Gets a parameter along the closed arc that represents the entry into the arc. The parameterization is used to find tangents to the surface path.

setStartParameter

public void setStartParameter(double value)

Sets a parameter along the closed arc that represents the entry into the arc. The parameterization is used to find tangents to the surface path.

getStopParameter

public double getStopParameter()

Gets a parameter along the closed arc that represents the exit from the arc. The parameterization is used to find tangents to the surface path.

setStopParameter

public void setStopParameter(double value)

Sets a parameter along the closed arc that represents the exit from the arc. The parameterization is used to find tangents to the surface path.

getSegment

@Nonnull
public SurfaceSegment getSegment(double revs)

Get the corresponding immutable surface geometry.

Parameters:

revs - The number of full revolutions to perform around the arc after the StartParameter (get / set) and before leaving at the StopParameter (get / set).

Returns:

The immutable surface geometry.

estimateSurfaceDistance

public final double estimateSurfaceDistance()

Get an estimate of the surface distance of the result of SurfaceArc.getSegment(double), in meters.

Returns:

The estimated surface distance, in meters.

targetPoint

public final EllipsoidSurfaceCurve targetPoint(ConnectionStrategy curve,
                                               @Nonnull
                                               Cartographic target,
                                               @Nonnull
                                               KindOfTangent tangentBehavior)

Given a target point outside of the arc, find the heading that is tangent to the EllipsoidSurfaceCurve connecting the target point and the arc.

Parameters:

curve - The type of curve to use when targeting.

target - The target point outside of the arc radius.

tangentBehavior - Indicates whether the resulting line is leaving the arc or entering it.

Returns:

The EllipsoidSurfaceCurve that is tangent to the arc and the given target point.

checkIsInside

public final boolean checkIsInside(@Nonnull
                                   Cartographic target)

Check whether the given target point lies within the radius of this arc.

Parameters:

target - The target point to check.

Returns:

True if the target point lies inside the radius of this arc.

configureConnection

public final double configureConnection(ConfigurableConnection connection,
                                        @Nonnull
                                        KindOfTangent tangentBehavior)

Given a connection, configure it so that it is tangent to the surface arc.

Parameters:

connection - The connection to configure.

tangentBehavior - Indicates whether the connection is leaving the arc or entering it.

Returns:

True if the configuration was successful. Otherwise, returns false to indicate that the connection is impossible (usually because the other end of the connection lies within the radius of the surface arc).

getSurfacePointFromParameter

@Nonnull
public final Cartographic getSurfacePointFromParameter(double arcParameter)

Get the point on the surface along the surface arc at the given parameter.

Parameters:

arcParameter - The parameter along the surface arc roughly equivalent to an angular measure in radians.

Returns:

The surface point along the arc.

getHeadingFromParameter

public final double getHeadingFromParameter(double arcParameter)

Get the heading of the arc at a point specified by the given parameter.

Parameters:

arcParameter - The parameter along the surface arc roughly equivalent to an angular measure in radians.

Returns:

The heading with respect to north at the specified point along the arc, in radians.