org.gephi.layout.plugin.forceAtlas

Class ForceAtlasLayout

java.lang.Object

org.gephi.layout.plugin.AbstractLayout

org.gephi.layout.plugin.forceAtlas.ForceAtlasLayout

All Implemented Interfaces:

Layout

public class ForceAtlasLayout
extends AbstractLayout
implements Layout

Author:

Mathieu Jacomy

Field Summary

Fields

Modifier and Type	Field and Description
double	inertia

Constructor Summary

Constructors

Constructor and Description
ForceAtlasLayout(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).
Double	getAttractionStrength()
Double	getCooling()
Double	getFreezeInertia()
Double	getFreezeStrength()
Double	getGravity()
Double	getInertia()
Double	getMaxDisplacement()
LayoutProperty[]	getProperties() The properties for this layout.
Double	getRepulsionStrength()
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).
Boolean	isAdjustSizes()
Boolean	isFreezeBalance()
Boolean	isOutboundAttractionDistribution()
void	resetPropertiesValues() Resets the properties values to the default values.
void	setAdjustSizes(Boolean adjustSizes)
void	setAttractionStrength(Double attractionStrength)
void	setCooling(Double cooling)
void	setFreezeBalance(Boolean freezeBalance)
void	setFreezeInertia(Double freezeInertia)
void	setFreezeStrength(Double freezeStrength)
void	setGravity(Double gravity)
void	setInertia(Double inertia)
void	setMaxDisplacement(Double maxDisplacement)
void	setOutboundAttractionDistribution(Boolean outboundAttractionDistribution)
void	setRepulsionStrength(Double repulsionStrength)
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

Field Detail

inertia

public double inertia

Constructor Detail

ForceAtlasLayout

public ForceAtlasLayout(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

setInertia

public void setInertia(Double inertia)

getInertia

public Double getInertia()

getRepulsionStrength

public Double getRepulsionStrength()

Returns:

the repulsionStrength

setRepulsionStrength

public void setRepulsionStrength(Double repulsionStrength)

Parameters:

repulsionStrength - the repulsionStrength to set

getAttractionStrength

public Double getAttractionStrength()

Returns:

the attractionStrength

setAttractionStrength

public void setAttractionStrength(Double attractionStrength)

Parameters:

attractionStrength - the attractionStrength to set

getMaxDisplacement

public Double getMaxDisplacement()

Returns:

the maxDisplacement

setMaxDisplacement

public void setMaxDisplacement(Double maxDisplacement)

Parameters:

maxDisplacement - the maxDisplacement to set

isFreezeBalance

public Boolean isFreezeBalance()

Returns:

the freezeBalance

setFreezeBalance

public void setFreezeBalance(Boolean freezeBalance)

Parameters:

freezeBalance - the freezeBalance to set

getFreezeStrength

public Double getFreezeStrength()

Returns:

the freezeStrength

setFreezeStrength

public void setFreezeStrength(Double freezeStrength)

Parameters:

freezeStrength - the freezeStrength to set

getFreezeInertia

public Double getFreezeInertia()

Returns:

the freezeInertia

setFreezeInertia

public void setFreezeInertia(Double freezeInertia)

Parameters:

freezeInertia - the freezeInertia to set

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

getCooling

public Double getCooling()

Returns:

the cooling

setCooling

public void setCooling(Double cooling)

Parameters:

cooling - the cooling to set

isOutboundAttractionDistribution

public Boolean isOutboundAttractionDistribution()

Returns:

the outboundAttractionDistribution

setOutboundAttractionDistribution

public void setOutboundAttractionDistribution(Boolean outboundAttractionDistribution)

Parameters:

outboundAttractionDistribution - the outboundAttractionDistribution to set

isAdjustSizes

public Boolean isAdjustSizes()

Returns:

the adjustSizes

setAdjustSizes

public void setAdjustSizes(Boolean adjustSizes)

Parameters:

adjustSizes - the adjustSizes to set