org.gephi.layout.plugin.fruchterman

Class FruchtermanReingold

java.lang.Object

org.gephi.layout.plugin.AbstractLayout

org.gephi.layout.plugin.fruchterman.FruchtermanReingold

All Implemented Interfaces:

Layout

public class FruchtermanReingold
extends AbstractLayout
implements Layout

Author:

Mathieu Jacomy

Constructor Summary

Constructors

Constructor and Description
FruchtermanReingold(LayoutBuilder layoutBuilder)

Method Summary

Modifier and Type	Method and Description
boolean	canAlgo() Tests if the algorithm can run, called before each pass.
void	endAlgo() Called when the algorithm is finished (canAlgo() returns false).
Float	getArea()
Double	getGravity()
LayoutProperty[]	getProperties() The properties for this layout.
Double	getSpeed()
void	goAlgo() Run a step in the algorithm, should be called only if canAlgo() returns true.
void	initAlgo() initAlgo() is called to initialize the algorithm (prepare to run).
void	resetPropertiesValues() Resets the properties values to the default values.
void	setArea(Float area)
void	setGravity(Double gravity)
void	setSpeed(Double speed)

Methods inherited from class org.gephi.layout.plugin.AbstractLayout

ensureSafeLayoutNodePositions, getBuilder, isConverged, setConverged, setGraphModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gephi.layout.spi.Layout

getBuilder, setGraphModel

Constructor Detail

FruchtermanReingold

public FruchtermanReingold(LayoutBuilder layoutBuilder)

Method Detail

resetPropertiesValues

public void resetPropertiesValues()

Description copied from interface: Layout

Resets the properties values to the default values.

Specified by:

resetPropertiesValues in interface Layout

initAlgo

public void initAlgo()

Description copied from interface: Layout

initAlgo() is called to initialize the algorithm (prepare to run).

Specified by:

initAlgo in interface Layout

goAlgo

public void goAlgo()

Description copied from interface: Layout

Run a step in the algorithm, should be called only if canAlgo() returns true.

Specified by:

goAlgo in interface Layout

endAlgo

public void endAlgo()

Description copied from interface: Layout

Called when the algorithm is finished (canAlgo() returns false).

Specified by:

endAlgo in interface Layout

canAlgo

public boolean canAlgo()

Description copied from interface: Layout

Tests if the algorithm can run, called before each pass.

Specified by:

canAlgo in interface Layout

Overrides:

canAlgo in class AbstractLayout

Returns:

true if the algorithm can run, false otherwise

getProperties

public LayoutProperty[] getProperties()

Description copied from interface: Layout

The properties for this layout.

Specified by:

getProperties in interface Layout

Returns:

the layout properties

getArea

public Float getArea()

setArea

public void setArea(Float area)

getGravity

public Double getGravity()

Returns:

the gravity

setGravity

public void setGravity(Double gravity)

Parameters:

gravity - the gravity to set

getSpeed

public Double getSpeed()

Returns:

the speed

setSpeed

public void setSpeed(Double speed)

Parameters:

speed - the speed to set