Package org.jungrapht.visualization.layout.algorithms

Class RadialTreeLayoutAlgorithm<V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Consumer<Function<V,Rectangle>>, LayoutAlgorithm<V>, Radial, RadialTreeLayout<V>, TreeLayout<V>, AfterRunnable, VertexBoundsFunctionConsumer<V>

public class RadialTreeLayoutAlgorithm<V>
extends TreeLayoutAlgorithm<V>
implements RadialTreeLayout<V>

A radial layout for Tree or Forest graphs. Positions vertices in concentric circles with the root(s) at the center

Author:

Tom Nelson

Nested Class Summary

Nested Classes

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

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

LayoutAlgorithm.NoOp<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<V,PolarPoint>	polarLocations

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

baseBounds, correctOverlap, defaultRootPredicate, expandLayout, horizontalVertexSpacing, neighborCache, rootComparator, rootPredicate, vertexBoundsFunction, verticalVertexSpacing, visitedVertices

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

after

Fields inherited from interface org.jungrapht.visualization.layout.algorithms.TreeLayout

TREE_LAYOUT_HORIZONTAL_SPACING, TREE_LAYOUT_VERTICAL_SPACING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static <V> RadialTreeLayoutAlgorithm.Builder<V,?,?>	builder()
protected Set<V>	buildTree(LayoutModel<V> layoutModel)
boolean	constrained()
int	diameter(LayoutModel<V> layoutModel)
protected Point	getCartesian(LayoutModel<V> layoutModel, V vertex)
protected int	getInitialPosition(int initialPosition, int layoutHeight, int treeHeight)	override for to always start at zero
protected Point	getMaxXY(LayoutModel<V> layoutModel)
Map<V,PolarPoint>	getPolarLocations()
protected void	offset(LayoutModel<V> layoutModel, int delta)
protected void	putRadialPointsInModel(LayoutModel<V> layoutModel)
protected void	setRadialLocations(Set<V> roots, LayoutModel<V> layoutModel)

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

buildTree, calculateHeight, calculateHeight, calculateWidth, calculateWidth, getBaseBounds, getCenter, getSpanningTree, merge, visit

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

adjustToFill, expandToFill, moveVerticesThatOverlapVerticalEdges, setRootComparator, setRootPredicate, setVertexBoundsFunction

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, toString, wait, wait, wait

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

runAfter, setAfter

Methods inherited from interface java.util.function.Consumer

andThen

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

cancel, visit

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

getBaseBounds, getCenter

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

setRootComparator, setRootPredicate

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

accept, setVertexBoundsFunction

Field Detail

polarLocations

protected Map<V,PolarPoint> polarLocations

Constructor Detail

RadialTreeLayoutAlgorithm

public RadialTreeLayoutAlgorithm()

RadialTreeLayoutAlgorithm

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

Method Detail

builder

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

buildTree

protected Set<V> buildTree(LayoutModel<V> layoutModel)

Overrides:

buildTree in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the model to hold vertex positions

Returns:

the roots vertices of the tree

offset

protected void offset(LayoutModel<V> layoutModel,
                      int delta)

diameter

public int diameter(LayoutModel<V> layoutModel)

Specified by:

diameter in interface RadialTreeLayout<V>

getInitialPosition

protected int getInitialPosition(int initialPosition,
                                 int layoutHeight,
                                 int treeHeight)

override for to always start at zero

Overrides:

getInitialPosition in class TreeLayoutAlgorithm<V>

Parameters:

layoutHeight -

treeHeight -

initialPosition - default initial position for when the layoutSpan is greater than the tree span

Returns:

0 for any supplied values

putRadialPointsInModel

protected void putRadialPointsInModel(LayoutModel<V> layoutModel)

getPolarLocations

public Map<V,PolarPoint> getPolarLocations()

Specified by:

getPolarLocations in interface RadialTreeLayout<V>

Returns:

a map from vertices to their locations in polar coordinates.

getCartesian

protected Point getCartesian(LayoutModel<V> layoutModel,
                             V vertex)

getMaxXY

protected Point getMaxXY(LayoutModel<V> layoutModel)

setRadialLocations

protected void setRadialLocations(Set<V> roots,
                                  LayoutModel<V> layoutModel)

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>

Specified by:

constrained in interface RadialTreeLayout<V>

Overrides:

constrained in class TreeLayoutAlgorithm<V>