Package org.apache.commons.math3.geometry.spherical.twod

Class EdgesBuilder

java.lang.Object

org.apache.commons.math3.geometry.spherical.twod.EdgesBuilder

All Implemented Interfaces:

BSPTreeVisitor<Sphere2D>

class EdgesBuilder
extends java.lang.Object
implements BSPTreeVisitor<Sphere2D>

Visitor building edges.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.BSPTreeVisitor

BSPTreeVisitor.Order

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<Edge,BSPTree<Sphere2D>>	edgeToNode	Built edges and their associated nodes.
private java.util.Map<BSPTree<Sphere2D>,java.util.List<Edge>>	nodeToEdgesList	Reversed map.
private BSPTree<Sphere2D>	root	Root of the tree.
private double	tolerance	Tolerance below which points are consider to be identical.

Constructor Summary

Constructors

Constructor	Description
EdgesBuilder(BSPTree<Sphere2D> root, double tolerance)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
private void	addContribution(SubCircle sub, boolean reversed, BSPTree<Sphere2D> node)	Add the contribution of a boundary edge.
java.util.List<Edge>	getEdges()	Get the boundary edges.
private Edge	getFollowingEdge(Edge previous)	Get the edge that should naturally follow another one.
void	visitInternalNode(BSPTree<Sphere2D> node)	Visit a BSP tree node node having a non-null sub-hyperplane.
void	visitLeafNode(BSPTree<Sphere2D> node)	Visit a leaf BSP tree node node having a null sub-hyperplane.
BSPTreeVisitor.Order	visitOrder(BSPTree<Sphere2D> node)	Determine the visit order for this node.

Methods inherited from class java.lang.Object

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

Field Detail

root

private final BSPTree<Sphere2D> root

Root of the tree.

tolerance

private final double tolerance

Tolerance below which points are consider to be identical.

edgeToNode

private final java.util.Map<Edge,BSPTree<Sphere2D>> edgeToNode

Built edges and their associated nodes.

nodeToEdgesList

private final java.util.Map<BSPTree<Sphere2D>,java.util.List<Edge>> nodeToEdgesList

Reversed map.

Constructor Detail

EdgesBuilder

EdgesBuilder(BSPTree<Sphere2D> root,
             double tolerance)

Simple constructor.

Parameters:

root - tree root

tolerance - below which points are consider to be identical

Method Detail

visitOrder

public BSPTreeVisitor.Order visitOrder(BSPTree<Sphere2D> node)

Determine the visit order for this node.

Before attempting to visit an internal node, this method is called to determine the desired ordering of the visit. It is guaranteed that this method will be called before visitInternalNode for a given node, it will be called exactly once for each internal node.

Specified by:

visitOrder in interface BSPTreeVisitor<Sphere2D>

Parameters:

node - BSP node guaranteed to have a non null cut sub-hyperplane

Returns:

desired visit order, must be one of BSPTreeVisitor.Order.PLUS_MINUS_SUB, BSPTreeVisitor.Order.PLUS_SUB_MINUS, BSPTreeVisitor.Order.MINUS_PLUS_SUB, BSPTreeVisitor.Order.MINUS_SUB_PLUS, BSPTreeVisitor.Order.SUB_PLUS_MINUS, BSPTreeVisitor.Order.SUB_MINUS_PLUS

visitInternalNode

public void visitInternalNode(BSPTree<Sphere2D> node)

Visit a BSP tree node node having a non-null sub-hyperplane.

It is guaranteed that this method will be called after visitOrder has been called for a given node, it wil be called exactly once for each internal node.

Specified by:

visitInternalNode in interface BSPTreeVisitor<Sphere2D>

Parameters:

node - BSP node guaranteed to have a non null cut sub-hyperplane

See Also:

BSPTreeVisitor.visitLeafNode(org.apache.commons.math3.geometry.partitioning.BSPTree<S>)

visitLeafNode

public void visitLeafNode(BSPTree<Sphere2D> node)

Visit a leaf BSP tree node node having a null sub-hyperplane.

Specified by:

visitLeafNode in interface BSPTreeVisitor<Sphere2D>

Parameters:

node - leaf BSP node having a null sub-hyperplane

See Also:

BSPTreeVisitor.visitInternalNode(org.apache.commons.math3.geometry.partitioning.BSPTree<S>)

addContribution

private void addContribution(SubCircle sub,
                             boolean reversed,
                             BSPTree<Sphere2D> node)

Add the contribution of a boundary edge.

Parameters:

sub - boundary facet

reversed - if true, the facet has the inside on its plus side

node - node to which the edge belongs

getFollowingEdge

private Edge getFollowingEdge(Edge previous)
                       throws MathIllegalStateException

Get the edge that should naturally follow another one.

Parameters:

previous - edge to be continued

Returns:

other edge, starting where the previous one ends (they have not been connected yet)

Throws:

MathIllegalStateException - if there is not a single other edge

getEdges

public java.util.List<Edge> getEdges()
                              throws MathIllegalStateException

Get the boundary edges.

Returns:

boundary edges

Throws:

MathIllegalStateException - if there is not a single other edge