org.andengine.util.adt.spatial.quadtree

Class QuadTree<B extends IBounds,T extends ISpatialItem<B>>

java.lang.Object

org.andengine.util.adt.spatial.quadtree.QuadTree<B,T>

All Implemented Interfaces:

IBounds

Direct Known Subclasses:

FloatQuadTree, IntQuadTree

public abstract class QuadTree<B extends IBounds,T extends ISpatialItem<B>>
extends java.lang.Object
implements IBounds

TODO Make all methods non-synchronized and add a SynchronizedXZYQuadTree subclasses. (c) Zynga 2011

Since:

20:16:01 - 07.10.2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	QuadTree.QuadTreeNode

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LEVEL_MAX_DEFAULT
protected static int	LEVEL_ROOT
protected B	mBounds
protected int	mMaxLevel
protected QuadTree.QuadTreeNode	mRoot

Constructor Summary

Constructors

Modifier	Constructor and Description
	QuadTree(B pBounds)
protected	QuadTree(B pBounds, int pMaxLevel)

Method Summary

Modifier and Type	Method and Description
void	add(T pItem)
void	add(T pItem, B pBounds) Deprecated.
void	addAll(java.util.ArrayList<T> pItems)
void	addAll(java.util.Collection<T> pItems)
void	addAll(T... pItems)
void	callItems(ParameterCallable<T> pParameterCallable)
void	callNodes(ParameterCallable<QuadTree.QuadTreeNode> pParameterCallable)
void	clear()
boolean	containsAny(B pBounds)
boolean	containsAny(B pBounds, IMatcher<T> pMatcher)
B	getBounds()
int	getItemCount()
int	getMaxLevel()
protected abstract QuadTree.QuadTreeNode	getRoot()
protected abstract QuadTree.QuadTreeNode	initRoot(B pBounds)
boolean	isEmpty()
void	move(T pItem, B pBounds) Shorthand for remove(pItem, pBounds) followed by a add(pItem).
void	move(T pItem, B pOldBounds, B pNewBounds) Deprecated.
java.util.ArrayList<T>	query(B pBounds)
java.util.ArrayList<T>	query(B pBounds, IMatcher<T> pMatcher)
<L extends java.util.List<T>> L	query(B pBounds, IMatcher<T> pMatcher, L pResult)
<L extends java.util.List<T>> L	query(B pBounds, L pResult)
<L extends java.util.List<S>,S extends T> L	queryForSubclass(B pBounds, IMatcher<T> pMatcher, L pResult)
boolean	remove(T pItem)
boolean	remove(T pItem, B pBounds)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LEVEL_ROOT

protected static final int LEVEL_ROOT

See Also:

Constant Field Values

LEVEL_MAX_DEFAULT

protected static final int LEVEL_MAX_DEFAULT

See Also:

Constant Field Values

mBounds

protected final B extends IBounds mBounds

mRoot

protected final QuadTree.QuadTreeNode mRoot

mMaxLevel

protected final int mMaxLevel

Constructor Detail

QuadTree

public QuadTree(B pBounds)

QuadTree

protected QuadTree(B pBounds,
                   int pMaxLevel)

Method Detail

initRoot

protected abstract QuadTree.QuadTreeNode initRoot(B pBounds)

getMaxLevel

public int getMaxLevel()

getBounds

public B getBounds()

getRoot

protected abstract QuadTree.QuadTreeNode getRoot()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getItemCount

public int getItemCount()

isEmpty

public boolean isEmpty()

add

public void add(T pItem)

addAll

public void addAll(T... pItems)

addAll

public void addAll(java.util.ArrayList<T> pItems)

addAll

public void addAll(java.util.Collection<T> pItems)

add

@Deprecated
public void add(T pItem,
                            B pBounds)

Deprecated.

move

public void move(T pItem,
                 B pBounds)
          throws AndEngineRuntimeException

Shorthand for remove(pItem, pBounds) followed by a add(pItem).

Parameters:

pItem - to be freshly added.

pBounds - to remove pItem with.

Throws:

AndEngineRuntimeException

move

@Deprecated
public void move(T pItem,
                             B pOldBounds,
                             B pNewBounds)
                      throws AndEngineRuntimeException

Deprecated.

Shorthand for remove(pItem, pOldBounds) followed by a add(pItem, pNewBounds).

Parameters:

pItem - to be freshly added.

pOldBounds - to remove pItem with.

pNewBounds - to add pItem with.

Throws:

AndEngineRuntimeException

remove

public boolean remove(T pItem)

remove

public boolean remove(T pItem,
                      B pBounds)

query

public java.util.ArrayList<T> query(B pBounds)

query

public <L extends java.util.List<T>> L query(B pBounds,
                                             L pResult)

query

public java.util.ArrayList<T> query(B pBounds,
                                    IMatcher<T> pMatcher)

query

public <L extends java.util.List<T>> L query(B pBounds,
                                             IMatcher<T> pMatcher,
                                             L pResult)

queryForSubclass

public <L extends java.util.List<S>,S extends T> L queryForSubclass(B pBounds,
                                                                    IMatcher<T> pMatcher,
                                                                    L pResult)
                                                             throws java.lang.ClassCastException

Parameters:

pBounds -

pMatcher - must only IMatcher#matches(T) when the item is instanceof S, otherwise it will an ClassCastException.

pResult -

Returns:

Throws:

java.lang.ClassCastException - when pMatcher matched an item that was not instanceof S.

containsAny

public boolean containsAny(B pBounds)

containsAny

public boolean containsAny(B pBounds,
                           IMatcher<T> pMatcher)

callItems

public void callItems(ParameterCallable<T> pParameterCallable)

callNodes

public void callNodes(ParameterCallable<QuadTree.QuadTreeNode> pParameterCallable)

clear

public void clear()