org.mini2Dx.core.collision

Class GridRegionQuadTree<T extends Sizeable>

java.lang.Object

org.mini2Dx.core.geom.Shape

org.mini2Dx.core.geom.Rectangle

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

All Implemented Interfaces:

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

public class GridRegionQuadTree<T extends Sizeable>
extends Rectangle
implements QuadTree<T>

Combines a grid with a region quadtree to improve performance in massive world scenarios.

See Also:

Wikipedia: Region Quad Tree

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cellHeight
protected int	cellWidth
static float	DEFAULT_MINIMUM_QUAD_SIZE
protected java.util.BitSet	dirtyCells
static Color	ELEMENT_COLOR
protected int	gridWorldX
protected int	gridWorldY
protected float	invCellHeight
protected float	invCellWidth
protected GridRegionQuadTreeLooseCell[]	looseGrid
protected float	minimumQuadHeight
protected float	minimumQuadWidth
protected org.mini2Dx.gdx.utils.Queue<RegionQuadTree<T>>	pool
static Color	QUAD_COLOR
protected GridRegionQuadTreeTightCell[]	tightGrid
protected int	totalCellsX
protected int	totalElementsCache

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

disposed, geometry, positionChangeListeners, sizeChangeListeners

Constructor Summary

Constructors

Constructor and Description
GridRegionQuadTree(float minimumQuadWidth, float minimumQuadHeight, int elementLimitPerQuad, int x, int y, int width, int height, int gridCellWidth, int gridCellHeight)
GridRegionQuadTree(int elementLimitPerQuad, int x, int y, int width, int height, int gridCellWidth, int gridCellHeight)

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> elements) Adds all element to this QuadTree.
void	cleanup()
void	clear() Same a CollisionDetection.removeAll(Array) except the results are not stored
void	debugRender(Graphics g)
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, 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)
protected int	getGridIndex(float x, float y)
GridRegionQuadTreeLooseCell<T>	getLooseCell(float x, float y)
GridRegionQuadTreeLooseCell<T>	getLooseCell(T element)
int	getMaxGridIndex(T element)
int	getMinGridIndex(T element)
float	getMinimumQuadHeight()
float	getMinimumQuadWidth()
QuadTree<T>	getParent()
GridRegionQuadTreeTightCell<T>	getTightCell(float x, float y)
GridRegionQuadTreeTightCell<T>	getTightCell(int index)
GridRegionQuadTreeTightCell<T>	getTightCell(T element)
int	getTotalElements()
int	getTotalQuads()
void	positionChanged(T moved)
boolean	remove(T element) Removes an element from this QuadTree
void	removeAll(org.mini2Dx.gdx.utils.Array<T> elements) Removes all elements in this QuadTree and stores them in an Array
protected boolean	removeElement(T element, boolean clearQuadRef)
void	warmupPool(int poolSize)
void	warmupPool(int poolSize, int expectedElementsPerQuad)

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 final float DEFAULT_MINIMUM_QUAD_SIZE

See Also:

Constant Field Values

QUAD_COLOR

public static Color QUAD_COLOR

ELEMENT_COLOR

public static Color ELEMENT_COLOR

looseGrid

protected final GridRegionQuadTreeLooseCell[] looseGrid

tightGrid

protected final GridRegionQuadTreeTightCell[] tightGrid

dirtyCells

protected final java.util.BitSet dirtyCells

gridWorldX

protected final int gridWorldX

gridWorldY

protected final int gridWorldY

totalCellsX

protected final int totalCellsX

cellWidth

protected final int cellWidth

cellHeight

protected final int cellHeight

invCellWidth

protected final float invCellWidth

invCellHeight

protected final float invCellHeight

minimumQuadWidth

protected final float minimumQuadWidth

minimumQuadHeight

protected final float minimumQuadHeight

pool

protected final org.mini2Dx.gdx.utils.Queue<RegionQuadTree<T extends Sizeable>> pool

totalElementsCache

protected int totalElementsCache

Constructor Detail

GridRegionQuadTree

public GridRegionQuadTree(int elementLimitPerQuad,
                          int x,
                          int y,
                          int width,
                          int height,
                          int gridCellWidth,
                          int gridCellHeight)

GridRegionQuadTree

public GridRegionQuadTree(float minimumQuadWidth,
                          float minimumQuadHeight,
                          int elementLimitPerQuad,
                          int x,
                          int y,
                          int width,
                          int height,
                          int gridCellWidth,
                          int gridCellHeight)

Method Detail

getGridIndex

protected int getGridIndex(float x,
                           float y)

getMinGridIndex

public int getMinGridIndex(T element)

getMaxGridIndex

public int getMaxGridIndex(T element)

getTightCell

public GridRegionQuadTreeTightCell<T> getTightCell(int index)

getTightCell

public GridRegionQuadTreeTightCell<T> getTightCell(T element)

getTightCell

public GridRegionQuadTreeTightCell<T> getTightCell(float x,
                                                   float y)

getLooseCell

public GridRegionQuadTreeLooseCell<T> getLooseCell(T element)

getLooseCell

public GridRegionQuadTreeLooseCell<T> getLooseCell(float x,
                                                   float y)

warmupPool

public void warmupPool(int poolSize)

warmupPool

public void warmupPool(int poolSize,
                       int expectedElementsPerQuad)

cleanup

public void cleanup()

debugRender

public void debugRender(Graphics g)

Specified by:

debugRender in interface CollisionDetection<T extends Sizeable>

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 Sizeable>

Parameters:

element - The element to add

Returns:

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

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 Sizeable>

Parameters:

element - The element to remove

Returns:

True if the element was found and removed

addAll

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

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 Sizeable>

Parameters:

elements - The elements to add

removeAll

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

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 Sizeable>

Parameters:

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

removeElement

protected boolean removeElement(T element,
                                boolean clearQuadRef)

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 Sizeable>

getElementsWithinArea

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

Specified by:

getElementsWithinArea in interface CollisionDetection<T extends Sizeable>

getElementsWithinArea

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

Specified by:

getElementsWithinArea in interface CollisionDetection<T extends Sizeable>

getElementsWithinAreaIgnoringEdges

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

Specified by:

getElementsWithinAreaIgnoringEdges in interface CollisionDetection<T extends Sizeable>

getElementsWithinAreaIgnoringEdges

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

Specified by:

getElementsWithinAreaIgnoringEdges in interface CollisionDetection<T extends Sizeable>

getElementsContainingArea

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

Specified by:

getElementsContainingArea in interface CollisionDetection<T extends Sizeable>

getElementsContainingArea

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

Specified by:

getElementsContainingArea in interface CollisionDetection<T extends Sizeable>

getElementsIntersectingLineSegment

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

Specified by:

getElementsIntersectingLineSegment in interface CollisionDetection<T extends Sizeable>

getElementsIntersectingLineSegment

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

Specified by:

getElementsIntersectingLineSegment in interface CollisionDetection<T extends Sizeable>

getElementsContainingPoint

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

Specified by:

getElementsContainingPoint in interface CollisionDetection<T extends Sizeable>

getElementsContainingPoint

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

Specified by:

getElementsContainingPoint in interface CollisionDetection<T extends Sizeable>

getElementsWithinArea

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

Specified by:

getElementsWithinArea in interface QuadTree<T extends Sizeable>

getElementsWithinArea

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

Specified by:

getElementsWithinArea in interface QuadTree<T extends Sizeable>

getElementsWithinAreaIgnoringEdges

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

Specified by:

getElementsWithinAreaIgnoringEdges in interface QuadTree<T extends Sizeable>

getElementsWithinAreaIgnoringEdges

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

Specified by:

getElementsWithinAreaIgnoringEdges in interface QuadTree<T extends Sizeable>

getElementsContainingArea

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

Specified by:

getElementsContainingArea in interface QuadTree<T extends Sizeable>

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 Sizeable>

getElementsIntersectingLineSegment

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

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends Sizeable>

getElementsIntersectingLineSegment

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

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends Sizeable>

getElementsContainingPoint

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

Specified by:

getElementsContainingPoint in interface QuadTree<T extends Sizeable>

getElementsContainingPoint

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

Specified by:

getElementsContainingPoint in interface QuadTree<T extends Sizeable>

positionChanged

public void positionChanged(T moved)

Specified by:

positionChanged in interface PositionChangeListener<T extends Sizeable>

getElements

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

Specified by:

getElements in interface CollisionDetection<T extends Sizeable>

getElements

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

Specified by:

getElements in interface CollisionDetection<T extends Sizeable>

getTotalElements

public int getTotalElements()

Specified by:

getTotalElements in interface CollisionDetection<T extends Sizeable>

getTotalQuads

public int getTotalQuads()

Specified by:

getTotalQuads in interface QuadTree<T extends Sizeable>

getParent

public QuadTree<T> getParent()

Specified by:

getParent in interface QuadTree<T extends Sizeable>

getMinimumQuadWidth

public float getMinimumQuadWidth()

Specified by:

getMinimumQuadWidth in interface QuadTree<T extends Sizeable>

getMinimumQuadHeight

public float getMinimumQuadHeight()

Specified by:

getMinimumQuadHeight in interface QuadTree<T extends Sizeable>