Package org.jungrapht.visualization.selection

Class ShapePickSupport<V,​E>

  • Type Parameters:
    V - vertex type
    E - edge type
    All Implemented Interfaces:
    GraphElementAccessor<V,​E>, EdgeAccessor<V,​E>, VertexAccessor<V>
    public class ShapePickSupport<V,​E>
extends Object
implements GraphElementAccessor<V,​E>
    A GraphElementAccessor that returns elements whose Shape contains the specified pick point or region.
    Author:
    Tom Nelson

    • Field Detail

      • pickSize

        protected int pickSize

      • vv

        protected VisualizationServer<V,​E> vv
        The VisualizationServer in which the this instance is being used for picking. Used to retrieve properties such as the layout, renderer, vertex and edge shapes, and coordinate transformations.

      • style

        protected ShapePickSupport.Style style
        The current picking heuristic for this instance. Defaults to CENTERED.

    • Constructor Detail

      • ShapePickSupport

        public ShapePickSupport​(VisualizationServer<V,​E> vv,
                        int pickSize)
        Creates a ShapePickSupport for the vv VisualizationServer, with the specified pick footprint and the default pick style. The VisualizationServer is used to access properties of the current visualization (layout, renderer, coordinate transformations, vertex/edge shapes, etc.).
        Parameters:
        vv - source of the current Layout.
        pickSize - the layoutSize of the pick footprint for line edges

      • ShapePickSupport

        public ShapePickSupport​(VisualizationServer<V,​E> vv)
        Create a ShapePickSupport for the specified VisualizationServer with a default pick footprint. of layoutSize 2.
        Parameters:
        vv - the visualization server used for rendering

    • Method Detail

      • getStyle

        public ShapePickSupport.Style getStyle()
        Returns the style of picking used by this instance. This specifies which of the elements, among those whose shapes contain the pick point, is returned. The available styles are:
        • Style.CENTERED: returns the element whose center is closest to the pick point.
        • Style.LOWEST: returns the first such element encountered. (If the element collection has a consistent ordering, this will also be the element "on the bottom", that is, the one which is rendered first.)
        • Style.HIGHEST: returns the last such element encountered. (If the element collection has a consistent ordering, this will also be the element "on the top", that is, the one which is rendered last.)
        Returns:
        the style of picking used by this instance

      • setStyle

        public void setStyle​(ShapePickSupport.Style style)
        Specifies the style of picking to be used by this instance. This specifies which of the elements, among those whose shapes contain the pick point, will be returned. The available styles are:
        • Style.CENTERED: returns the element whose center is closest to the pick point.
        • Style.LOWEST: returns the first such element encountered. (If the element collection has a consistent ordering, this will also be the element "on the bottom", that is, the one which is rendered first.)
        • Style.HIGHEST: returns the last such element encountered. (If the element collection has a consistent ordering, this will also be the element "on the top", that is, the one which is rendered last.)
        Parameters:
        style - the style to set

      • getVertex

        public V getVertex​(LayoutModel<V> layoutModel,
                   Rectangle2D pickingFootprint)
        Returns the vertex, if any, whose shape intersects the supplied pickingFootprint. The pickingFootprint is in the view coordinate system. To test each vertex, it will have its shape transformed to the view coordinate system (what the user sees rendered on the screen).
        Parameters:
        layoutModel -
        pickingFootprint - a rectangle in the view coordinate system
        Returns:
        the vertex whos shape intersects the pickingFootprint in the view.

      • getVertex

        protected V getVertex​(Spatial<V,​V> spatial,
                      LayoutModel<V> layoutModel,
                      Rectangle2D pickingFootprint)
        uses the spatialRTree to find the closest vertex to the points
        Parameters:
        spatial -
        layoutModel -
        pickingFootprint -
        Returns:
        the selected vertex

      • getVertex

        public V getVertex​(LayoutModel<V> layoutModel,
                   Point p)
        Specified by:
        getVertex in interface VertexAccessor<V>
        Parameters:
        layoutModel - the source of graph element locations
        p - the pick point
        Returns:
        the vertex associated with the pick point

      • getVertex

        public V getVertex​(LayoutModel<V> layoutModel,
                   double x,
                   double y)
        Returns the vertex, if any, whose shape contains (x, y). If (x,y) is contained in more than one vertex's shape, returns the vertex whose center is closest to the pick point.
        Specified by:
        getVertex in interface VertexAccessor<V>
        Parameters:
        x - the x coordinate of the pick point
        y - the y coordinate of the pick point
        Returns:
        the vertex whose shape contains (x,y), and whose center is closest to the pick point

      • getVertices

        public Collection<V> getVertices​(LayoutModel<V> layoutModel,
                                 Shape shape)
        Returns the vertices whose layout coordinates are contained in Shape. The shape is in screen coordinates, and the graph vertices are transformed to screen coordinates before they are tested for inclusion.
        Specified by:
        getVertices in interface GraphElementAccessor<V,​E>
        shape - the region in which the returned vertices are located
        Returns:
        the Collection of vertices whose layout coordinates are contained in shape.

      • getContained

        protected Collection<V> getContained​(Spatial spatial,
                                     LayoutModel<V> layoutModel,
                                     Shape shape)
        use the spatial structure to find vertices inside the passed shape
        Parameters:
        spatial -
        layoutModel -
        shape - a target shape in layout coordinates
        Returns:
        the vertices contained in the target shape

      • getContained

        protected Collection<E> getContained​(SpatialRTree.Edges<E,​V> spatial,
                                     LayoutModel<V> layoutModel,
                                     Shape shape)
        use the spatial R tree to find edges inside the passed shape
        Parameters:
        spatial -
        layoutModel -
        shape - a target shape in layout coordinates
        Returns:
        the vertices contained in the target shape

      • getEdge

        public E getEdge​(LayoutModel<V> layoutModel,
                 double x,
                 double y)
        Returns an edge whose shape intersects the 'pickArea' footprint of the passed x,y, coordinates.
        Specified by:
        getEdge in interface EdgeAccessor<V,​E>
        Parameters:
        x - the x coordinate of the location (layout coordinate system)
        y - the y coordinate of the location (layout coordinate system)
        Returns:
        an edge whose shape intersects the pick area centered on the location (x,y)

      • getEdge

        public E getEdge​(LayoutModel<V> layoutModel,
                 Point p)
        Specified by:
        getEdge in interface EdgeAccessor<V,​E>
        Parameters:
        layoutModel - the source of Edge positions
        p - the pick point
        Returns:
        the vertex associated with the pick point

      • getEdge

        protected E getEdge​(SpatialRTree.Edges<E,​V> spatial,
                    LayoutModel<V> layoutModel,
                    double x,
                    double y)
        uses the spatialRTree to find the closest edge to the point coords
        Parameters:
        spatial -
        layoutModel -
        x - in the layout coordinate system
        y - in the layout coordinate system
        Returns:
        the selected vertex

      • getFilteredVertices

        protected Collection<V> getFilteredVertices()

      • getFilteredEdges

        protected Collection<E> getFilteredEdges()

      • verticesAreFiltered

        protected boolean verticesAreFiltered()
        Quick test to allow optimization of getFilteredVertices().
        Returns:
        true if there is an relaxing vertex filtering mechanism for this visualization, false otherwise

      • edgesAreFiltered

        protected boolean edgesAreFiltered()
        Quick test to allow optimization of getFilteredEdges().
        Returns:
        true if there is an relaxing edge filtering mechanism for this visualization, false otherwise

      • isVertexRendered

        protected boolean isVertexRendered​(V vertex)
        Returns true if this vertex in this graph is included in the collections of elements to be rendered, and false otherwise.
        Returns:
        true if this vertex is included in the collections of elements to be rendered, false otherwise.

      • isEdgeRendered

        protected boolean isEdgeRendered​(E edge)
        Returns true if this edge and its endpoints in this graph are all included in the collections of elements to be rendered, and false otherwise.
        Returns:
        true if this edge and its endpoints are all included in the collections of elements to be rendered, false otherwise.

      • getPickSize

        public float getPickSize()
        Returns the layoutSize of the edge picking area. The picking area is square; the layoutSize is specified as the length of one side, in view coordinates.
        Returns:
        the layoutSize of the edge picking area

      • setPickSize

        public void setPickSize​(int pickSize)
        Sets the layoutSize of the edge picking area.
        Parameters:
        pickSize - the length of one side of the (square) picking area, in view coordinates