org.mini2Dx.core.collision

Class PointQuadTree<T extends Positionable>

java.lang.Object

org.mini2Dx.core.geom.Shape

org.mini2Dx.core.geom.Rectangle

org.mini2Dx.core.collision.PointQuadTree<T>

All Implemented Interfaces:

CollisionDetection<T>, QuadTree<T>, Positionable, PositionChangeListener<T>, Sizeable, org.mini2Dx.gdx.utils.Disposable

Direct Known Subclasses:

RegionQuadTree

public class PointQuadTree<T extends Positionable>
extends Rectangle
implements QuadTree<T>

Implements a point quadtree

See Also:

Wikipedia: Point Quad Tree

Field Summary

Fields

Modifier and Type	Field and Description
protected PointQuadTree<T>	bottomLeft
protected PointQuadTree<T>	bottomRight
static Color	BOUNDS_COLOR
protected boolean	cleanupRequired
static float	DEFAULT_MINIMUM_QUAD_SIZE
static Color	ELEMENT_COLOR
protected int	elementLimitPerQuad
protected org.mini2Dx.gdx.utils.Array<T>	elements
protected Rectangle	elementsBounds
protected int	mergeWatermark
protected float	minimumQuadHeight
protected float	minimumQuadWidth
protected PointQuadTree<T>	parent
protected org.mini2Dx.gdx.utils.Queue<PointQuadTree<T>>	pool
static Color	QUAD_COLOR
protected PointQuadTree<T>	topLeft
protected PointQuadTree<T>	topRight
protected int	totalElementsCache

Fields inherited from class org.mini2Dx.core.geom.Shape

disposed, geometry, positionChangeListeners, sizeChangeListeners

Constructor Summary

Constructors

Constructor and Description
PointQuadTree(float minimumQuadWidth, float minimumQuadHeight, int elementLimitPerQuad, int mergeWatermark, float x, float y, float width, float height) Constructs a PointQuadTree with a specified minimum quad size, element limit and watermark
PointQuadTree(int elementLimitPerQuad, float x, float y, float width, float height) Constructs a PointQuadTree with a specified element limit and no merging watermark.
PointQuadTree(int elementLimitPerQuad, int mergeWatermark, float x, float y, float width, float height) Constructs a PointQuadTree with a specified element limit and watermark
PointQuadTree(PointQuadTree<T> parent, float x, float y, float width, float height) Constructs a PointQuadTree as a child of another PointQuadTree

Method Summary

Modifier and Type	Method and Description
boolean	add(T element) Adds an element to this QuadTree
void	addAll(org.mini2Dx.gdx.utils.Array<T> elementsToAdd) Adds all element to this QuadTree.
protected boolean	addElement(T element)
protected void	addElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result, Point point)
protected void	addElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result, LineSegment lineSegment)
protected void	addElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area)
protected void	addElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area, boolean allElements)
protected boolean	addElementToChild(T element)
protected PointQuadTree<T>	allocate(PointQuadTree<T> parent, float x, float y, float width, float height)
void	cleanup()
void	clear() Same a CollisionDetection.removeAll(Array) except the results are not stored
protected void	clearTotalElementsCache()
void	debugRender(Graphics g)
protected void	disposeBounds()
int	getElementLimitPerQuad()
org.mini2Dx.gdx.utils.Array<T>	getElements()
void	getElements(org.mini2Dx.gdx.utils.Array<T> result)
void	getElementsContainingArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area, boolean entirelyContained)
void	getElementsContainingArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area, QuadTreeSearchDirection searchDirection, boolean entirelyContained)
org.mini2Dx.gdx.utils.Array<T>	getElementsContainingArea(Shape area, boolean entirelyContained)
org.mini2Dx.gdx.utils.Array<T>	getElementsContainingArea(Shape area, QuadTreeSearchDirection searchDirection, boolean entirelyContained)
void	getElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result, Point point)
void	getElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result, Point point, QuadTreeSearchDirection searchDirection)
org.mini2Dx.gdx.utils.Array<T>	getElementsContainingPoint(Point point)
org.mini2Dx.gdx.utils.Array<T>	getElementsContainingPoint(Point point, QuadTreeSearchDirection searchDirection)
void	getElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result, LineSegment lineSegment)
void	getElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result, LineSegment lineSegment, QuadTreeSearchDirection searchDirection)
org.mini2Dx.gdx.utils.Array<T>	getElementsIntersectingLineSegment(LineSegment lineSegment)
org.mini2Dx.gdx.utils.Array<T>	getElementsIntersectingLineSegment(LineSegment lineSegment, QuadTreeSearchDirection searchDirection)
void	getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area)
void	getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area, boolean allElements)
void	getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result, Shape area, QuadTreeSearchDirection searchDirection)
org.mini2Dx.gdx.utils.Array<T>	getElementsWithinArea(Shape area)
org.mini2Dx.gdx.utils.Array<T>	getElementsWithinArea(Shape area, QuadTreeSearchDirection searchDirection)
void	getElementsWithinAreaIgnoringEdges(org.mini2Dx.gdx.utils.Array<T> result, Shape area)
void	getElementsWithinAreaIgnoringEdges(org.mini2Dx.gdx.utils.Array<T> result, Shape area, QuadTreeSearchDirection searchDirection)
org.mini2Dx.gdx.utils.Array<T>	getElementsWithinAreaIgnoringEdges(Shape area)
org.mini2Dx.gdx.utils.Array<T>	getElementsWithinAreaIgnoringEdges(Shape area, QuadTreeSearchDirection searchDirection)
int	getMergeWatermark()
float	getMinimumQuadHeight()
float	getMinimumQuadWidth()
QuadTree<T>	getParent()
int	getTotalElements()
int	getTotalImmediateElements()
int	getTotalQuads()
boolean	hasChildQuads()
protected void	initBounds()
protected static boolean	intersects(Rectangle tree, LineSegment segment)
protected boolean	isMergable()
protected boolean	isSearchRequired()
protected void	markCleanupRequired()
protected void	merge()
void	positionChanged(T moved)
boolean	remove(T element) Removes an element from this QuadTree
void	removeAll(org.mini2Dx.gdx.utils.Array<T> elementsToRemove) Removes all elements in this QuadTree and stores them in an Array
protected boolean	removeElement(T element, boolean clearQuadRef)
protected boolean	removeElementFromChild(T element)
protected void	subdivide()
protected boolean	updateBounds()
protected boolean	updateBounds(T element)
void	warmupPool(int poolSize)
void	warmupPool(int poolSize, int expectedElementsPerQuad)
void	warmupWithDepth(int depth)
void	warmupWithObjects(org.mini2Dx.gdx.utils.Array<T> elements)

Methods inherited from class org.mini2Dx.core.geom.Rectangle

contains, contains, contains, contains, contains, copy, dispose, draw, edgeIterator, equals, fill, getCenterX, getCenterY, getDistanceTo, getHeight, getMaxX, getMaxY, getMinX, getMinY, getNumberOfSides, getPolygon, getRotation, getVertices, getWidth, getX, getY, hashCode, intersection, intersects, intersects, intersects, intersects, intersects, intersects, intersectsIgnoringEdges, intersectsLineSegment, intersectsLineSegment, isCircle, lerp, lerp, lerp, rotate, rotateAround, scale, set, set, setCenter, setCenterX, setCenterY, setHeight, setRadius, setRotation, setRotationAround, setSize, setSize, setWidth, setX, setXY, setXY, setY, toString, translate

Methods inherited from class org.mini2Dx.core.geom.Shape

add, addPostionChangeListener, addSizeChangeListener, clearPositionChangeListeners, clearPositionListeners, clearPositionListeners, clearSizeChangeListeners, clearSizeListeners, clearSizeListeners, getDistanceTo, intersects, moveTowards, moveTowards, notifyPositionChangeListeners, notifyPositionListeners, notifyPositionListeners, notifySizeChangeListeners, notifySizeListeners, notifySizeListeners, removePositionChangeListener, removePositionListener, removePositionListener, removeSizeChangeListener, removeSizeListener, removeSizeListener, setDisposed, setRotationAround, subtract

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MINIMUM_QUAD_SIZE

public static float DEFAULT_MINIMUM_QUAD_SIZE

QUAD_COLOR

public static Color QUAD_COLOR

BOUNDS_COLOR

public static Color BOUNDS_COLOR

ELEMENT_COLOR

public static Color ELEMENT_COLOR

pool

protected org.mini2Dx.gdx.utils.Queue<PointQuadTree<T extends Positionable>> pool

parent

protected PointQuadTree<T extends Positionable> parent

topLeft

protected PointQuadTree<T extends Positionable> topLeft

topRight

protected PointQuadTree<T extends Positionable> topRight

bottomLeft

protected PointQuadTree<T extends Positionable> bottomLeft

bottomRight

protected PointQuadTree<T extends Positionable> bottomRight

elementsBounds

protected Rectangle elementsBounds

elements

protected org.mini2Dx.gdx.utils.Array<T extends Positionable> elements

elementLimitPerQuad

protected final int elementLimitPerQuad

mergeWatermark

protected final int mergeWatermark

minimumQuadWidth

protected final float minimumQuadWidth

minimumQuadHeight

protected final float minimumQuadHeight

totalElementsCache

protected int totalElementsCache

cleanupRequired

protected boolean cleanupRequired

Constructor Detail

PointQuadTree

public PointQuadTree(int elementLimitPerQuad,
                     int mergeWatermark,
                     float x,
                     float y,
                     float width,
                     float height)

Constructs a PointQuadTree with a specified element limit and watermark

Parameters:

elementLimitPerQuad - The maximum number of elements in a quad before it is split into 4 child PointQuadTrees

mergeWatermark - When a parent PointQuadTree's total elements go lower than this mark, the child PointQuadTrees will be merged back together

x - The x coordinate of the PointQuadTree

y - The y coordiante of the PointQuadTree

width - The width of the PointQuadTree

height - The height of the PointQuadTree

PointQuadTree

public PointQuadTree(int elementLimitPerQuad,
                     float x,
                     float y,
                     float width,
                     float height)

Constructs a PointQuadTree with a specified element limit and no merging watermark. As elements are removed, small sized child PointQuadTrees will not be merged back together.

Parameters:

elementLimitPerQuad - The maximum number of elements in a quad before it is split into 4 child PointQuadTrees

x - The x coordinate of the PointQuadTree

y - The y coordiante of the PointQuadTree

width - The width of the PointQuadTree

height - The height of the PointQuadTree

PointQuadTree

public PointQuadTree(PointQuadTree<T> parent,
                     float x,
                     float y,
                     float width,
                     float height)

Constructs a PointQuadTree as a child of another PointQuadTree

Parameters:

parent - The parent PointQuadTree

x - The x coordinate of the PointQuadTree

y - The y coordiante of the PointQuadTree

width - The width of the PointQuadTree

height - The height of the PointQuadTree

PointQuadTree

public PointQuadTree(float minimumQuadWidth,
                     float minimumQuadHeight,
                     int elementLimitPerQuad,
                     int mergeWatermark,
                     float x,
                     float y,
                     float width,
                     float height)

Constructs a PointQuadTree with a specified minimum quad size, element limit and watermark

Parameters:

minimumQuadWidth - The minimum width of quads. Quads will not subdivide smaller than this width.

minimumQuadHeight - The minimum height of quads. Quads will not subdivide smaller than this height.

elementLimitPerQuad - The maximum number of elements in a quad before it is split into 4 child PointQuadTrees

mergeWatermark - When a parent PointQuadTree's total elements go lower than this mark, the child PointQuadTrees will be merged back together

x - The x coordinate of the PointQuadTree

y - The y coordiante of the PointQuadTree

width - The width of the PointQuadTree

height - The height of the PointQuadTree

Method Detail

cleanup

public void cleanup()

markCleanupRequired

protected void markCleanupRequired()

warmupWithDepth

public void warmupWithDepth(int depth)

warmupWithObjects

public void warmupWithObjects(org.mini2Dx.gdx.utils.Array<T> elements)

warmupPool

public void warmupPool(int poolSize)

warmupPool

public void warmupPool(int poolSize,
                       int expectedElementsPerQuad)

debugRender

public void debugRender(Graphics g)

Specified by:

debugRender in interface CollisionDetection<T extends Positionable>

addAll

public void addAll(org.mini2Dx.gdx.utils.Array<T> elementsToAdd)

Description copied from interface: CollisionDetection

Adds all element to this QuadTree. Note that if an element exists outside of this QuadTree's bounds, it will not be added

Specified by:

addAll in interface CollisionDetection<T extends Positionable>

Parameters:

elementsToAdd - The elements to add

add

public boolean add(T element)

Description copied from interface: CollisionDetection

Adds an element to this QuadTree

Specified by:

add in interface CollisionDetection<T extends Positionable>

Parameters:

element - The element to add

Returns:

False if the element exists outside of this QuadTree's bounds and was not added

addElement

protected boolean addElement(T element)

initBounds

protected void initBounds()

disposeBounds

protected void disposeBounds()

updateBounds

protected boolean updateBounds(T element)

updateBounds

protected boolean updateBounds()

addElementToChild

protected boolean addElementToChild(T element)

subdivide

protected void subdivide()

allocate

protected PointQuadTree<T> allocate(PointQuadTree<T> parent,
                                    float x,
                                    float y,
                                    float width,
                                    float height)

isMergable

protected boolean isMergable()

merge

protected void merge()

removeAll

public void removeAll(org.mini2Dx.gdx.utils.Array<T> elementsToRemove)

Description copied from interface: CollisionDetection

Removes all elements in this QuadTree and stores them in an Array

Specified by:

removeAll in interface CollisionDetection<T extends Positionable>

Parameters:

elementsToRemove - After executing, this Array will contain all the removed elements

remove

public boolean remove(T element)

Description copied from interface: CollisionDetection

Removes an element from this QuadTree

Specified by:

remove in interface CollisionDetection<T extends Positionable>

Parameters:

element - The element to remove

Returns:

True if the element was found and removed

clear

public void clear()

Description copied from interface: CollisionDetection

Same a CollisionDetection.removeAll(Array) except the results are not stored

Specified by:

clear in interface CollisionDetection<T extends Positionable>

removeElementFromChild

protected boolean removeElementFromChild(T element)

removeElement

protected boolean removeElement(T element,
                                boolean clearQuadRef)

getElementsWithinArea

public org.mini2Dx.gdx.utils.Array<T> getElementsWithinArea(Shape area)

Specified by:

getElementsWithinArea in interface CollisionDetection<T extends Positionable>

getElementsWithinArea

public org.mini2Dx.gdx.utils.Array<T> getElementsWithinArea(Shape area,
                                                            QuadTreeSearchDirection searchDirection)

Specified by:

getElementsWithinArea in interface QuadTree<T extends Positionable>

addElementsWithinArea

protected void addElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result,
                                     Shape area)

addElementsWithinArea

protected void addElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result,
                                     Shape area,
                                     boolean allElements)

getElementsWithinArea

public void getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result,
                                  Shape area)

Specified by:

getElementsWithinArea in interface CollisionDetection<T extends Positionable>

getElementsWithinArea

public void getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result,
                                  Shape area,
                                  boolean allElements)

getElementsWithinArea

public void getElementsWithinArea(org.mini2Dx.gdx.utils.Array<T> result,
                                  Shape area,
                                  QuadTreeSearchDirection searchDirection)

Specified by:

getElementsWithinArea in interface QuadTree<T extends Positionable>

getElementsWithinAreaIgnoringEdges

public org.mini2Dx.gdx.utils.Array<T> getElementsWithinAreaIgnoringEdges(Shape area)

Specified by:

getElementsWithinAreaIgnoringEdges in interface CollisionDetection<T extends Positionable>

getElementsWithinAreaIgnoringEdges

public org.mini2Dx.gdx.utils.Array<T> getElementsWithinAreaIgnoringEdges(Shape area,
                                                                         QuadTreeSearchDirection searchDirection)

Specified by:

getElementsWithinAreaIgnoringEdges in interface QuadTree<T extends Positionable>

getElementsWithinAreaIgnoringEdges

public void getElementsWithinAreaIgnoringEdges(org.mini2Dx.gdx.utils.Array<T> result,
                                               Shape area)

Specified by:

getElementsWithinAreaIgnoringEdges in interface CollisionDetection<T extends Positionable>

getElementsWithinAreaIgnoringEdges

public void getElementsWithinAreaIgnoringEdges(org.mini2Dx.gdx.utils.Array<T> result,
                                               Shape area,
                                               QuadTreeSearchDirection searchDirection)

Specified by:

getElementsWithinAreaIgnoringEdges in interface QuadTree<T extends Positionable>

getElementsContainingArea

public org.mini2Dx.gdx.utils.Array<T> getElementsContainingArea(Shape area,
                                                                boolean entirelyContained)

Specified by:

getElementsContainingArea in interface CollisionDetection<T extends Positionable>

getElementsContainingArea

public org.mini2Dx.gdx.utils.Array<T> getElementsContainingArea(Shape area,
                                                                QuadTreeSearchDirection searchDirection,
                                                                boolean entirelyContained)

Specified by:

getElementsContainingArea in interface QuadTree<T extends Positionable>

getElementsContainingArea

public void getElementsContainingArea(org.mini2Dx.gdx.utils.Array<T> result,
                                      Shape area,
                                      boolean entirelyContained)

Specified by:

getElementsContainingArea in interface CollisionDetection<T extends Positionable>

getElementsContainingArea

public void getElementsContainingArea(org.mini2Dx.gdx.utils.Array<T> result,
                                      Shape area,
                                      QuadTreeSearchDirection searchDirection,
                                      boolean entirelyContained)

Specified by:

getElementsContainingArea in interface QuadTree<T extends Positionable>

getElementsContainingPoint

public org.mini2Dx.gdx.utils.Array<T> getElementsContainingPoint(Point point)

Specified by:

getElementsContainingPoint in interface CollisionDetection<T extends Positionable>

getElementsContainingPoint

public org.mini2Dx.gdx.utils.Array<T> getElementsContainingPoint(Point point,
                                                                 QuadTreeSearchDirection searchDirection)

Specified by:

getElementsContainingPoint in interface QuadTree<T extends Positionable>

addElementsContainingPoint

protected void addElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result,
                                          Point point)

getElementsContainingPoint

public void getElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result,
                                       Point point)

Specified by:

getElementsContainingPoint in interface CollisionDetection<T extends Positionable>

getElementsContainingPoint

public void getElementsContainingPoint(org.mini2Dx.gdx.utils.Array<T> result,
                                       Point point,
                                       QuadTreeSearchDirection searchDirection)

Specified by:

getElementsContainingPoint in interface QuadTree<T extends Positionable>

getElementsIntersectingLineSegment

public org.mini2Dx.gdx.utils.Array<T> getElementsIntersectingLineSegment(LineSegment lineSegment)

Specified by:

getElementsIntersectingLineSegment in interface CollisionDetection<T extends Positionable>

getElementsIntersectingLineSegment

public org.mini2Dx.gdx.utils.Array<T> getElementsIntersectingLineSegment(LineSegment lineSegment,
                                                                         QuadTreeSearchDirection searchDirection)

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends Positionable>

addElementsIntersectingLineSegment

protected void addElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result,
                                                  LineSegment lineSegment)

intersects

protected static boolean intersects(Rectangle tree,
                                    LineSegment segment)

getElementsIntersectingLineSegment

public void getElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result,
                                               LineSegment lineSegment)

Specified by:

getElementsIntersectingLineSegment in interface CollisionDetection<T extends Positionable>

getElementsIntersectingLineSegment

public void getElementsIntersectingLineSegment(org.mini2Dx.gdx.utils.Array<T> result,
                                               LineSegment lineSegment,
                                               QuadTreeSearchDirection searchDirection)

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends Positionable>

getElements

public org.mini2Dx.gdx.utils.Array<T> getElements()

Specified by:

getElements in interface CollisionDetection<T extends Positionable>

getElements

public void getElements(org.mini2Dx.gdx.utils.Array<T> result)

Specified by:

getElements in interface CollisionDetection<T extends Positionable>

getTotalQuads

public int getTotalQuads()

Specified by:

getTotalQuads in interface QuadTree<T extends Positionable>

getTotalElements

public int getTotalElements()

Specified by:

getTotalElements in interface CollisionDetection<T extends Positionable>

getTotalImmediateElements

public int getTotalImmediateElements()

clearTotalElementsCache

protected void clearTotalElementsCache()

positionChanged

public void positionChanged(T moved)

Specified by:

positionChanged in interface PositionChangeListener<T extends Positionable>

isSearchRequired

protected boolean isSearchRequired()

getParent

public QuadTree<T> getParent()

Specified by:

getParent in interface QuadTree<T extends Positionable>

getElementLimitPerQuad

public int getElementLimitPerQuad()

getMergeWatermark

public int getMergeWatermark()

hasChildQuads

public boolean hasChildQuads()

getMinimumQuadWidth

public float getMinimumQuadWidth()

Specified by:

getMinimumQuadWidth in interface QuadTree<T extends Positionable>

getMinimumQuadHeight

public float getMinimumQuadHeight()

Specified by:

getMinimumQuadHeight in interface QuadTree<T extends Positionable>