com.io7m.jspatial.implementation

Class QuadTreeI<T>

java.lang.Object

com.io7m.jspatial.implementation.QuadTreeI<T>

Type Parameters:

T - The precise type of tree objects

All Implemented Interfaces:

QuadTreeIType<T>, QuadTreeReadableIType<T>, QuadTreeReadableType

public final class QuadTreeI<T>
extends Object
implements QuadTreeIType<T>

Default implementation of the QuadTreeIType interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	QuadTreeI.Quadrant

Method Summary

Modifier and Type	Method and Description
com.io7m.jregions.core.unparameterized.areas.AreaI	areaFor(T item)
com.io7m.jregions.core.unparameterized.areas.AreaI	bounds()
void	clear() Remove all objects from the tree.
void	containedBy(com.io7m.jregions.core.unparameterized.areas.AreaI area, Set<T> items) Returns all objects in the tree that are completely contained within area, saving the results to items.
boolean	contains(T item) Determine whether or not the object has already been inserted into the tree.
static <T> QuadTreeIType<T>	create(QuadTreeConfigurationI config) Create a new empty tree with the given bounds.
boolean	equals(Object o)
int	hashCode()
boolean	insert(T item, com.io7m.jregions.core.unparameterized.areas.AreaI item_bounds) Insert the object item into the quadtree.
<C> void	iterateQuadrants(C context, QuadTreeQuadrantIterationIType<T,C> f) Iterate over all quadrants within the tree.
<U> QuadTreeIType<U>	map(BiFunction<T,com.io7m.jregions.core.unparameterized.areas.AreaI,U> f) Apply f to each element of the tree.
void	overlappedBy(com.io7m.jregions.core.unparameterized.areas.AreaI area, Set<T> items) Returns all objects in the tree that are overlapped area, saving the results to items.
void	raycast(Ray2D ray, SortedSet<QuadTreeRaycastResultI<T>> items) Returns all objects that are intersected by the given ray.
boolean	remove(T item) Remove the object item from the quadtree.
long	size()
void	trim() Trim all empty quadrants from the tree.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jspatial.api.quadtrees.QuadTreeReadableType

isEmpty

Method Detail

create

public static <T> QuadTreeIType<T> create(QuadTreeConfigurationI config)

Create a new empty tree with the given bounds.

Type Parameters:

T - The type of objects contained within the tree

Parameters:

config - The tree configuration

Returns:

A new tree

trim

public void trim()

Description copied from interface: QuadTreeIType

Trim all empty quadrants from the tree.

Specified by:

trim in interface QuadTreeIType<T>

size

public long size()

Specified by:

size in interface QuadTreeReadableType

Returns:

The number of elements in the tree

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

bounds

public com.io7m.jregions.core.unparameterized.areas.AreaI bounds()

Specified by:

bounds in interface QuadTreeReadableIType<T>

Returns:

The tree bounds

insert

public boolean insert(T item,
                      com.io7m.jregions.core.unparameterized.areas.AreaI item_bounds)

Description copied from interface: QuadTreeIType

Insert the object item into the quadtree.

The function returns false if the object could not be inserted for any reason (perhaps due to being too large).

If the object is already in the tree, it is replaced. This can be used to update the bounds of an object within the tree.

Specified by:

insert in interface QuadTreeIType<T>

Parameters:

item - The object to insert

item_bounds - The object's bounds

Returns:

true if the object was inserted

contains

public boolean contains(T item)

Description copied from interface: QuadTreeReadableIType

Determine whether or not the object has already been inserted into the tree.

Specified by:

contains in interface QuadTreeReadableIType<T>

Parameters:

item - The object

Returns:

true iff the object is in the tree

remove

public boolean remove(T item)

Description copied from interface: QuadTreeIType

Remove the object item from the quadtree.

The function returns false if the object could not be removed for any reason (perhaps due to not being in the tree in the first place).

Specified by:

remove in interface QuadTreeIType<T>

Parameters:

item - The object to remove

Returns:

true if the object was removed

clear

public void clear()

Description copied from interface: QuadTreeIType

Remove all objects from the tree.

Specified by:

clear in interface QuadTreeIType<T>

map

public <U> QuadTreeIType<U> map(BiFunction<T,com.io7m.jregions.core.unparameterized.areas.AreaI,U> f)

Description copied from interface: QuadTreeIType

Apply f to each element of the tree.

Specified by:

map in interface QuadTreeIType<T>

Specified by:

map in interface QuadTreeReadableIType<T>

Type Parameters:

U - The type of result elements

Parameters:

f - A mapping function

Returns:

A new tree

iterateQuadrants

public <C> void iterateQuadrants(C context,
                                 QuadTreeQuadrantIterationIType<T,C> f)

Description copied from interface: QuadTreeReadableIType

Iterate over all quadrants within the tree.

Specified by:

iterateQuadrants in interface QuadTreeReadableIType<T>

Type Parameters:

C - The type of context values

Parameters:

context - A contextual value passed to f

f - An iteration function

areaFor

public com.io7m.jregions.core.unparameterized.areas.AreaI areaFor(T item)

Specified by:

areaFor in interface QuadTreeReadableIType<T>

Parameters:

item - The item

Returns:

The bounding area that was specified for item

containedBy

public void containedBy(com.io7m.jregions.core.unparameterized.areas.AreaI area,
                        Set<T> items)

Description copied from interface: QuadTreeReadableIType

Returns all objects in the tree that are completely contained within area, saving the results to items.

Specified by:

containedBy in interface QuadTreeReadableIType<T>

Parameters:

area - The area to examine

items - The returned items

overlappedBy

public void overlappedBy(com.io7m.jregions.core.unparameterized.areas.AreaI area,
                         Set<T> items)

Description copied from interface: QuadTreeReadableIType

Returns all objects in the tree that are overlapped area, saving the results to items.

Specified by:

overlappedBy in interface QuadTreeReadableIType<T>

Parameters:

area - The area to examine

items - The returned items

raycast

public void raycast(Ray2D ray,
                    SortedSet<QuadTreeRaycastResultI<T>> items)

Description copied from interface: QuadTreeReadableIType

Returns all objects that are intersected by the given ray. The objects are returned in order of distance from the origin of the ray: The first object returned will be the object nearest to the origin.

Specified by:

raycast in interface QuadTreeReadableIType<T>

Parameters:

ray - The ray

items - The intersected items