math.bsp

Class BspTree<TData,TBoundary>

java.lang.Object

math.bsp.BspTree<TData,TBoundary>

Type Parameters:

TData - Data stored in each leaf node

TBoundary - An object that splits the space into two distinct subsets

All Implemented Interfaces:

Serializable, IConstBspTree<TData,TBoundary>

public class BspTree<TData,TBoundary>
extends Object
implements IConstBspTree<TData,TBoundary>, Serializable

Binary space partitioning tree

This is a generic implementation supporting both 2D and 3D spaces (or any other space, even non-euclidean). The TBoundary type parameter and the provided strategy define the space and how it is partitioned. BspTreeND( new BspLinePartitiongStrategy(6), ? ) would define a 2D BSP tree with up to 6 elements per leaf. BspTreeND( new BspPlanePartitiongStrategy(6), ? ) would define a 3D BSP tree with up to 6 elements per leaf.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IBspNode<TData,TBoundary>	root
protected IBspStrategy<TData,TBoundary>	strategy

Constructor Summary

Constructors

Constructor and Description
BspTree(IBspStrategy<TData,TBoundary> strategy) Constructor Creates an empty leaf as root.

Method Summary

Modifier and Type	Method and Description
void	addData(IBspNode<TData,TBoundary> node, TData data) Add data to a particular node Low-level API.
void	addData(TData data) Add data to the tree May cause tree optimization - splitting of nodes.
IConstBspTree<TData,TBoundary>	asConst() Get constant interface
void	clear() Clear tree Remove all data and nodes and create a new empty leaf root.
IBspNode<TData,TBoundary>	getRoot() Get root node
IBspStrategy<TData,TBoundary>	getStrategy() Get strategy
static <TData,TBoundary> BspTree<TData,TBoundary>	make(IBspStrategy<TData,TBoundary> strategy) Make empty tree Shortcut to avoid having to specify type parameters.
static <TData,TBoundary> BspTree<TData,TBoundary>	make(IBspStrategy<TData,TBoundary> strategy, TData data) Make tree with data Shortcut to avoid having to specify type parameters.
BspInternalNode<TData,TBoundary>	makeInternalNode() Make internal node Shortcut to avoid having to specify type parameters.
BspLeafNode<TData,TBoundary>	makeLeafNode() Make leaf node Shortcut to avoid having to specify type parameters.
void	optimize(BspLeafNode<TData,TBoundary> nodeToOptimize) Optimize leaf node Recursively splits data as determined by partitioning strategy to optimize tree performance.
void	removeData(IBspNode<TData,TBoundary> node, TData dataToRemove) Remove data from a particular node Low-level API.
void	removeData(TData dataToRemove) Remove data from the tree
void	replace(IBspNode<TData,TBoundary> oldNode, IBspNode<TData,TBoundary> newNode) Replace old node in the tree by a new node Low-level API.
protected void	setDepthRecursively(IBspNode<TData,TBoundary> node, int depth)
void	setRoot(IBspNode<TData,TBoundary> value) Set the root node Low-level API.

Methods inherited from class java.lang.Object

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

Field Detail

root

protected IBspNode<TData,TBoundary> root

strategy

protected IBspStrategy<TData,TBoundary> strategy

Constructor Detail

BspTree

public BspTree(IBspStrategy<TData,TBoundary> strategy)

Constructor

Creates an empty leaf as root.

Parameters:

strategy - partitioning strategy to use

Method Detail

make

public static <TData,TBoundary> BspTree<TData,TBoundary> make(IBspStrategy<TData,TBoundary> strategy,
                                                              TData data)

Make tree with data

Shortcut to avoid having to specify type parameters.

Parameters:

strategy - strategy to use

data - data to store in the tree,

make

public static <TData,TBoundary> BspTree<TData,TBoundary> make(IBspStrategy<TData,TBoundary> strategy)

Make empty tree

Shortcut to avoid having to specify type parameters.

Parameters:

strategy - splitting strategy to use

asConst

public IConstBspTree<TData,TBoundary> asConst()

Get constant interface

getRoot

public IBspNode<TData,TBoundary> getRoot()

Description copied from interface: IConstBspTree

Get root node

Specified by:

getRoot in interface IConstBspTree<TData,TBoundary>

setRoot

public void setRoot(IBspNode<TData,TBoundary> value)

Set the root node

Low-level API.

getStrategy

public IBspStrategy<TData,TBoundary> getStrategy()

Description copied from interface: IConstBspTree

Get strategy

Specified by:

getStrategy in interface IConstBspTree<TData,TBoundary>

addData

public void addData(TData data)

Add data to the tree

May cause tree optimization - splitting of nodes.

Parameters:

data - data to add, may be null, which would result in no op

addData

public void addData(IBspNode<TData,TBoundary> node,
                    TData data)

Add data to a particular node

Low-level API.

Caution: If the data spans multiple nodes, it must be added to all such nodes otherwise tree will become corrupted. May cause tree optimization - splitting of nodes.

Parameters:

node - node to which data should be added

data - data to add, may be null, which would result in no op

removeData

public void removeData(TData dataToRemove)

Remove data from the tree

Parameters:

dataToRemove - data to remove

removeData

public void removeData(IBspNode<TData,TBoundary> node,
                       TData dataToRemove)

Remove data from a particular node

Low-level API.

Caution: If the tree contains a portion of the data in multiple nodes, the data must be removed from all such nodes otherwise the tree will become corrupted.

Parameters:

node - node to remove data from

dataToRemove - data to remove

optimize

public void optimize(BspLeafNode<TData,TBoundary> nodeToOptimize)

Optimize leaf node

Recursively splits data as determined by partitioning strategy to optimize tree performance.

Parameters:

nodeToOptimize - optimized node

makeLeafNode

public BspLeafNode<TData,TBoundary> makeLeafNode()

Make leaf node

Shortcut to avoid having to specify type parameters.

makeInternalNode

public BspInternalNode<TData,TBoundary> makeInternalNode()

Make internal node

Shortcut to avoid having to specify type parameters.

replace

public void replace(IBspNode<TData,TBoundary> oldNode,
                    IBspNode<TData,TBoundary> newNode)

Replace old node in the tree by a new node

Low-level API.

Parameters:

oldNode - node to replace, supports both root and internal nodes and both parent and leaf nodes

newNode - new node to take place of the old node

clear

public void clear()

Clear tree

Remove all data and nodes and create a new empty leaf root.

setDepthRecursively

protected void setDepthRecursively(IBspNode<TData,TBoundary> node,
                                   int depth)