math.bsp

Interface IBspStrategy<TData,TBoundary>

Type Parameters:

TData -

TPoint -

TBoundary -

public interface IBspStrategy<TData,TBoundary>

Binary space partitioning strategy

Strategy tells BspTree how to partition space/data. For example a 3D tree using planes to partition the space needs to know when to split a leaf node (shouldSplit(IConstBspLeafNode)), what planes should be used (findBoundary(IConstBspLeafNode)) and then how to split the data (splitData(Object, Object)).

Method Summary

Modifier and Type	Method and Description
TBoundary	findBoundary(IConstBspLeafNode<TData,TBoundary> leafNode) Find a boundary to split a leaf node
TData	joinData(TData data1, TData data2) Join data
TData	removeData(TData data, TData dataToRemove) Remove data Required for BspTree.removeData(Object), may throw UnsupportedOperationException if removal is not required.
boolean	shouldSplit(IConstBspLeafNode<TData,TBoundary> leafNode) Whether a leaf node should be split
SplitData<TData>	splitData(TBoundary boundary, TData data) Split data according to a boundary Depending on the nature of the data this can be done multiple ways.

Method Detail

shouldSplit

boolean shouldSplit(IConstBspLeafNode<TData,TBoundary> leafNode)

Whether a leaf node should be split

Parameters:

leafNode - tested leaf node

findBoundary

TBoundary findBoundary(IConstBspLeafNode<TData,TBoundary> leafNode)

Find a boundary to split a leaf node

Parameters:

leafNode - leaf node to split

Returns:

a boundary suitable for splitting the node and its data, or null

splitData

SplitData<TData> splitData(TBoundary boundary,
                           TData data)

Split data according to a boundary

Depending on the nature of the data this can be done multiple ways. For all purposes the sum of partitioned data must be equivalent to the original data and for best results each half should contain only those bits that are relevant to that half.

For example, if the data is composed of elements then elements that span both across the boundary should be included in both the positive and the negative part. Elements that belong to only one side should be added only to the respective side.

Parameters:

boundary - boundary used to split the data

data - data to split

Returns:

split data

joinData

TData joinData(TData data1,
               TData data2)

Join data

Parameters:

data1 - data, ignored if null

data2 - data, ignored if null

Returns:

data comprised of both data1 and data2 joined

removeData

TData removeData(TData data,
                 TData dataToRemove)

Remove data

Required for BspTree.removeData(Object), may throw UnsupportedOperationException if removal is not required.

Parameters:

data - data to remove from

dataToRemove - what to remove

Returns:

data without dataToRemove