Package org.jungrapht.visualization.spatial

Interface Spatial<T,NT>

All Superinterfaces:

LayoutStateChange.Listener, LayoutVertexPositionChange.Listener<NT>

All Known Implementing Classes:

AbstractSpatial, Spatial.NoOp, Spatial.NoOp.Edge, Spatial.NoOp.Vertex, SpatialGrid, SpatialQuadTree, SpatialRTree, SpatialRTree.Edges, SpatialRTree.Vertices, SwingThreadSpatial

public interface Spatial<T,NT>
extends LayoutStateChange.Listener, LayoutVertexPositionChange.Listener<NT>

Basic interface for Spatial data

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Spatial.NoOp<T,NT>	a special case Spatial that does no filtering

Method Summary

Modifier and Type	Method	Description
void	clear()	destroy the current spatial structure
T	getClosestElement(double x, double y)
T	getClosestElement(Point2D p)
TreeNode	getContainingLeaf(Object element)
Set<? extends TreeNode>	getContainingLeafs(double x, double y)
Set<? extends TreeNode>	getContainingLeafs(Point2D p)
List<Shape>	getGrid()
Rectangle2D	getLayoutArea()
LayoutModel	getLayoutModel()
Collection<Shape>	getPickShapes()	a short-lived collection of recent pick target areas
default Rectangle2D	getUnion(Rectangle2D rect, double x, double y)
default Rectangle2D	getUnion(Rectangle2D rect, Point2D p)	expands the passed rectangle so that it includes the passed point
Set<T>	getVisibleElements(Shape shape)
boolean	isActive()
void	recalculate()	rebuild the data structure
void	setActive(boolean active)	a flag to suggest whether or not the spatial structure should be used
void	setBounds(Rectangle2D bounds)
void	update(T element, Point location)	update the spatial structure with the (possibly new) location of the passed element

Methods inherited from interface org.jungrapht.visualization.layout.event.LayoutStateChange.Listener

layoutStateChanged

Methods inherited from interface org.jungrapht.visualization.layout.event.LayoutVertexPositionChange.Listener

layoutVertexPositionChanged, layoutVertexPositionChanged

Method Detail

setActive

void setActive(boolean active)

a flag to suggest whether or not the spatial structure should be used

Parameters:

active -

isActive

boolean isActive()

Returns:

a hint about whether the spatial structure should be used

getGrid

List<Shape> getGrid()

Returns:

a geometic representation of the spatial structure

getPickShapes

Collection<Shape> getPickShapes()

a short-lived collection of recent pick target areas

Returns:

clear

void clear()

destroy the current spatial structure

recalculate

void recalculate()

rebuild the data structure

getLayoutArea

Rectangle2D getLayoutArea()

Returns:

the 2 dimensional area of interest for this class

setBounds

void setBounds(Rectangle2D bounds)

Parameters:

bounds - the new bounds for the data struture

getUnion

default Rectangle2D getUnion(Rectangle2D rect,
                             Point2D p)

expands the passed rectangle so that it includes the passed point

Parameters:

rect - the area to consider

p - the point that may be outside of the area

Returns:

a new rectangle

getUnion

default Rectangle2D getUnion(Rectangle2D rect,
                             double x,
                             double y)

update

void update(T element,
            Point location)

update the spatial structure with the (possibly new) location of the passed element

Parameters:

element - the element to consider

location - the location of the element

getContainingLeafs

Set<? extends TreeNode> getContainingLeafs(Point2D p)

Parameters:

p - a point to search in the spatial structure

Returns:

all leaf nodes that contain the passed point

getContainingLeafs

Set<? extends TreeNode> getContainingLeafs(double x,
                                           double y)

Parameters:

x - the x location to search for

y - the y location to search for

Returns:

all leaf nodes that contain the passed coordinates

getContainingLeaf

TreeNode getContainingLeaf(Object element)

Parameters:

element - element to search for

Returns:

the leaf node that currently contains the element (not a spatial search)

getVisibleElements

Set<T> getVisibleElements(Shape shape)

Parameters:

shape - a shape to filter the spatial structure's elements

Returns:

all elements that are contained in the passed shape

getClosestElement

T getClosestElement(Point2D p)

Parameters:

p - a point to search in the spatial structure

Returns:

the closest element to the passed point

getClosestElement

T getClosestElement(double x,
                    double y)

Parameters:

x - coordinate of a point to search in the spatial structure

y - coordinate of a point to search in the spatial structure

Returns:

the closest element to the passed coordinates

getLayoutModel

LayoutModel getLayoutModel()