Class BoundaryProjector<S extends Space, T extends Space>

java.lang.Object

org.apache.commons.math3.geometry.partitioning.BoundaryProjector<S,T>

Type Parameters:

S - Type of the space.

T - Type of the sub-space.

All Implemented Interfaces:

BSPTreeVisitor<S>

class BoundaryProjector<S extends Space, T extends Space>
extends Object
implements BSPTreeVisitor<S>

Local tree visitor to compute projection on boundary.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface BSPTreeVisitor

BSPTreeVisitor.Order

Field Summary

Fields

Modifier and Type	Field	Description
private BSPTree<S>	leaf	Leaf node closest to the test point.
private double	offset	Current offset.
private final Point<S>	original	Original point.
private Point<S>	projected	Current best projected point.

Constructor Summary

Constructors

Constructor	Description
BoundaryProjector(Point<S> original)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
private void	addRegion(SubHyperplane<S> sub, List<Region<T>> list)	Add a boundary region to a list.
private boolean	belongsToPart(Point<S> point, Hyperplane<S> hyperplane, Region<T> part)	Check if a projected point lies on a boundary part.
private List<Region<T>>	boundaryRegions(BSPTree<S> node)	Extract the regions of the boundary on an internal node.
BoundaryProjection<S>	getProjection()	Get the projection.
private Point<S>	singularProjection(Point<S> point, Hyperplane<S> hyperplane, Region<T> part)	Get the projection to the closest boundary singular point.
void	visitInternalNode(BSPTree<S> node)	Visit a BSP tree node node having a non-null sub-hyperplane.
void	visitLeafNode(BSPTree<S> node)	Visit a leaf BSP tree node node having a null sub-hyperplane.
BSPTreeVisitor.Order	visitOrder(BSPTree<S> node)	Determine the visit order for this node.

Methods inherited from class Object

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

Field Details

original

private final Point<S extends Space> original

Original point.

projected

private Point<S extends Space> projected

Current best projected point.

leaf

private BSPTree<S extends Space> leaf

Leaf node closest to the test point.

offset

private double offset

Current offset.

Constructor Details

BoundaryProjector

BoundaryProjector(Point<S> original)

Simple constructor.

Parameters:

original - original point

Method Details

visitOrder

public BSPTreeVisitor.Order visitOrder(BSPTree<S> 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<S extends Space>

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<S> 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<S extends Space>

Parameters:

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

See Also:

• BSPTreeVisitor.visitLeafNode(BSPTree)

visitLeafNode

public void visitLeafNode(BSPTree<S> node)

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

Specified by:

visitLeafNode in interface BSPTreeVisitor<S extends Space>

Parameters:

node - leaf BSP node having a null sub-hyperplane

See Also:

• BSPTreeVisitor.visitInternalNode(BSPTree)

getProjection

public BoundaryProjection<S> getProjection()

Get the projection.

Returns:

projection

boundaryRegions

private List<Region<T>> boundaryRegions(BSPTree<S> node)

Extract the regions of the boundary on an internal node.

Parameters:

node - internal node

Returns:

regions in the node sub-hyperplane

addRegion

private void addRegion(SubHyperplane<S> sub,
 List<Region<T>> list)

Add a boundary region to a list.

Parameters:

sub - sub-hyperplane defining the region

list - to fill up

belongsToPart

private boolean belongsToPart(Point<S> point,
 Hyperplane<S> hyperplane,
 Region<T> part)

Check if a projected point lies on a boundary part.

Parameters:

point - projected point to check

hyperplane - hyperplane into which the point was projected

part - boundary part

Returns:

true if point lies on the boundary part

singularProjection

private Point<S> singularProjection(Point<S> point,
 Hyperplane<S> hyperplane,
 Region<T> part)

Get the projection to the closest boundary singular point.

Parameters:

point - projected point to check

hyperplane - hyperplane into which the point was projected

part - boundary part

Returns:

projection to a singular point of boundary part (may be null)