org.mini2Dx.core.collisions

Class RegionQuadTree<T extends CollisionShape>

java.lang.Object

org.mini2Dx.core.geom.Shape

org.mini2Dx.core.geom.Rectangle

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

org.mini2Dx.core.collisions.RegionQuadTree<T>

All Implemented Interfaces:

QuadTree<T>, PositionChangeListener<T>, Parallelogram

public class RegionQuadTree<T extends CollisionShape>
extends PointQuadTree<T>

Implements a region quadtree

See Also:

Wikipedia: Region Quad Tree

Field Summary

Fields inherited from class org.mini2Dx.core.collisions.PointQuadTree

bottomLeft, bottomRight, DEFAULT_MINIMUM_QUAD_SIZE, ELEMENT_COLOR, elementLimitPerQuad, elements, mergeWatermark, minimumQuadHeight, minimumQuadWidth, parent, QUAD_COLOR, topLeft, topRight, totalElementsCache

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add(T element) Adds an element to this QuadTree
void	addAll(com.badlogic.gdx.utils.Array<T> elementsToAdd) Adds all element to this QuadTree.
protected boolean	addElementToChild(T element)
void	clear() Same a QuadTree.removeAll(Array) except the results are not stored
void	debugRender(Graphics g)
com.badlogic.gdx.utils.Array<T>	getElements()
void	getElements(com.badlogic.gdx.utils.Array<T> result)
void	getElementsContainingPoint(com.badlogic.gdx.utils.Array<T> result, Point point)
com.badlogic.gdx.utils.Array<T>	getElementsContainingPoint(Point point)
void	getElementsIntersectingLineSegment(com.badlogic.gdx.utils.Array<T> result, LineSegment lineSegment)
com.badlogic.gdx.utils.Array<T>	getElementsIntersectingLineSegment(LineSegment lineSegment)
void	getElementsWithinArea(com.badlogic.gdx.utils.Array<T> result, Shape area)
com.badlogic.gdx.utils.Array<T>	getElementsWithinArea(Shape area)
int	getTotalElements()
void	positionChanged(T moved)
boolean	remove(T element) Removes an element from this QuadTree
protected void	subdivide()

Methods inherited from class org.mini2Dx.core.collisions.PointQuadTree

addElement, clearTotalElementsCache, getElementLimitPerQuad, getMergeWatermark, getMinimumQuadHeight, getMinimumQuadWidth, getParent, getTotalQuads, hasChildQuads, isMergable, merge, removeAll, removeElement, removeElementFromChild

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

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

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

add, intersects, subtract

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.core.geom.Parallelogram

contains, contains, getHeight, getMaxX, getMaxY, getRotation, getWidth, getX, getY, intersects, intersects, intersectsLineSegment, rotate, rotateAround, setRotation, setRotationAround

Constructor Detail

RegionQuadTree

public RegionQuadTree(int elementLimit,
                      int mergeWatermark,
                      float x,
                      float y,
                      float width,
                      float height)

Constructs a RegionQuadTree with a specified element limit and watermark

Parameters:

elementLimit - The maximum number of elements in a RegionQuadTree before it is split into 4 child quads

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

x - The x coordinate of the RegionQuadTree

y - The y coordiante of the RegionQuadTree

width - The width of the RegionQuadTree

height - The height of the RegionQuadTree

RegionQuadTree

public RegionQuadTree(int elementLimit,
                      float x,
                      float y,
                      float width,
                      float height)

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

Parameters:

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

x - The x coordinate of the RegionQuadTree

y - The y coordiante of the RegionQuadTree

width - The width of the RegionQuadTree

height - The height of the RegionQuadTree

RegionQuadTree

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

Constructs a RegionQuadTree as a child of another RegionQuadTree

Parameters:

parent - The parent RegionQuadTree

x - The x coordinate of the RegionQuadTree

y - The y coordiante of the RegionQuadTree

width - The width of the RegionQuadTree

height - The height of the RegionQuadTree

RegionQuadTree

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

Constructs a RegionQuadTree 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 RegionQuadTrees

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

x - The x coordinate of the RegionQuadTree

y - The y coordiante of the RegionQuadTree

width - The width of the RegionQuadTree

height - The height of the RegionQuadTree

Method Detail

debugRender

public void debugRender(Graphics g)

Specified by:

debugRender in interface QuadTree<T extends CollisionShape>

Overrides:

debugRender in class PointQuadTree<T extends CollisionShape>

addAll

public void addAll(com.badlogic.gdx.utils.Array<T> elementsToAdd)

Description copied from interface: QuadTree

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 QuadTree<T extends CollisionShape>

Overrides:

addAll in class PointQuadTree<T extends CollisionShape>

Parameters:

elementsToAdd - The elements to add

add

public boolean add(T element)

Description copied from interface: QuadTree

Adds an element to this QuadTree

Specified by:

add in interface QuadTree<T extends CollisionShape>

Overrides:

add in class PointQuadTree<T extends CollisionShape>

Parameters:

element - The element to add

Returns:

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

addElementToChild

protected boolean addElementToChild(T element)

Overrides:

addElementToChild in class PointQuadTree<T extends CollisionShape>

subdivide

protected void subdivide()

Overrides:

subdivide in class PointQuadTree<T extends CollisionShape>

remove

public boolean remove(T element)

Description copied from interface: QuadTree

Removes an element from this QuadTree

Specified by:

remove in interface QuadTree<T extends CollisionShape>

Overrides:

remove in class PointQuadTree<T extends CollisionShape>

Parameters:

element - The element to remove

Returns:

True if the element was found and removed

clear

public void clear()

Description copied from interface: QuadTree

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

Specified by:

clear in interface QuadTree<T extends CollisionShape>

Overrides:

clear in class PointQuadTree<T extends CollisionShape>

getElementsWithinArea

public com.badlogic.gdx.utils.Array<T> getElementsWithinArea(Shape area)

Specified by:

getElementsWithinArea in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsWithinArea in class PointQuadTree<T extends CollisionShape>

getElementsWithinArea

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

Specified by:

getElementsWithinArea in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsWithinArea in class PointQuadTree<T extends CollisionShape>

getElementsContainingPoint

public com.badlogic.gdx.utils.Array<T> getElementsContainingPoint(Point point)

Specified by:

getElementsContainingPoint in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsContainingPoint in class PointQuadTree<T extends CollisionShape>

getElementsContainingPoint

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

Specified by:

getElementsContainingPoint in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsContainingPoint in class PointQuadTree<T extends CollisionShape>

getElementsIntersectingLineSegment

public com.badlogic.gdx.utils.Array<T> getElementsIntersectingLineSegment(LineSegment lineSegment)

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsIntersectingLineSegment in class PointQuadTree<T extends CollisionShape>

getElementsIntersectingLineSegment

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

Specified by:

getElementsIntersectingLineSegment in interface QuadTree<T extends CollisionShape>

Overrides:

getElementsIntersectingLineSegment in class PointQuadTree<T extends CollisionShape>

getElements

public com.badlogic.gdx.utils.Array<T> getElements()

Specified by:

getElements in interface QuadTree<T extends CollisionShape>

Overrides:

getElements in class PointQuadTree<T extends CollisionShape>

getElements

public void getElements(com.badlogic.gdx.utils.Array<T> result)

Specified by:

getElements in interface QuadTree<T extends CollisionShape>

Overrides:

getElements in class PointQuadTree<T extends CollisionShape>

getTotalElements

public int getTotalElements()

Specified by:

getTotalElements in interface QuadTree<T extends CollisionShape>

Overrides:

getTotalElements in class PointQuadTree<T extends CollisionShape>

positionChanged

public void positionChanged(T moved)

Specified by:

positionChanged in interface PositionChangeListener<T extends CollisionShape>

Overrides:

positionChanged in class PointQuadTree<T extends CollisionShape>