math.bsp.algorithm.raycast

Class BspRayCaster<TData,TBoundary,TRay,TCollision>

java.lang.Object

math.bsp.algorithm.raycast.BspRayCaster<TData,TBoundary,TRay,TCollision>

Type Parameters:

TData - Type of data used by the BSP tree

TBoundary - Type of boundary used by the BSP tree

TRay - Ray data type

TCollision - Data type describing the collisions between ray and data in the BSP tree

All Implemented Interfaces:

Serializable

public abstract class BspRayCaster<TData,TBoundary,TRay,TCollision>
extends Object
implements Serializable

BSP ray caster

Performs ray casting in a BSP tree.

Collisions are ordered by distance if the following conditions hold:

• Iterators provided #getCollisions(Object, Object) return collision ordered by distance.
• BSP tree boundaries separate possible collision to their respective sides.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	doDuplicateCollisionsOccur
IConstBspTree<TData,TBoundary>	tree

Constructor Summary

Constructors

Constructor and Description
BspRayCaster(IConstBspTree<TData,TBoundary> tree, boolean doDuplicateCollisionsOccur) Constructor

Method Summary

Modifier and Type	Method and Description
abstract double	computeSideSignedDistanceSquare(TBoundary boundary, TRay ray) Compute signed square of distance of intersection from ray origin
TCollision	getCollision(TRay ray) Get a collision with the ray
Iterator<TCollision>	getCollisionIterator(TRay ray) Get iterator over all collision with the ray
List<TCollision>	getCollisions(TRay ray) Get all collision with the ray
abstract List<TCollision>	getCollisions(TRay ray, double minDistanceSquare, double maxDistanceSquare, TData data) Get collision list

Methods inherited from class java.lang.Object

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

Field Detail

tree

public final IConstBspTree<TData,TBoundary> tree

doDuplicateCollisionsOccur

public final boolean doDuplicateCollisionsOccur

Constructor Detail

BspRayCaster

public BspRayCaster(IConstBspTree<TData,TBoundary> tree,
                    boolean doDuplicateCollisionsOccur)

Constructor

Parameters:

tree - BSP tree to perform ray casting on.

doDuplicateCollisionsOccur - Whether collisions are unique. Some BSP tree implementations can detect the same collision in multiple leaf data. If this is the case, TCollision should implement suitable Object.hashCode() and Object.equals(Object), so that duplicates can be removed efficiently.

Method Detail

getCollision

public TCollision getCollision(TRay ray)

Get a collision with the ray

Parameters:

ray - ray to cast

Returns:

collision or null if the ray doesn't collide with anything. If collisions are ordered by distance, the nearest collision is returned.

getCollisions

public List<TCollision> getCollisions(TRay ray)

Get all collision with the ray

Parameters:

ray - ray to cast

Returns:

List of collision.

getCollisionIterator

public Iterator<TCollision> getCollisionIterator(TRay ray)

Get iterator over all collision with the ray

Parameters:

ray - ray to cast

Returns:

Iterator over collision. Collisions are computed on demand to save processing time. Modifying the tree or data will result in undefined behavior of the iterator.

computeSideSignedDistanceSquare

public abstract double computeSideSignedDistanceSquare(TBoundary boundary,
                                                       TRay ray)

Compute signed square of distance of intersection from ray origin

Parameters:

boundary - boundary to intersect

ray - ray to intersect

Returns:

signed squared distance of intersection or signed infinity (no intersection), positive for origin on positive side, negative for origin on negative side

getCollisions

public abstract List<TCollision> getCollisions(TRay ray,
                                               double minDistanceSquare,
                                               double maxDistanceSquare,
                                               TData data)

Get collision list

Parameters:

ray - ray to collide with

data - data to search for collisions

minDistanceSquare - square of minimum distance for eligible collision

maxDistanceSquare - square of maximum distance for eligible collision

Returns:

collisions with the data