Package org.jungrapht.visualization.layout.algorithms

Class KKLayoutAlgorithm<V>

  • All Implemented Interfaces:
    IterativeLayoutAlgorithm<V>, LayoutAlgorithm<V>, AfterRunnable, ExecutorConsumer, IterativeContext, Threaded
    public class KKLayoutAlgorithm<V>
extends AbstractIterativeLayoutAlgorithm<V>
implements IterativeContext
    Implements the Kamada-Kawai algorithm for vertex layout. Does not respect filter calls, and sometimes crashes when the view changes to it.
    Author:
    Masanori Harada, Tom Nelson
    See Also:
    "Tomihisa Kamada and Satoru Kawai: An algorithm for drawing general indirect graphs. Information Processing Letters 31(1):7-15, 1989", "Tomihisa Kamada: On visualization of abstract objects and relations. Ph.D. dissertation, Dept. of Information Science, Univ. of Tokyo, Dec. 1988."

    • Field Detail

      • diameter

        protected double diameter
        The diameter of the visible graph. In other words, the maximum over all pairs of vertices of the length of the shortest path between a and bf the visible graph.

    • Constructor Detail

      • KKLayoutAlgorithm

        public KKLayoutAlgorithm()

    • Method Detail

      • visit

        public void visit​(LayoutModel<V> layoutModel)
        Description copied from class: AbstractIterativeLayoutAlgorithm
        because the IterativeLayoutAlgorithms use multithreading to continuously update vertex positions, the layoutModel state is saved (during the visit method) so that it can be used continuously
        Specified by:
        visit in interface LayoutAlgorithm<V>
        Overrides:
        visit in class AbstractIterativeLayoutAlgorithm<V>
        Parameters:
        layoutModel - the mediator between the container for vertices (the Graph) and the mapping from Vertex to Point

      • setLengthFactor

        public void setLengthFactor​(double length_factor)
        Parameters:
        length_factor - a multiplicative factor which partially specifies the preferred length of an edge

      • setDisconnectedDistanceMultiplier

        public void setDisconnectedDistanceMultiplier​(double disconnected_multiplier)
        Parameters:
        disconnected_multiplier - a multiplicative factor that specifies the fraction of the graph's diameter to be used as the inter-vertex distance between disconnected vertices

      • getStatus

        public String getStatus()
        Returns:
        a string with information about the current status of the algorithm.

      • setMaxIterations

        public void setMaxIterations​(int maxIterations)

      • done

        public boolean done()
        Specified by:
        done in interface IterativeContext
        Returns:
        true if the current iteration has passed the maximum count.

      • initialize

        public void initialize()

      • adjustForGravity

        public void adjustForGravity()
        Shift all vertices so that the center of gravity is located at the center of the screen.

      • setAdjustForGravity

        public void setAdjustForGravity​(boolean on)

      • getAdjustForGravity

        public boolean getAdjustForGravity()

      • setExchangevertices

        public void setExchangevertices​(boolean on)
        Enable or disable the local minimum escape technique by exchanging vertices.
        Parameters:
        on - iff the local minimum escape technique is to be enabled

      • getExchangevertices

        public boolean getExchangevertices()