org.arakhne.neteditor.figlayout.force

Class ForceBasedFigureLayout

java.lang.Object

org.arakhne.neteditor.figlayout.AbstractFigureLayout

org.arakhne.neteditor.figlayout.force.ForceBasedFigureLayout

All Implemented Interfaces:

ViewComponentConstants, FigureLayout, FigureLayoutConstants, ForceBasedConstants

public class ForceBasedFigureLayout
extends AbstractFigureLayout
implements ForceBasedConstants

This class provides the implementation of a force-based laying-out algorithm.

The force toward and away from nodes is calculated according to Hooke's Law and Coulomb's Law.

Since:

16.0

Version:

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

Author:

Stéphane GALLAND

See Also:

"http://en.wikipedia.org/wiki/Force-based_algorithms_(graph_drawing)"

Maven Group Id:

org.arakhne.neteditor

Maven Artifact Id:

neteditor-figlayout

Field Summary

Fields inherited from interface org.arakhne.neteditor.figlayout.force.ForceBasedConstants

DEFAULT_COULOMB_CONSTANT, DEFAULT_DAMPING, DEFAULT_MASS, DEFAULT_SPRING_CONSTANT, DEFAULT_STABILITY_ENERGY_THRESHOLD, DEFAULT_TIME_STEP

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
ForceBasedFigureLayout()

Method Summary

Methods

Modifier and Type	Method and Description
float	getCoulombConstant() Replies the Coulomb's constant to use.
float	getDamping() Replies the damping constant.
float	getMaximalKinematicEnergy() Replies the maximal kinematic energy up to the algorithm is able to reach.
FigureMassCalculator	getNodeMassCalculator() Replies the calculator of the node's masses.
float	getPreferredInterNodeSpace() Replies the preferred space between two nodes (insets are outside this preferred space).
float	getRandomCoordinateSpaceSize() Replies the size of the coordinate space that is used to compute a coordinate randomly.
float	getSpringConstant() Replies the spring constant to use.
float	getTimeStep() Replies the time step used by the algorithm.
Undoable	layoutFigures(Collection<? extends Figure> figures) Run the laying-out algorithm for the given figures.
void	setCoulombConstant(float k) Set the Coulomb's constant to use.
void	setDamping(float damping) Set the damping constant.
void	setMaximalKinematicEnergy(float energy) Set the maximal kinematic energy up to the algorithm is able to reach.
void	setNodeMassCalculator(FigureMassCalculator calculator) Set the calculator of the node's masses.
void	setPreferredInterNodeSpace(float space) Set the preferred space between two nodes (insets are outside this preferred space).
void	setRandomCoordinateSpaceSize(float size) Set the size of the coordinate space that is used to compute a coordinate randomly.
void	setSpringConstant(float k) Set the spring constant to use.
void	setTimeStep(float step) Set the time step used by the algorithm.

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

ForceBasedFigureLayout

public ForceBasedFigureLayout()

Method Detail

setPreferredInterNodeSpace

public void setPreferredInterNodeSpace(float space)

Set the preferred space between two nodes (insets are outside this preferred space).

Parameters:

space -

getPreferredInterNodeSpace

public float getPreferredInterNodeSpace()

Replies the preferred space between two nodes (insets are outside this preferred space).

Returns:

the preferred space.

setNodeMassCalculator

public void setNodeMassCalculator(FigureMassCalculator calculator)

Set the calculator of the node's masses.

Parameters:

calculator -

getNodeMassCalculator

public FigureMassCalculator getNodeMassCalculator()

Replies the calculator of the node's masses.

Returns:

the calculator of the masses.

getRandomCoordinateSpaceSize

public float getRandomCoordinateSpaceSize()

Replies the size of the coordinate space that is used to compute a coordinate randomly.

Returns:

the size of the random coordinate space.

setRandomCoordinateSpaceSize

public void setRandomCoordinateSpaceSize(float size)

Set the size of the coordinate space that is used to compute a coordinate randomly.

Parameters:

size - is the size of the random coordinate space; stricly positive.

getMaximalKinematicEnergy

public float getMaximalKinematicEnergy()

Replies the maximal kinematic energy up to the algorithm is able to reach.

Returns:

the maximal kinematic energy, stricly positive.

setMaximalKinematicEnergy

public void setMaximalKinematicEnergy(float energy)

Set the maximal kinematic energy up to the algorithm is able to reach.

Parameters:

energy - is the maximal kinematic energy, stricly positive.

getCoulombConstant

public float getCoulombConstant()

Replies the Coulomb's constant to use. Default is ForceBasedConstants.DEFAULT_COULOMB_CONSTANT.

Returns:

the Coulomb's constant, stricly positive.

setCoulombConstant

public void setCoulombConstant(float k)

Set the Coulomb's constant to use.

Parameters:

k - the Coulomb's constant, stricly positive.

getSpringConstant

public float getSpringConstant()

Replies the spring constant to use. Default is ForceBasedConstants.DEFAULT_SPRING_CONSTANT.

Returns:

the spring constant, stricly positive.

setSpringConstant

public void setSpringConstant(float k)

Set the spring constant to use.

Parameters:

k - the spring constant, stricly positive.

getDamping

public float getDamping()

Replies the damping constant. The damping constant is in (0;1) exclusive.

Returns:

the damping constant.

setDamping

public void setDamping(float damping)

Set the damping constant. The damping constant is in (0;1) exclusive.

Parameters:

damping - is the damping constant.

getTimeStep

public float getTimeStep()

Replies the time step used by the algorithm. The time step is the amount of time during which a node is atomically moved.

Returns:

the time step, stricly positive.

setTimeStep

public void setTimeStep(float step)

Set the time step used by the algorithm. The time step is the amount of time during which a node is atomically moved.

Parameters:

step - is the time step, stricly positive.

layoutFigures

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

Run the laying-out algorithm for the given figures.

Specified by:

layoutFigures in interface FigureLayout

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.