Class SpringLayout<V,E>
java.lang.Object
edu.uci.ics.jung.algorithms.layout.AbstractLayout<V,E>
edu.uci.ics.jung.algorithms.layout.SpringLayout<V,E>
- All Implemented Interfaces:
com.google.common.base.Function<V,
,Point2D> Layout<V,
,E> IterativeContext
,Function<V,
Point2D>
- Direct Known Subclasses:
DAGLayout
,SpringLayout2
The SpringLayout package represents a visualization of a set of nodes. The
SpringLayout, which is initialized with a Graph, assigns X/Y locations to
each node. When called
relax()
, the SpringLayout moves the
visualization forward one step.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Used for changing the size of the layout in response to a component's size.protected static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected double
protected int
protected com.google.common.cache.LoadingCache
<V, SpringLayout.SpringVertexData> protected double
Fields inherited from class edu.uci.ics.jung.algorithms.layout.AbstractLayout
graph, initialized, locations, size
-
Constructor Summary
ConstructorsConstructorDescriptionSpringLayout
(Graph<V, E> g) Constructor for a SpringLayout for a raw graph with associated dimension--the input knows how big the graph is.Constructor for a SpringLayout for a raw graph with associated component. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
boolean
done()
double
int
double
void
Initializes fields in the node that may not have been set during the constructor.boolean
protected void
protected void
void
reset()
No effect.void
setForceMultiplier
(double force) Sets the force multiplier for this instance.void
setRepulsionRange
(int range) Sets the node repulsion range (in drawing area units) for this instance.void
When a visualization is resized, it presumably wants to fix the locations of the vertices and possibly to reinitialize its data.void
setStretch
(double stretch) Sets the stretch parameter for this instance.void
step()
Relaxation step.Methods inherited from class edu.uci.ics.jung.algorithms.layout.AbstractLayout
apply, getGraph, getSize, getX, getY, isLocked, lock, lock, offsetVertex, setGraph, setInitializer, setLocation, setLocation
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.google.common.base.Function
equals
-
Field Details
-
stretch
protected double stretch -
lengthFunction
-
repulsion_range_sq
protected int repulsion_range_sq -
force_multiplier
protected double force_multiplier -
springVertexData
-
-
Constructor Details
-
SpringLayout
Constructor for a SpringLayout for a raw graph with associated dimension--the input knows how big the graph is. Defaults to the unit length function.- Parameters:
g
- the graph on which the layout algorithm is to operate
-
SpringLayout
public SpringLayout(Graph<V, E> g, com.google.common.base.Function<? super E, Integer> length_function) Constructor for a SpringLayout for a raw graph with associated component.- Parameters:
g
- the graph on which the layout algorithm is to operatelength_function
- provides a length for each edge
-
-
Method Details
-
getStretch
public double getStretch()- Returns:
- the current value for the stretch parameter
-
setSize
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. -
setStretch
public void setStretch(double stretch) Sets the stretch parameter for this instance. This value specifies how much the degrees of an edge's incident vertices should influence how easily the endpoints of that edge can move (that is, that edge's tendency to change its length).
The default value is 0.70. Positive values less than 1 cause high-degree vertices to move less than low-degree vertices, and values > 1 cause high-degree vertices to move more than low-degree vertices. Negative values will have unpredictable and inconsistent results.
- Parameters:
stretch
- the stretch parameter
-
getRepulsionRange
public int getRepulsionRange() -
setRepulsionRange
public void setRepulsionRange(int range) Sets the node repulsion range (in drawing area units) for this instance. Outside this range, nodes do not repel each other. The default value is 100. Negative values are treated as their positive equivalents.- Parameters:
range
- the maximum repulsion range
-
getForceMultiplier
public double getForceMultiplier() -
setForceMultiplier
public void setForceMultiplier(double force) Sets the force multiplier for this instance. This value is used to specify how strongly an edge "wants" to be its default length (higher values indicate a greater attraction for the default length), which affects how much its endpoints move at each timestep. The default value is 1/3. A value of 0 turns off any attempt by the layout to cause edges to conform to the default length. Negative values cause long edges to get longer and short edges to get shorter; use at your own risk.- Parameters:
force
- an energy field created by all living things that binds the galaxy together
-
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 interfaceLayout<V,
E>
-
step
public void step()Relaxation step. Moves all nodes a smidge.- Specified by:
step
in interfaceIterativeContext
-
relaxEdges
protected void relaxEdges() -
calculateRepulsion
protected void calculateRepulsion() -
moveNodes
protected void moveNodes() -
isIncremental
public boolean isIncremental()- Returns:
- true
-
done
public boolean done()- Specified by:
done
in interfaceIterativeContext
- Returns:
- false
-
reset
public void reset()No effect.
-