org.mini2Dx.core.quadtree

Class RegionalQuadTree<T extends Parallelogram>

java.lang.Object

org.mini2Dx.core.quadtree.RegionalQuadTree<T>

All Implemented Interfaces:

PositionChangeListener<T>, Quad<T>, QuadTree<T>

public class RegionalQuadTree<T extends Parallelogram>
extends Object
implements QuadTree<T>, Quad<T>

Implements a QuadTree which contains regions. Each region can contain a maximum number of elements before it is subdivided into four regions.

Author:

Thomas Cashman

Constructor Summary

Constructors

Constructor and Description
RegionalQuadTree(float width, float height) Default constructor
RegionalQuadTree(int elementLimitPerRegion, float width, float height) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T object) Adds an element to this Quad
int	getElementLimit() Returns the maximum number of elements per Quad
float	getHeight()
List<T>	getIntersectionsFor(LineSegment line) Returns all elements which intersect a LineSegment
int	getNumberOfElements() Returns the number of elements within this Quad
Quad<T>	getParent() Returns the Quad this Quad is contained in
List<Quad<T>>	getQuadsFor(LineSegment line) Returns all Quads which intersect a LineSegment
List<Quad<T>>	getQuadsFor(T object) Returns all Quads containing an object
List<T>	getValues() Returns all elements within this Quad If this Quad contains child Quads then this will return all elements recursively within the children
float	getWidth()
void	positionChanged(T moved)
void	remove(T object) Removes an element from this Quad

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionalQuadTree

public RegionalQuadTree(float width,
                float height)

Default constructor

Parameters:

width - The width of the tree in pixels

height - The height of the tree in pixels

RegionalQuadTree

public RegionalQuadTree(int elementLimitPerRegion,
                float width,
                float height)

Constructor

Parameters:

elementLimitPerRegion - The maximum number of elements per region before subdivision

width - The width of the tree in pixels

height - The height of the tree in pixels

Method Detail

getQuadsFor

public List<Quad<T>> getQuadsFor(T object)

Returns all Quads containing an object

Parameters:

object - The object to search for

Returns:

An empty List if the object does not exist within this tree

getQuadsFor

public List<Quad<T>> getQuadsFor(LineSegment line)

Returns all Quads which intersect a LineSegment

Parameters:

line - The LineSegment

Returns:

An empty List if the LineSegment does not intersect this tree

getIntersectionsFor

public List<T> getIntersectionsFor(LineSegment line)

Returns all elements which intersect a LineSegment

Parameters:

line - The LineSegment

Returns:

An empty List if the LineSegment does not intersect any elements

add

public void add(T object)

Description copied from interface: Quad

Adds an element to this Quad

Specified by:

add in interface Quad<T extends Parallelogram>

Parameters:

object - The element to be added

remove

public void remove(T object)

Description copied from interface: Quad

Removes an element from this Quad

Specified by:

remove in interface Quad<T extends Parallelogram>

Parameters:

object - The element to be removed

getParent

public Quad<T> getParent()

Description copied from interface: Quad

Returns the Quad this Quad is contained in

Specified by:

getParent in interface Quad<T extends Parallelogram>

Returns:

Null if this is the root Quad

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: Quad

Returns the number of elements within this Quad

Specified by:

getNumberOfElements in interface Quad<T extends Parallelogram>

Returns:

0 if there are no elements within this Quad

getElementLimit

public int getElementLimit()

Description copied from interface: Quad

Returns the maximum number of elements per Quad

Specified by:

getElementLimit in interface Quad<T extends Parallelogram>

Returns:

getWidth

public float getWidth()

getHeight

public float getHeight()

getValues

public List<T> getValues()

Description copied from interface: Quad

Returns all elements within this Quad If this Quad contains child Quads then this will return all elements recursively within the children

Specified by:

getValues in interface Quad<T extends Parallelogram>

Returns:

An empty List if this Quad contains no elements

positionChanged

public void positionChanged(T moved)

Specified by:

positionChanged in interface PositionChangeListener<T extends Parallelogram>