org.apache.commons.geometry.spherical.twod

Class RegionBSPTree2S

java.lang.Object

org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree<P,N>

org.apache.commons.geometry.core.partitioning.bsp.AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

org.apache.commons.geometry.spherical.twod.RegionBSPTree2S

All Implemented Interfaces:

BoundarySource<GreatArc>, BSPSubtree<Point2S,RegionBSPTree2S.RegionNode2S>, BSPTree<Point2S,RegionBSPTree2S.RegionNode2S>, HyperplaneBoundedRegion<Point2S>, Splittable<Point2S,HyperplaneBoundedRegion<Point2S>>, Region<Point2S>, Sized, BoundarySource2S

public class RegionBSPTree2S
extends AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>
implements BoundarySource2S

BSP tree representing regions in 2D spherical space.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionBSPTree2S.RegionNode2S BSP tree node for two dimensional spherical space.

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

AbstractRegionBSPTree.AbstractRegionNode<P extends Point<P>,N extends AbstractRegionBSPTree.AbstractRegionNode<P,N>>, AbstractRegionBSPTree.BoundaryProjector<P extends Point<P>,N extends AbstractRegionBSPTree.AbstractRegionNode<P,N>>, AbstractRegionBSPTree.RegionSizeProperties<P extends Point<P>>

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

AbstractBSPTree.AbstractNode<P extends Point<P>,N extends AbstractBSPTree.AbstractNode<P,N>>, AbstractBSPTree.SubtreeInitializer<N extends AbstractBSPTree.AbstractNode<?,?>>

Nested classes/interfaces inherited from interface org.apache.commons.geometry.core.partitioning.bsp.BSPTree

BSPTree.FindNodeCutRule, BSPTree.Node<P extends Point<P>,N extends BSPTree.Node<P,N>>

Constructor Summary

Constructors

Constructor and Description
RegionBSPTree2S() Create a new, empty instance.
RegionBSPTree2S(boolean full) Create a new region.

Method Summary

Modifier and Type	Method and Description
Iterable<GreatArc>	boundaries()
Stream<GreatArc>	boundaryStream()
protected AbstractRegionBSPTree.RegionSizeProperties<Point2S>	computeRegionSizeProperties()
RegionBSPTree2S	copy() Return a deep copy of this instance.
protected RegionBSPTree2S.RegionNode2S	createNode()
static RegionBSPTree2S	empty() Return a new, empty BSP tree.
static RegionBSPTree2S	from(Iterable<GreatArc> boundaries) Construct a new tree from the given boundaries.
static RegionBSPTree2S	from(Iterable<GreatArc> boundaries, boolean full) Construct a new tree from the given boundaries.
static RegionBSPTree2S	full() Return a new, full BSP tree.
List<GreatArc>	getBoundaries()
List<GreatArcPath>	getBoundaryPaths() Get the boundary of the region as a list of connected great arc paths.
protected void	invalidate()
Point2S	project(Point2S pt)
Split<RegionBSPTree2S>	split(Hyperplane<Point2S> splitter)
List<ConvexArea2S>	toConvex() Return a list of ConvexArea2Ss representing the same region as this instance.
RegionBSPTree2S	toTree() Return the current instance.

Methods inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractRegionBSPTree

classify, complement, complement, condense, copyNodeProperties, createBoundaryIterable, createBoundaryList, difference, difference, getBoundarySize, getCentroid, getRegionSizeProperties, getSize, getSubtreeInitializer, insert, insert, insert, insert, insert, insert, insert, insert, intersection, intersection, isEmpty, isFull, setEmpty, setFull, split, union, union, xor, xor

Methods inherited from class org.apache.commons.geometry.core.partitioning.bsp.AbstractBSPTree

accept, accept, copy, copyNode, copySubtree, count, cutNode, extract, extractParentPath, findNode, findNode, getRoot, getVersion, height, importSubtree, insert, nodes, removeNodeCut, setNodeCut, setRoot, splitIntoTrees, splitSubtree, swapsInsideOutside, toString, transform, treeString, treeString, trimToNode

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

Methods inherited from interface org.apache.commons.geometry.core.partitioning.bsp.BSPTree

findNode

Constructor Detail

RegionBSPTree2S

public RegionBSPTree2S()

Create a new, empty instance.

RegionBSPTree2S

public RegionBSPTree2S(boolean full)

Create a new region. If full is true, then the region will represent the entire 2-sphere. Otherwise, it will be empty.

Parameters:

full - whether or not the region should contain the entire 2-sphere or be empty

Method Detail

copy

public RegionBSPTree2S copy()

Return a deep copy of this instance.

Returns:

a deep copy of this instance.

See Also:

AbstractBSPTree.copy(org.apache.commons.geometry.core.partitioning.bsp.BSPTree)

boundaries

public Iterable<GreatArc> boundaries()

Overrides:

boundaries in class AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

boundaryStream

public Stream<GreatArc> boundaryStream()

Specified by:

boundaryStream in interface BoundarySource<GreatArc>

getBoundaries

public List<GreatArc> getBoundaries()

Overrides:

getBoundaries in class AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

getBoundaryPaths

public List<GreatArcPath> getBoundaryPaths()

Get the boundary of the region as a list of connected great arc paths. The arcs are oriented such that their minus (left) side lies on the interior of the region.

Returns:

great arc paths representing the region boundary

toConvex

public List<ConvexArea2S> toConvex()

Return a list of ConvexArea2Ss representing the same region as this instance. One convex area is returned for each interior leaf node in the tree.

Returns:

a list of convex areas representing the same region as this instance

split

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

Specified by:

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

project

public Point2S project(Point2S pt)

Specified by:

project in interface Region<Point2S>

Overrides:

project in class AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

toTree

public RegionBSPTree2S toTree()

Return the current instance.

Specified by:

toTree in interface BoundarySource2S

Returns:

a BSP tree constructed from the boundaries in this instance

computeRegionSizeProperties

protected AbstractRegionBSPTree.RegionSizeProperties<Point2S> computeRegionSizeProperties()

Specified by:

computeRegionSizeProperties in class AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

createNode

protected RegionBSPTree2S.RegionNode2S createNode()

Specified by:

createNode in class AbstractBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

invalidate

protected void invalidate()

Overrides:

invalidate in class AbstractRegionBSPTree<Point2S,RegionBSPTree2S.RegionNode2S>

empty

public static RegionBSPTree2S empty()

Return a new, empty BSP tree.

Returns:

a new, empty BSP tree.

full

public static RegionBSPTree2S full()

Return a new, full BSP tree. The returned tree represents the full space.

Returns:

a new, full BSP tree.

from

public static RegionBSPTree2S from(Iterable<GreatArc> boundaries)

Construct a new tree from the given boundaries. If no boundaries are present, the returned tree is empty.

Parameters:

boundaries - boundaries to construct the tree from

Returns:

a new tree instance constructed from the given boundaries

See Also:

from(Iterable, boolean)

from

public static RegionBSPTree2S from(Iterable<GreatArc> boundaries,
                                   boolean full)

Construct a new tree from the given boundaries. If full is true, then the initial tree before boundary insertion contains the entire space. Otherwise, it is empty.

Parameters:

boundaries - boundaries to construct the tree from

full - if true, the initial tree will contain the entire space

Returns:

a new tree instance constructed from the given boundaries