This interface is used to visit BSP tree nodes.

Navigation through BSP trees can be done using two different point of views:

the first one is in a node-oriented way using the BSPTree#getPlus, BSPTree#getMinus and BSPTree#getParent methods. Terminal nodes without associated sub-hyperplanes can be visited this way, there is no constraint in the visit order, and it is possible to visit either all nodes or only a subset of the nodes
the second one is in a sub-hyperplane-oriented way using classes implementing this interface which obeys the visitor design pattern. The visit order is provided by the visitor as each node is first encountered. Each node is visited exactly once.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	BSPTreeVisitor.Order Enumerate for visit order with respect to plus sub-tree, minus sub-tree and cut sub-hyperplane.

Method Summary

Modifier and Type	Method and Description
public void	visitInternalNode(BSPTree<S> BSP node guaranteed to have a non null cut sub-hyperplane node) Visit a BSP tree node node having a non-null sub-hyperplane.
public void	visitLeafNode(BSPTree<S> leaf BSP node having a null sub-hyperplane node) Visit a leaf BSP tree node node having a null sub-hyperplane.
public BSPTreeVisitor.Order	Returns: desired visit order, must be one of `Order#PLUS_MINUS_SUB`, `Order#PLUS_SUB_MINUS`, `Order#MINUS_PLUS_SUB`, `Order#MINUS_SUB_PLUS`, `Order#SUB_PLUS_MINUS`, `Order#SUB_MINUS_PLUS` visitOrder(BSPTree<S> BSP node guaranteed to have a non null cut sub-hyperplane node) Determine the visit order for this node.

Method Detail

visitInternalNode back to summary

visitInternalNode	back to summary
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. Parameters node:BSPTree<S> BSP node guaranteed to have a non null cut sub-hyperplane See Also `visitLeafNode`

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.

Parameters

node:BSPTree<S>: BSP node guaranteed to have a non null cut sub-hyperplane

See Also

visitLeafNode

visitLeafNode back to summary

visitLeafNode	back to summary
public void visitLeafNode(BSPTree<S> node) Visit a leaf BSP tree node node having a null sub-hyperplane. Parameters node:BSPTree<S> leaf BSP node having a null sub-hyperplane See Also `visitInternalNode`

public void visitLeafNode(BSPTree<S> node)

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

Parameters

node:BSPTree<S>: leaf BSP node having a null sub-hyperplane

See Also

visitInternalNode

visitOrder back to summary

visitOrder	back to summary
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. Parameters node:BSPTree<S> BSP node guaranteed to have a non null cut sub-hyperplane Returns:BSPTreeVisitor.Order desired visit order, must be one of `Order#PLUS_MINUS_SUB`, `Order#PLUS_SUB_MINUS`, `Order#MINUS_PLUS_SUB`, `Order#MINUS_SUB_PLUS`, `Order#SUB_PLUS_MINUS`, `Order#SUB_MINUS_PLUS`

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.

Parameters

node:BSPTree<S>: BSP node guaranteed to have a non null cut sub-hyperplane

Returns:BSPTreeVisitor.Order

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

org.apache.commons.math3.geometry.partitioning back to summary

public final Enum BSPTreeVisitor.Order

Class Inheritance

extends Enum<BSPTreeVisitor.Order>

java.lang.Object
java.lang.Enum
org.apache.commons.math3.geometry.partitioning.BSPTreeVisitor.Order

Enumerate for visit order with respect to plus sub-tree, minus sub-tree and cut sub-hyperplane.

Field Summary

Modifier and Type	Field and Description
public static final BSPTreeVisitor.Order	MINUS_PLUS_SUB Indicator for visit order minus sub-tree, then plus sub-tree, and last cut sub-hyperplane.
public static final BSPTreeVisitor.Order	MINUS_SUB_PLUS Indicator for visit order minus sub-tree, then cut sub-hyperplane, and last plus sub-tree.
public static final BSPTreeVisitor.Order	PLUS_MINUS_SUB Indicator for visit order plus sub-tree, then minus sub-tree, and last cut sub-hyperplane.
public static final BSPTreeVisitor.Order	PLUS_SUB_MINUS Indicator for visit order plus sub-tree, then cut sub-hyperplane, and last minus sub-tree.
public static final BSPTreeVisitor.Order	SUB_MINUS_PLUS Indicator for visit order cut sub-hyperplane, then minus sub-tree, and last plus sub-tree.
public static final BSPTreeVisitor.Order	SUB_PLUS_MINUS Indicator for visit order cut sub-hyperplane, then plus sub-tree, and last minus sub-tree.

Constructor Summary

Access	Constructor and Description
private	Order()

Method Summary

Modifier and Type	Method and Description
public static BSPTreeVisitor.Order	valueOf(String name)
public static BSPTreeVisitor.Order[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MINUS_PLUS_SUB	back to summary
public static final BSPTreeVisitor.Order MINUS_PLUS_SUB Indicator for visit order minus sub-tree, then plus sub-tree, and last cut sub-hyperplane.

MINUS_SUB_PLUS	back to summary
public static final BSPTreeVisitor.Order MINUS_SUB_PLUS Indicator for visit order minus sub-tree, then cut sub-hyperplane, and last plus sub-tree.

PLUS_MINUS_SUB	back to summary
public static final BSPTreeVisitor.Order PLUS_MINUS_SUB Indicator for visit order plus sub-tree, then minus sub-tree, and last cut sub-hyperplane.

PLUS_SUB_MINUS	back to summary
public static final BSPTreeVisitor.Order PLUS_SUB_MINUS Indicator for visit order plus sub-tree, then cut sub-hyperplane, and last minus sub-tree.

SUB_MINUS_PLUS	back to summary
public static final BSPTreeVisitor.Order SUB_MINUS_PLUS Indicator for visit order cut sub-hyperplane, then minus sub-tree, and last plus sub-tree.

SUB_PLUS_MINUS	back to summary
public static final BSPTreeVisitor.Order SUB_PLUS_MINUS Indicator for visit order cut sub-hyperplane, then plus sub-tree, and last minus sub-tree.

Constructor Detail

Order	back to summary
private Order()

Method Detail

valueOf	back to summary
public static BSPTreeVisitor.Order valueOf(String name)

values	back to summary
public static BSPTreeVisitor.Order[] values()

public Interface BSPTreeVisitor<S extends Space>

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum BSPTreeVisitor.Order

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail