org.apache.commons.geometry.spherical.twod

Class ConvexArea2S

java.lang.Object

org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion<Point2S,GreatArc>

org.apache.commons.geometry.spherical.twod.ConvexArea2S

All Implemented Interfaces:

BoundarySource<GreatArc>, HyperplaneBoundedRegion<Point2S>, Splittable<Point2S,HyperplaneBoundedRegion<Point2S>>, Region<Point2S>, Sized, BoundarySource2S

public final class ConvexArea2S
extends AbstractConvexHyperplaneBoundedRegion<Point2S,GreatArc>
implements BoundarySource2S

Class representing a convex area in 2D spherical space. The boundaries of this area, if any, are composed of convex great circle arcs.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion

AbstractConvexHyperplaneBoundedRegion.ConvexRegionBoundaryBuilder<P extends Point<P>,S extends HyperplaneConvexSubset<P>>

Method Summary

Modifier and Type	Method and Description
Stream<GreatArc>	boundaryStream()
static ConvexArea2S	fromBounds(GreatCircle... bounds) Create a convex area formed by the intersection of the negative half-spaces of the given bounding great circles.
static ConvexArea2S	fromBounds(Iterable<GreatCircle> bounds) Create a convex area formed by the intersection of the negative half-spaces of the given bounding great circles.
static ConvexArea2S	fromPath(GreatArcPath path) Construct a convex area from an arc path.
static ConvexArea2S	fromVertexLoop(Collection<Point2S> vertices, Precision.DoubleEquivalence precision) Construct a convex area by creating great circles between adjacent vertices.
static ConvexArea2S	fromVertices(Collection<Point2S> vertices, boolean close, Precision.DoubleEquivalence precision) Construct a convex area from great circles between adjacent vertices.
static ConvexArea2S	fromVertices(Collection<Point2S> vertices, Precision.DoubleEquivalence precision) Construct a convex area by creating great circles between adjacent vertices.
static ConvexArea2S	full() Return an instance representing the full spherical 2D space.
GreatArcPath	getBoundaryPath() Get a path instance representing the boundary of the area.
Point2S	getCentroid()
double[]	getInteriorAngles() Get an array of interior angles for the area.
double	getSize()
Split<ConvexArea2S>	split(Hyperplane<Point2S> splitter)
RegionBSPTree2S	toTree() Return a BSP tree representing the same region as this instance.
ConvexArea2S	transform(Transform<Point2S> transform) Return a new instance transformed by the argument.
GreatArc	trim(HyperplaneConvexSubset<Point2S> sub)

Methods inherited from class org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion

classify, getBoundaries, getBoundarySize, isEmpty, isFull, project, splitInternal, swapsInsideOutside, toString, transformInternal

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.spherical.twod.BoundarySource2S

of, of, toList

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

contains

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

isFinite, isInfinite

Method Detail

boundaryStream

public Stream<GreatArc> boundaryStream()

Specified by:

boundaryStream in interface BoundarySource<GreatArc>

getBoundaryPath

public GreatArcPath getBoundaryPath()

Get a path instance representing the boundary of the area. The path is oriented so that the minus sides of the arcs lie on the inside of the area.

Returns:

the boundary path of the area

getInteriorAngles

public double[] getInteriorAngles()

Get an array of interior angles for the area. An empty array is returned if there are no boundary intersections (ie, it has only one boundary or no boundaries at all).

The order of the angles corresponds with the order of the boundaries returned by AbstractConvexHyperplaneBoundedRegion.getBoundaries(): if i is an index into the boundaries list, then angles[i] is the angle between boundaries i and (i+1) % boundariesSize.

Returns:

an array of interior angles for the area

getSize

public double getSize()

Specified by:

getSize in interface Sized

getCentroid

public Point2S getCentroid()

Specified by:

getCentroid in interface Region<Point2S>

split

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

Specified by:

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

toTree

public RegionBSPTree2S toTree()

Return a BSP tree representing the same region as this instance.

Specified by:

toTree in interface BoundarySource2S

Returns:

a BSP tree constructed from the boundaries in this instance

transform

public ConvexArea2S transform(Transform<Point2S> transform)

Return a new instance transformed by the argument.

Parameters:

transform - transform to apply

Returns:

a new instance transformed by the argument

trim

public GreatArc trim(HyperplaneConvexSubset<Point2S> sub)

Overrides:

trim in class AbstractConvexHyperplaneBoundedRegion<Point2S,GreatArc>

full

public static ConvexArea2S full()

Return an instance representing the full spherical 2D space.

Returns:

an instance representing the full spherical 2D space.

fromVertices

public static ConvexArea2S fromVertices(Collection<Point2S> vertices,
                                        Precision.DoubleEquivalence precision)

Construct a convex area by creating great circles between adjacent vertices. The vertices must be given in a counter-clockwise around order the interior of the shape. If the area is intended to be closed, the beginning point must be repeated at the end of the path.

Parameters:

vertices - vertices to use to construct the area

precision - precision context used to create new great circle instances

Returns:

a convex area constructed using great circles between adjacent vertices

See Also:

fromVertexLoop(Collection, Precision.DoubleEquivalence)

fromVertexLoop

public static ConvexArea2S fromVertexLoop(Collection<Point2S> vertices,
                                          Precision.DoubleEquivalence precision)

Construct a convex area by creating great circles between adjacent vertices. An implicit great circle is created between the last vertex given and the first one, if needed. The vertices must be given in a counter-clockwise around order the interior of the shape.

Parameters:

vertices - vertices to use to construct the area

precision - precision context used to create new great circles instances

Returns:

a convex area constructed using great circles between adjacent vertices

See Also:

fromVertices(Collection, Precision.DoubleEquivalence)

fromVertices

public static ConvexArea2S fromVertices(Collection<Point2S> vertices,
                                        boolean close,
                                        Precision.DoubleEquivalence precision)

Construct a convex area from great circles between adjacent vertices.

Parameters:

vertices - vertices to use to construct the area

close - if true, an additional great circle will be created between the last and first vertex

precision - precision context used to create new great circle instances

Returns:

a convex area constructed using great circles between adjacent vertices

fromPath

public static ConvexArea2S fromPath(GreatArcPath path)

Construct a convex area from an arc path. The area represents the intersection of all of the negative half-spaces of the great circles in the path. The boundaries of the returned area may therefore not match the arcs in the path.

Parameters:

path - path to construct the area from

Returns:

a convex area constructed from the great circles in the given path

fromBounds

public static ConvexArea2S fromBounds(GreatCircle... bounds)

Create a convex area formed by the intersection of the negative half-spaces of the given bounding great circles. The returned instance represents the area that is on the minus side of all of the given circles. Note that this method does not support areas of zero size (ie, infinitely thin areas or points.)

Parameters:

bounds - great circles used to define the convex area

Returns:

a new convex area instance representing the area on the minus side of all of the bounding great circles or an instance representing the full area if no circles are given

Throws:

IllegalArgumentException - if the given set of bounding great circles do not form a convex area, meaning that there is no region that is on the minus side of all of the bounding circles.

fromBounds

public static ConvexArea2S fromBounds(Iterable<GreatCircle> bounds)

Create a convex area formed by the intersection of the negative half-spaces of the given bounding great circles. The returned instance represents the area that is on the minus side of all of the given circles. Note that this method does not support areas of zero size (ie, infinitely thin areas or points.)

Parameters:

bounds - great circles used to define the convex area

Returns:

a new convex area instance representing the area on the minus side of all of the bounding great circles or an instance representing the full area if no circles are given

Throws:

IllegalArgumentException - if the given set of bounding great circles do not form a convex area, meaning that there is no region that is on the minus side of all of the bounding circles.