Class VassalMapQuadTree

java.lang.Object

VASSAL.tools.qtree.QuadTree

VASSAL.build.module.index.VassalMapQuadTree

All Implemented Interfaces:

Cloneable

public class VassalMapQuadTree
extends QuadTree

A Quadtree index of pieces on the playable area of the Map. Each node of the Quadtree holds an Arraylist of the Game Pieces at that Map location Pieces that do not reside on the actual map (i.e. in the edge buffer, or off map) will not be indexed and NOT be found by a Ranged GKC

Constructor Summary

Constructors

Constructor	Description
VassalMapQuadTree(VassalMapQuadTree qtree, int x1, int y1, int x2, int y2)	Create a new Quadtree with larger bounds from an existing Quadtree
VassalMapQuadTree(Map map)	Create a QuadTree to cover the entire map

Method Summary

Modifier and Type	Method	Description
void	addOrUpdatePiece(GamePiece p)	Add a piece to the Qtree, or change it's location
Rectangle	getBounds()	Return the bounds of the current Quadtree
List<GamePiece>	getPiecesInRange(Point pos, int range)	Return a list of all pieces within range of a given Point NOTE: This is just a pre-selection, we are seacrchign a box, not a circle so extra pieces will be returned that are not in range.
void	removePiece(GamePiece p)	Remove a piece from the Qtree and the cross-reference

Methods inherited from class QuadTree

clear, clone, contains, find, get, getCount, getKeys, getRootNode, getValues, isEmpty, navigate, remove, searchIntersect, searchWithin, set, setRootNode, traverse

Modifier and Type	Method	Description
void	clear()	Removes all items from the tree.
QuadTree	clone()	Clones the quad-tree and returns the new instance.
boolean	contains(double x, double y)	Returns true if the point at (x, y) exists in the tree.
QNode	find(QNode node, double x, double y)	Finds a leaf node with the same (x, y) coordinates as the target point, or null if no point exists.
Object	get(double x, double y, Object opt_default)	Gets the value of the point at (x, y) or null if the point is empty.
int	getCount()
QPoint[]	getKeys()	Returns an array containing the coordinates of each point stored in the tree.
QNode	getRootNode()	Returns a reference to the tree's root node.
List	getValues()	Returns a list containing all values stored within the tree.
boolean	isEmpty()
void	navigate(QNode node, QFunc func, double xmin, double ymin, double xmax, double ymax)
Object	remove(double x, double y)	Removes a point from (x, y) if it exists.
QPoint[]	searchIntersect(double xmin, double ymin, double xmax, double ymax)
QPoint[]	searchWithin(double xmin, double ymin, double xmax, double ymax)
void	set(double x, double y, Object value)	Sets the value of an (x, y) point within the quad-tree.
void	setRootNode(QNode root)
void	traverse(QNode node, QFunc func)	Traverses the tree depth-first, with quadrants being traversed in clockwise order (NE, SE, SW, NW).

Methods inherited from class Object

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

Constructor Details

VassalMapQuadTree

public VassalMapQuadTree(Map map)

Create a QuadTree to cover the entire map

Parameters:

map -

VassalMapQuadTree

public VassalMapQuadTree(VassalMapQuadTree qtree,
 int x1,
 int y1,
 int x2,
 int y2)

Create a new Quadtree with larger bounds from an existing Quadtree

Parameters:

qtree - Existing Quadtree

x1 - New left margin

y1 - New top margin

x2 - New right margin

y2 - New bottom margin

Method Details

getBounds

public Rectangle getBounds()

Return the bounds of the current Quadtree

Returns:

bounds

addOrUpdatePiece

public void addOrUpdatePiece(GamePiece p)

Add a piece to the Qtree, or change it's location

Parameters:

p - Piece to add/move

removePiece

public void removePiece(GamePiece p)

Remove a piece from the Qtree and the cross-reference

Parameters:

p - Piece to remove

getPiecesInRange

public List<GamePiece> getPiecesInRange(Point pos,
 int range)

Return a list of all pieces within range of a given Point NOTE: This is just a pre-selection, we are seacrchign a box, not a circle so extra pieces will be returned that are not in range. This will be handled at the level above which will post-process our selection.

Parameters:

pos - Position

range - range in pixels to search

Returns:

List of pieces