org.mini2Dx.core.quadtree

Interface Quad<T extends Positionable>

All Superinterfaces:

PositionChangeListener<T>

All Known Subinterfaces:

QuadTree<T>

All Known Implementing Classes:

RegionalQuad, RegionalQuadTree

public interface Quad<T extends Positionable>
extends PositionChangeListener<T>

A common interface to Quad implementations within a QuadTree implementation

Author:

Thomas Cashman

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
int	getNumberOfElements() Returns the number of elements within this Quad
Quad<T>	getParent() Returns the Quad this Quad is contained in
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
void	remove(T object) Removes an element from this Quad

Methods inherited from interface org.mini2Dx.core.engine.PositionChangeListener

positionChanged

Method Detail

getValues

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

Returns:

An empty List if this Quad contains no elements

getElementLimit

int getElementLimit()

Returns the maximum number of elements per Quad

Returns:

getNumberOfElements

int getNumberOfElements()

Returns the number of elements within this Quad

Returns:

0 if there are no elements within this Quad

getParent

Quad<T> getParent()

Returns the Quad this Quad is contained in

Returns:

Null if this is the root Quad

add

void add(T object)

Adds an element to this Quad

Parameters:

object - The element to be added

remove

void remove(T object)

Removes an element from this Quad

Parameters:

object - The element to be removed