edu.uci.ics.jung.algorithms.layout

Class KKLayout<V,E>

java.lang.Object

edu.uci.ics.jung.algorithms.layout.AbstractLayout<V,E>

edu.uci.ics.jung.algorithms.layout.KKLayout<V,E>

All Implemented Interfaces:

com.google.common.base.Function<V,java.awt.geom.Point2D>, Layout<V,E>, IterativeContext

public class KKLayout<V,E>
extends AbstractLayout<V,E>
implements IterativeContext

Implements the Kamada-Kawai algorithm for node layout. Does not respect filter calls, and sometimes crashes when the view changes to it.

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."

Constructor Summary

Constructors

Constructor and Description
KKLayout(Graph<V,E> g)
KKLayout(Graph<V,E> g, Distance<V> distance) Creates an instance for the specified graph and distance metric.

Method Summary

Modifier and Type	Method and Description
void	adjustForGravity() Shift all vertices so that the center of gravity is located at the center of the screen.
boolean	done()
boolean	getAdjustForGravity()
boolean	getExchangeVertices()
java.lang.String	getStatus()
void	initialize() Initializes fields in the node that may not have been set during the constructor.
boolean	isIncremental()
void	reset()
void	setAdjustForGravity(boolean on)
void	setDisconnectedDistanceMultiplier(double disconnected_multiplier)
void	setExchangeVertices(boolean on) Enable or disable the local minimum escape technique by exchanging vertices.
void	setLengthFactor(double length_factor)
void	setMaxIterations(int maxIterations)
void	setSize(java.awt.Dimension size) When a visualization is resized, it presumably wants to fix the locations of the vertices and possibly to reinitialize its data.
void	step() Advances one step.

Methods inherited from class edu.uci.ics.jung.algorithms.layout.AbstractLayout

apply, getGraph, getSize, getX, getY, isLocked, lock, lock, setGraph, setInitializer, setLocation, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Constructor Detail

KKLayout

public KKLayout(Graph<V,E> g)

KKLayout

public KKLayout(Graph<V,E> g,
                Distance<V> distance)

Creates an instance for the specified graph and distance metric.

Parameters:

g - the graph on which the layout algorithm is to operate

distance - specifies the distance between pairs of vertices

Method Detail

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 java.lang.String getStatus()

Returns:

a string with information about the current status of the algorithm.

setMaxIterations

public void setMaxIterations(int maxIterations)

isIncremental

public boolean isIncremental()

Returns:

true

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()

Description copied from interface: Layout

Initializes fields in the node that may not have been set during the constructor. Must be called before the iterations begin.

Specified by:

initialize in interface Layout<V,E>

step

public void step()

Description copied from interface: IterativeContext

Advances one step.

Specified by:

step in interface IterativeContext

adjustForGravity

public void adjustForGravity()

Shift all vertices so that the center of gravity is located at the center of the screen.

setSize

public void setSize(java.awt.Dimension size)

Description copied from class: AbstractLayout

When a visualization is resized, it presumably wants to fix the locations of the vertices and possibly to reinitialize its data. The current method calls initializeLocations followed by initialize_local.

Specified by:

setSize in interface Layout<V,E>

Overrides:

setSize in class AbstractLayout<V,E>

Parameters:

size - the space to use to lay out this graph

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()

reset

public void reset()

Specified by:

reset in interface Layout<V,E>