Class ClosestShapePickSupport<V,E>

java.lang.Object

edu.uci.ics.jung.visualization.picking.ClosestShapePickSupport<V,E>

All Implemented Interfaces:

GraphElementAccessor<V,E>

public class ClosestShapePickSupport<V,E>
extends Object
implements GraphElementAccessor<V,E>

A GraphElementAccessor that finds the closest element to the pick point, and returns it if it is within the element's shape. This is best suited to elements with convex shapes that do not overlap. It differs from ShapePickSupport in that it only checks the closest element to see whether it contains the pick point. Possible unexpected odd behaviors:

• If the elements overlap, this mechanism may pick another element than the one that's "on top" (rendered last) if the pick point is closer to the center of an obscured vertex.
• If element shapes are not convex, then this mechanism may return null even if the pick point is inside some element's shape, if the pick point is closer to the center of another element.

Users who want to avoid either of these should use ShapePickSupport instead, which is slower but more flexible. If neither of the above conditions (overlapping elements or non-convex shapes) is true, then ShapePickSupport and this class should have the same behavior.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	pickSize
protected VisualizationServer<V,E>	vv

Constructor Summary

Constructors

Constructor	Description
ClosestShapePickSupport(VisualizationServer<V,E> vv)	Create a ShapePickSupport with the vv VisualizationServer and default pick footprint.
ClosestShapePickSupport(VisualizationServer<V,E> vv, float pickSize)	Creates a ShapePickSupport for the vv VisualizationServer, with the specified pick footprint.

Method Summary

Modifier and Type	Method	Description
E	getEdge(Layout<V,E> layout, double x, double y)
V	getVertex(Layout<V,E> layout, double x, double y)	Returns the vertex, if any, associated with (x, y).
Collection<V>	getVertices(Layout<V,E> layout, Shape rectangle)

Methods inherited from class Object

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

Field Details

vv

protected VisualizationServer<V,E> vv

pickSize

protected float pickSize

Constructor Details

ClosestShapePickSupport

public ClosestShapePickSupport(VisualizationServer<V,E> vv,
 float pickSize)

Creates a ShapePickSupport for the vv VisualizationServer, with the specified pick footprint. The VisualizationServer is used to fetch the current Layout.

Parameters:

vv - source of the current Layout.

pickSize - the size of the pick footprint for line edges

ClosestShapePickSupport

public ClosestShapePickSupport(VisualizationServer<V,E> vv)

Create a ShapePickSupport with the vv VisualizationServer and default pick footprint. The footprint defaults to 2.

Parameters:

vv - source of the current Layout.

Method Details

getEdge

public E getEdge(Layout<V,E> layout,
 double x,
 double y)

Specified by:

getEdge in interface GraphElementAccessor<V,E>

Parameters:

layout - the context in which the location is defined

x - the x coordinate of the location

y - the y coordinate of the location

Returns:

an edge which is associated with the location (x,y) as given by layout, generally by reference to the edge's endpoints

See Also:

• GraphElementAccessor.getEdge(edu.uci.ics.jung.algorithms.layout.Layout, double, double)

getVertex

public V getVertex(Layout<V,E> layout,
 double x,
 double y)

Description copied from interface: GraphElementAccessor

Returns the vertex, if any, associated with (x, y).

Specified by:

getVertex in interface GraphElementAccessor<V,E>

Parameters:

layout - the layout instance that records the positions for all vertices

x - the x coordinate of the pick point

y - the y coordinate of the pick point

Returns:

the vertex associated with (x, y)

See Also:

• GraphElementAccessor.getVertex(edu.uci.ics.jung.algorithms.layout.Layout, double, double)

getVertices

public Collection<V> getVertices(Layout<V,E> layout,
 Shape rectangle)

Specified by:

getVertices in interface GraphElementAccessor<V,E>

Parameters:

layout - the layout instance that records the positions for all vertices

rectangle - the region in which the returned vertices are located

Returns:

the vertices whose locations given by layout are contained within rectangle

See Also:

• GraphElementAccessor.getVertices(edu.uci.ics.jung.algorithms.layout.Layout, java.awt.Shape)