Package org.jungrapht.visualization.layout.algorithms

Class SpringLayoutAlgorithm<V,E>

java.lang.Object

org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.SpringLayoutAlgorithm<V,E>

All Implemented Interfaces:

IterativeLayoutAlgorithm<V>, LayoutAlgorithm<V>, AfterRunnable, ExecutorConsumer, IterativeContext, Threaded

Direct Known Subclasses:

DAGLayoutAlgorithm

public class SpringLayoutAlgorithm<V,E>
extends AbstractIterativeLayoutAlgorithm<V>
implements IterativeContext

The SpringLayout package represents a visualization of a set of vertices. The SpringLayout, which is initialized with a Graph, assigns X/Y locations to each vertex. When called step() , the SpringLayout moves the visualization forward one step.

Author:

Danyel Fisher, Joshua O'Madadhain, Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringLayoutAlgorithm.Builder<V,E,T extends SpringLayoutAlgorithm<V,E>,B extends SpringLayoutAlgorithm.Builder<V,E,T,B>>
static class	SpringLayoutAlgorithm.SpringVertexData

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

LayoutAlgorithm.NoOp<V>

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.util.Threaded

Threaded.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
protected double	force_multiplier
protected Function<E,Integer>	lengthFunction
protected int	repulsion_range_sq
protected StandardSpringRepulsion	repulsionContract
protected StandardSpringRepulsion.Builder	repulsionContractBuilder
protected Map<V,SpringLayoutAlgorithm.SpringVertexData>	springVertexData
protected double	stretch

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm

afterRunnable, cancelled, executor, layoutModel, preRelaxDurationMs, random, shouldPreRelax, threaded

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

after

Constructor Summary

Constructors

Modifier	Constructor	Description
	SpringLayoutAlgorithm()
protected	SpringLayoutAlgorithm(SpringLayoutAlgorithm.Builder<V,E,?,?> builder)

Method Summary

Modifier and Type	Method	Description
static <V,E> SpringLayoutAlgorithm.Builder<V,E,?,?>	builder()
boolean	done()
double	getForceMultiplier()
int	getRepulsionRange()
double	getStretch()
void	initialize()
protected void	moveVertices()
protected void	relaxEdges()
void	setForceMultiplier(double force)
void	setRepulsionRange(int range)
void	setStretch(double stretch)
void	step()	Advances one step.
String	toString()
void	visit(LayoutModel<V> layoutModel)	Override to create the BarnesHutOctTree

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm

cancel, getExecutor, isThreaded, preRelax, setExecutor, setRandomSeed, setThreaded

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

computeAverageVertexDimension, computeLayoutExtent, expandToFill, runAfter, setAfter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.AfterRunnable

runAfter, setAfter

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

constrained

Field Detail

stretch

protected double stretch

lengthFunction

protected Function<E,Integer> lengthFunction

repulsion_range_sq

protected int repulsion_range_sq

force_multiplier

protected double force_multiplier

springVertexData

protected Map<V,SpringLayoutAlgorithm.SpringVertexData> springVertexData

repulsionContractBuilder

protected StandardSpringRepulsion.Builder repulsionContractBuilder

repulsionContract

protected StandardSpringRepulsion repulsionContract

Constructor Detail

SpringLayoutAlgorithm

public SpringLayoutAlgorithm()

SpringLayoutAlgorithm

protected SpringLayoutAlgorithm(SpringLayoutAlgorithm.Builder<V,E,?,?> builder)

Method Detail

builder

public static <V,E> SpringLayoutAlgorithm.Builder<V,E,?,?> builder()

visit

public void visit(LayoutModel<V> layoutModel)

Override to create the BarnesHutOctTree

Specified by:

visit in interface LayoutAlgorithm<V>

Overrides:

visit in class AbstractIterativeLayoutAlgorithm<V>

Parameters:

layoutModel -

getStretch

public double getStretch()

Returns:

the current value for the stretch parameter

setStretch

public void setStretch(double stretch)

getRepulsionRange

public int getRepulsionRange()

setRepulsionRange

public void setRepulsionRange(int range)

getForceMultiplier

public double getForceMultiplier()

setForceMultiplier

public void setForceMultiplier(double force)

initialize

public void initialize()

step

public void step()

Description copied from interface: IterativeContext

Advances one step.

Specified by:

step in interface IterativeContext

relaxEdges

protected void relaxEdges()

toString

public String toString()

Overrides:

toString in class Object

moveVertices

protected void moveVertices()

done

public boolean done()

Specified by:

done in interface IterativeContext

Returns:

false