org.apache.commons.geometry.spherical.twod

Class GreatArc

java.lang.Object

org.apache.commons.geometry.spherical.twod.GreatCircleSubset

org.apache.commons.geometry.spherical.twod.GreatArc

All Implemented Interfaces:

Embedding<Point2S,Point1S>, HyperplaneConvexSubset<Point2S>, HyperplaneSubset<Point2S>, Splittable<Point2S,HyperplaneSubset<Point2S>>, RegionEmbedding<Point2S,Point1S>, Sized

public final class GreatArc
extends GreatCircleSubset
implements HyperplaneConvexSubset<Point2S>

Class representing a single, convex angular interval in a GreatCircle. Convex angular intervals are those where the shortest path between all pairs of points in the interval are completely contained in the interval. In the case of paths that tie for the shortest length, it is sufficient that one of the paths is completely contained in the interval. In spherical 2D space, convex arcs either fill the entire great circle or have an angular size of less than or equal to pi radians.

Instances of this class are guaranteed to be immutable.

See Also:

GreatCircles

Method Summary

Modifier and Type	Method and Description
Point2S	getEndPoint() Return the end point of the arc, or null if the arc represents the full space.
AngularInterval.Convex	getInterval() Get the angular interval for the arc.
Point2S	getMidPoint() Return the midpoint of the arc, or null if the arc represents the full space.
Point2S	getStartPoint() Return the start point of the arc, or null if the arc represents the full space.
AngularInterval.Convex	getSubspaceRegion()
GreatArc	reverse()
Split<GreatArc>	split(Hyperplane<Point2S> splitter)
List<GreatArc>	toConvex()
String	toString() Return a string representation of this great arc.
GreatArc	transform(Transform<Point2S> transform)

Methods inherited from class org.apache.commons.geometry.spherical.twod.GreatCircleSubset

classify, closest, getCentroid, getCircle, getHyperplane, getPrecision, getSize, isEmpty, isFull, toSpace, toSubspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.geometry.core.partitioning.HyperplaneSubset

classify, closest, contains, getCentroid, getHyperplane, isEmpty, isFull

Methods inherited from interface org.apache.commons.geometry.core.Sized

getSize, isFinite, isInfinite

Methods inherited from interface org.apache.commons.geometry.core.Embedding

toSpace, toSubspace

Method Detail

getStartPoint

public Point2S getStartPoint()

Return the start point of the arc, or null if the arc represents the full space.

Returns:

the start point of the arc, or null if the arc represents the full space.

getEndPoint

public Point2S getEndPoint()

Return the end point of the arc, or null if the arc represents the full space.

Returns:

the end point of the arc, or null if the arc represents the full space.

getMidPoint

public Point2S getMidPoint()

Return the midpoint of the arc, or null if the arc represents the full space.

Returns:

the midpoint of the arc, or null if the arc represents the full space.

getInterval

public AngularInterval.Convex getInterval()

Get the angular interval for the arc.

Returns:

the angular interval for the arc

See Also:

getSubspaceRegion()

getSubspaceRegion

public AngularInterval.Convex getSubspaceRegion()

Specified by:

getSubspaceRegion in interface RegionEmbedding<Point2S,Point1S>

Specified by:

getSubspaceRegion in class GreatCircleSubset

toConvex

public List<GreatArc> toConvex()

Specified by:

toConvex in interface HyperplaneSubset<Point2S>

Specified by:

toConvex in class GreatCircleSubset

split

public Split<GreatArc> split(Hyperplane<Point2S> splitter)

Specified by:

split in interface HyperplaneConvexSubset<Point2S>

Specified by:

split in interface Splittable<Point2S,HyperplaneSubset<Point2S>>

transform

public GreatArc transform(Transform<Point2S> transform)

Specified by:

transform in interface HyperplaneConvexSubset<Point2S>

Specified by:

transform in interface HyperplaneSubset<Point2S>

reverse

public GreatArc reverse()

Specified by:

reverse in interface HyperplaneConvexSubset<Point2S>

toString

public String toString()

Return a string representation of this great arc.

In order to keep the string representation short but useful, the exact format of the return value depends on the properties of the arc. See below for examples.

• Full arc
  • GreatArc[full= true, circle= GreatCircle[pole= (0.0, 0.0, 1.0), x= (1.0, 0.0, 0.0), y= (0.0, 1.0, 0.0)]
• Non-full arc
  • GreatArc[start= (1.0, 1.5707963267948966), end= (2.0, 1.5707963267948966)

Overrides:

toString in class Object