Gephi Toolkit Javadoc

org.gephi.layout.plugin.forceAtlas2
Class ForceAtlas2

java.lang.Object
  extended by org.gephi.layout.plugin.forceAtlas2.ForceAtlas2
All Implemented Interfaces:
Layout

public class ForceAtlas2
extends java.lang.Object
implements Layout

ForceAtlas 2 Layout, manages each step of the computations.

Author:
Mathieu Jacomy

Constructor Summary
ForceAtlas2(ForceAtlas2Builder 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 getBarnesHutTheta()
           
 LayoutBuilder getBuilder()
          The reference to the LayoutBuilder that instanciated this Layout.
 java.lang.Double getEdgeWeightInfluence()
           
 java.lang.Double getGravity()
           
 java.lang.Double getJitterTolerance()
           
 LayoutProperty[] getProperties()
          The properties for this layout.
 java.lang.Double getScalingRatio()
           
 java.lang.Integer getThreadsCount()
           
 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 isBarnesHutOptimize()
           
 java.lang.Boolean isLinLogMode()
           
 java.lang.Boolean isOutboundAttractionDistribution()
           
 java.lang.Boolean isStrongGravityMode()
           
 void resetPropertiesValues()
          Resets the properties values to the default values.
 void setAdjustSizes(java.lang.Boolean adjustSizes)
           
 void setBarnesHutOptimize(java.lang.Boolean barnesHutOptimize)
           
 void setBarnesHutTheta(java.lang.Double barnesHutTheta)
           
 void setEdgeWeightInfluence(java.lang.Double edgeWeightInfluence)
           
 void setGraphModel(GraphModel graphModel)
          Injects the graph model for the graph this Layout should operate on.
 void setGravity(java.lang.Double gravity)
           
 void setJitterTolerance(java.lang.Double jitterTolerance)
           
 void setLinLogMode(java.lang.Boolean linLogMode)
           
 void setOutboundAttractionDistribution(java.lang.Boolean outboundAttractionDistribution)
           
 void setScalingRatio(java.lang.Double scalingRatio)
           
 void setStrongGravityMode(java.lang.Boolean strongGravityMode)
           
 void setThreadsCount(java.lang.Integer threadCount)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ForceAtlas2

public ForceAtlas2(ForceAtlas2Builder layoutBuilder)
Method Detail

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

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
Returns:
true if the algorithm can run, false otherwise

endAlgo

public void endAlgo()
Description copied from interface: Layout
Called when the algorithm is finished (canAlgo() returns false).

Specified by:
endAlgo in interface Layout

getProperties

public LayoutProperty[] getProperties()
Description copied from interface: Layout
The properties for this layout.

Specified by:
getProperties in interface Layout
Returns:
the layout properties

resetPropertiesValues

public void resetPropertiesValues()
Description copied from interface: Layout
Resets the properties values to the default values.

Specified by:
resetPropertiesValues in interface Layout

getBuilder

public LayoutBuilder getBuilder()
Description copied from interface: Layout
The reference to the LayoutBuilder that instanciated this Layout.

Specified by:
getBuilder in interface Layout
Returns:
the reference to the builder that builts this instance

setGraphModel

public void setGraphModel(GraphModel graphModel)
Description copied from interface: Layout
Injects the graph model for the graph this Layout should operate on.

It's preferable to get visible graph to perform on visualization.

Specified by:
setGraphModel in interface Layout
Parameters:
graphModel - the graph model that the layout is to be working on

getBarnesHutTheta

public java.lang.Double getBarnesHutTheta()

setBarnesHutTheta

public void setBarnesHutTheta(java.lang.Double barnesHutTheta)

getEdgeWeightInfluence

public java.lang.Double getEdgeWeightInfluence()

setEdgeWeightInfluence

public void setEdgeWeightInfluence(java.lang.Double edgeWeightInfluence)

getJitterTolerance

public java.lang.Double getJitterTolerance()

setJitterTolerance

public void setJitterTolerance(java.lang.Double jitterTolerance)

isLinLogMode

public java.lang.Boolean isLinLogMode()

setLinLogMode

public void setLinLogMode(java.lang.Boolean linLogMode)

getScalingRatio

public java.lang.Double getScalingRatio()

setScalingRatio

public void setScalingRatio(java.lang.Double scalingRatio)

isStrongGravityMode

public java.lang.Boolean isStrongGravityMode()

setStrongGravityMode

public void setStrongGravityMode(java.lang.Boolean strongGravityMode)

getGravity

public java.lang.Double getGravity()

setGravity

public void setGravity(java.lang.Double gravity)

getThreadsCount

public java.lang.Integer getThreadsCount()

setThreadsCount

public void setThreadsCount(java.lang.Integer threadCount)

isOutboundAttractionDistribution

public java.lang.Boolean isOutboundAttractionDistribution()

setOutboundAttractionDistribution

public void setOutboundAttractionDistribution(java.lang.Boolean outboundAttractionDistribution)

isAdjustSizes

public java.lang.Boolean isAdjustSizes()

setAdjustSizes

public void setAdjustSizes(java.lang.Boolean adjustSizes)

isBarnesHutOptimize

public java.lang.Boolean isBarnesHutOptimize()

setBarnesHutOptimize

public void setBarnesHutOptimize(java.lang.Boolean barnesHutOptimize)

Gephi Toolkit Javadoc