org.arakhne.neteditor.figlayout.sugiyama

Class GanswerSugiyamaFigureLayout

java.lang.Object

org.arakhne.neteditor.figlayout.AbstractFigureLayout

org.arakhne.neteditor.figlayout.AbstractDirectionBasedFigureLayout

org.arakhne.neteditor.figlayout.sugiyama.GanswerSugiyamaFigureLayout

All Implemented Interfaces:

ViewComponentConstants, FigureLayout, FigureLayoutConstants

public class GanswerSugiyamaFigureLayout
extends AbstractDirectionBasedFigureLayout

This class represents the Ganswer-Sugiyama Layout Algorithm. The approach was first described by Gansner et al. in A Technique for Drawing Directed Graphs (1993). The Algorithm works only for non cyclic Graphs. This implementation contains three steps:

1. Ranking: The Nodes divided into different layers. For example: The first layer contains all nodes having no incoming edges.
2. Ordering: This Phase tries to reduce the number of crossings. There are different approaches possible: Here I use the Barycenter-Method. There are other methods thinkable.
3. Position: Place all the Node (and Edges) on a right place in the graph.

That means a long edge (over more then one layer) should be straight. The current solution is not very good and should be improved.

This implementation was adapted to cyclic graphs by Stéphane GALLAND.

Version:

NetEditor Figure Layout $Revision$ 2013-10-23 21:06:25

Author:

Marc BAUMGARTNER, Stéphane GALLAND

Maven Group Id:

org.arakhne.neteditor

Maven Artifact Id:

neteditor-figlayout

Field Summary

Fields inherited from interface org.arakhne.neteditor.figlayout.FigureLayoutConstants

HALF_MINIMAL_HORIZONTAL_PADDING, HALF_MINIMAL_VERTICAL_PADDING

Fields inherited from interface org.arakhne.neteditor.fig.view.ViewComponentConstants

DEFAULT_ACTIVE_COLOR, DEFAULT_BACKGROUND_SELECTION_COLOR, DEFAULT_DAMAGING_EXTENTS, DEFAULT_DRAW_SHADOW, DEFAULT_FILL_COLOR, DEFAULT_FOREGROUND_SELECTION_COLOR, DEFAULT_LINE_COLOR, DEFAULT_LOCKING_FILL_COLOR, DEFAULT_LOCKING_OUTLINE_COLOR, DEFAULT_MAXIMAL_SIZE, DEFAULT_MINIMAL_SIZE, DEFAULT_MINIMAL_SUBFIGURE_SIZE, DEFAULT_SHADOW_PROJECTION_DISTANCE_X, DEFAULT_SHADOW_PROJECTION_DISTANCE_Y, FLATTENING_PRECISION

Constructor Summary

Constructors

Constructor and Description
GanswerSugiyamaFigureLayout()

Method Summary

Methods

Modifier and Type	Method and Description
float	getPreferredInterLayerSpace() Replies the preferred size to allocate to the space between the layers.
Undoable	layoutFigures(Collection<? extends Figure> figures) Run the laying-out algorithm for the given figures.
void	setPreferredInterLayerSpace(float size) Set the preferred size to allocate to the space between the layers.

Methods inherited from class org.arakhne.neteditor.figlayout.AbstractDirectionBasedFigureLayout

getLayoutDirection, setLayoutDirection

Methods inherited from class org.arakhne.neteditor.figlayout.AbstractFigureLayout

getMargins, getOrigin, setMargins, setOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Constructor Detail

GanswerSugiyamaFigureLayout

public GanswerSugiyamaFigureLayout()

Method Detail

getPreferredInterLayerSpace

public float getPreferredInterLayerSpace()

Replies the preferred size to allocate to the space between the layers.

Returns:

the preferred size to allocate to the space between the layers.

setPreferredInterLayerSpace

public void setPreferredInterLayerSpace(float size)

Set the preferred size to allocate to the space between the layers.

Parameters:

size - is the preferred size to allocate to the space between the layers.

layoutFigures

public Undoable layoutFigures(Collection<? extends Figure> figures)

Run the laying-out algorithm for the given figures.

Parameters:

figures - are the figures to laying out.

Returns:

the undoable edit that permits to revert the laying out; or null if the layout does not supports the undo/redo feature or it has nothing to undo.