Package org.jungrapht.visualization.layout.algorithms

Class CircleLayoutAlgorithm<V>

java.lang.Object

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

All Implemented Interfaces:

LayoutAlgorithm<V>, AfterRunnable, ExecutorConsumer, Threaded

public class CircleLayoutAlgorithm<V>
extends Object
implements LayoutAlgorithm<V>, AfterRunnable, Threaded, ExecutorConsumer

A Layout implementation that positions vertices equally spaced on a regular circle.

Author:

Masanori Harada, Tom Nelson - adapted to an algorithm

Nested Class Summary

Nested Classes

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

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 Runnable	after
protected boolean	cancelled
protected static String	CIRCLE_REDUCE_EDGE_CROSSING
protected static String	CIRCLE_REDUCE_EDGE_CROSSING_MAX_EDGES
protected static String	CIRCLE_THREADED
protected Executor	executor
protected LayoutModel<V>	layoutModel
protected double	radius
protected boolean	reduceEdgeCrossing
protected int	reduceEdgeCrossingMaxEdges
protected List<V>	vertexOrderedList

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static <V> CircleLayoutAlgorithm.Builder<V,?,?>	builder()
void	cancel()
boolean	constrained()
<E> int	countCrossings()
int	getCrossingCount()
Executor	getExecutor()
double	getRadius()
boolean	isThreaded()
void	runAfter()
void	setAfter(Runnable after)
void	setExecutor(Executor executor)
void	setRadius(double radius)	Sets the radius of the circle.
void	setThreaded(boolean threaded)
void	setVertexOrder(LayoutModel<V> layoutModel, List<V> vertexList)	Sets the order of the vertices in the layout according to the ordering of vertex_list.
void	visit(LayoutModel<V> layoutModel)	visit the passed layoutModel and set its locations

Methods inherited from class java.lang.Object

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

Field Detail

CIRCLE_REDUCE_EDGE_CROSSING

protected static final String CIRCLE_REDUCE_EDGE_CROSSING

See Also:

Constant Field Values

CIRCLE_REDUCE_EDGE_CROSSING_MAX_EDGES

protected static final String CIRCLE_REDUCE_EDGE_CROSSING_MAX_EDGES

See Also:

Constant Field Values

CIRCLE_THREADED

protected static final String CIRCLE_THREADED

See Also:

Constant Field Values

layoutModel

protected LayoutModel<V> layoutModel

executor

protected Executor executor

radius

protected double radius

reduceEdgeCrossing

protected boolean reduceEdgeCrossing

vertexOrderedList

protected List<V> vertexOrderedList

after

protected Runnable after

reduceEdgeCrossingMaxEdges

protected int reduceEdgeCrossingMaxEdges

cancelled

protected boolean cancelled

Constructor Detail

CircleLayoutAlgorithm

protected CircleLayoutAlgorithm(CircleLayoutAlgorithm.Builder<V,?,?> builder)

CircleLayoutAlgorithm

public CircleLayoutAlgorithm()

Method Detail

builder

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

getRadius

public double getRadius()

Returns:

the radius of the circle.

setRadius

public void setRadius(double radius)

Sets the radius of the circle. Must be called before initialize() is called.

Parameters:

radius - the radius of the circle

setExecutor

public void setExecutor(Executor executor)

Specified by:

setExecutor in interface ExecutorConsumer

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface ExecutorConsumer

getCrossingCount

public int getCrossingCount()

isThreaded

public boolean isThreaded()

Specified by:

isThreaded in interface Threaded

setThreaded

public void setThreaded(boolean threaded)

Specified by:

setThreaded in interface Threaded

setVertexOrder

public void setVertexOrder(LayoutModel<V> layoutModel,
                           List<V> vertexList)

Sets the order of the vertices in the layout according to the ordering of vertex_list.

Parameters:

vertexList - a list specifying the ordering of the vertices

visit

public void visit(LayoutModel<V> layoutModel)

Description copied from interface: LayoutAlgorithm

visit the passed layoutModel and set its locations

Specified by:

visit in interface LayoutAlgorithm<V>

Parameters:

layoutModel - the mediator between the container for vertices (the Graph) and the mapping from Vertex to Point

cancel

public void cancel()

Specified by:

cancel in interface LayoutAlgorithm<V>

Specified by:

cancel in interface Threaded

runAfter

public void runAfter()

Specified by:

runAfter in interface AfterRunnable

setAfter

public void setAfter(Runnable after)

Specified by:

setAfter in interface AfterRunnable

countCrossings

public <E> int countCrossings()

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>