Gephi Toolkit Javadoc

org.gephi.layout.plugin.forceAtlas
Class ForceAtlasLayout

java.lang.Object
  extended by org.gephi.layout.plugin.AbstractLayout
      extended by org.gephi.layout.plugin.forceAtlas.ForceAtlasLayout
All Implemented Interfaces:
Layout

public class ForceAtlasLayout
extends AbstractLayout
implements Layout

Author:
Mathieu Jacomy

Field Summary
protected  HierarchicalGraph graph
           
 double inertia
           
 
Fields inherited from class org.gephi.layout.plugin.AbstractLayout
dynamicModel, graphModel
 
Constructor Summary
ForceAtlasLayout(LayoutBuilder layoutBuilder)
           
 
Method Summary
 boolean canAlgo()
          Tests if the algorithm can run, called before each pass.
 void endAlgo()
          Called when the algorithm is finished (canAlgo() returns false).
 java.lang.Double getAttractionStrength()
           
 java.lang.Double getCooling()
           
 java.lang.Double getFreezeInertia()
           
 java.lang.Double getFreezeStrength()
           
 java.lang.Double getGravity()
           
 java.lang.Double getInertia()
           
 java.lang.Double getMaxDisplacement()
           
 LayoutProperty[] getProperties()
          The properties for this layout.
 java.lang.Double getRepulsionStrength()
           
 java.lang.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).
 java.lang.Boolean isAdjustSizes()
           
 java.lang.Boolean isFreezeBalance()
           
 java.lang.Boolean isOutboundAttractionDistribution()
           
 void resetPropertiesValues()
          Resets the properties values to the default values.
 void setAdjustSizes(java.lang.Boolean adjustSizes)
           
 void setAttractionStrength(java.lang.Double attractionStrength)
           
 void setCooling(java.lang.Double cooling)
           
 void setFreezeBalance(java.lang.Boolean freezeBalance)
           
 void setFreezeInertia(java.lang.Double freezeInertia)
           
 void setFreezeStrength(java.lang.Double freezeStrength)
           
 void setGravity(java.lang.Double gravity)
           
 void setInertia(java.lang.Double inertia)
           
 void setMaxDisplacement(java.lang.Double maxDisplacement)
           
 void setOutboundAttractionDistribution(java.lang.Boolean outboundAttractionDistribution)
           
 void setRepulsionStrength(java.lang.Double repulsionStrength)
           
 void setSpeed(java.lang.Double speed)
           
 
Methods inherited from class org.gephi.layout.plugin.AbstractLayout
getBuilder, isConverged, setConverged, setGraphModel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.gephi.layout.spi.Layout
getBuilder, setGraphModel
 

Field Detail

graph

protected HierarchicalGraph graph

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(java.lang.Double inertia)

getInertia

public java.lang.Double getInertia()

getRepulsionStrength

public java.lang.Double getRepulsionStrength()
Returns:
the repulsionStrength

setRepulsionStrength

public void setRepulsionStrength(java.lang.Double repulsionStrength)
Parameters:
repulsionStrength - the repulsionStrength to set

getAttractionStrength

public java.lang.Double getAttractionStrength()
Returns:
the attractionStrength

setAttractionStrength

public void setAttractionStrength(java.lang.Double attractionStrength)
Parameters:
attractionStrength - the attractionStrength to set

getMaxDisplacement

public java.lang.Double getMaxDisplacement()
Returns:
the maxDisplacement

setMaxDisplacement

public void setMaxDisplacement(java.lang.Double maxDisplacement)
Parameters:
maxDisplacement - the maxDisplacement to set

isFreezeBalance

public java.lang.Boolean isFreezeBalance()
Returns:
the freezeBalance

setFreezeBalance

public void setFreezeBalance(java.lang.Boolean freezeBalance)
Parameters:
freezeBalance - the freezeBalance to set

getFreezeStrength

public java.lang.Double getFreezeStrength()
Returns:
the freezeStrength

setFreezeStrength

public void setFreezeStrength(java.lang.Double freezeStrength)
Parameters:
freezeStrength - the freezeStrength to set

getFreezeInertia

public java.lang.Double getFreezeInertia()
Returns:
the freezeInertia

setFreezeInertia

public void setFreezeInertia(java.lang.Double freezeInertia)
Parameters:
freezeInertia - the freezeInertia to set

getGravity

public java.lang.Double getGravity()
Returns:
the gravity

setGravity

public void setGravity(java.lang.Double gravity)
Parameters:
gravity - the gravity to set

getSpeed

public java.lang.Double getSpeed()
Returns:
the speed

setSpeed

public void setSpeed(java.lang.Double speed)
Parameters:
speed - the speed to set

getCooling

public java.lang.Double getCooling()
Returns:
the cooling

setCooling

public void setCooling(java.lang.Double cooling)
Parameters:
cooling - the cooling to set

isOutboundAttractionDistribution

public java.lang.Boolean isOutboundAttractionDistribution()
Returns:
the outboundAttractionDistribution

setOutboundAttractionDistribution

public void setOutboundAttractionDistribution(java.lang.Boolean outboundAttractionDistribution)
Parameters:
outboundAttractionDistribution - the outboundAttractionDistribution to set

isAdjustSizes

public java.lang.Boolean isAdjustSizes()
Returns:
the adjustSizes

setAdjustSizes

public void setAdjustSizes(java.lang.Boolean adjustSizes)
Parameters:
adjustSizes - the adjustSizes to set

Gephi Toolkit Javadoc