org.gephi.layout.plugin.forceAtlas2

Class ForceAtlas2

java.lang.Object

org.gephi.layout.plugin.forceAtlas2.ForceAtlas2

All Implemented Interfaces:

Layout

public class ForceAtlas2
extends Object
implements Layout

ForceAtlas 2 Layout, manages each step of the computations.

Author:

Mathieu Jacomy

Constructor Summary

Constructors

Constructor and Description
ForceAtlas2(ForceAtlas2Builder 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	getBarnesHutTheta()
LayoutBuilder	getBuilder() The reference to the LayoutBuilder that instanciated this Layout.
Double	getEdgeWeightInfluence()
Double	getGravity()
Double	getJitterTolerance()
LayoutProperty[]	getProperties() The properties for this layout.
Double	getScalingRatio()
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).
Boolean	isAdjustSizes()
Boolean	isBarnesHutOptimize()
Boolean	isLinLogMode()
Boolean	isOutboundAttractionDistribution()
Boolean	isStrongGravityMode()
void	resetPropertiesValues() Resets the properties values to the default values.
void	setAdjustSizes(Boolean adjustSizes)
void	setBarnesHutOptimize(Boolean barnesHutOptimize)
void	setBarnesHutTheta(Double barnesHutTheta)
void	setEdgeWeightInfluence(Double edgeWeightInfluence)
void	setGraphModel(org.gephi.graph.api.GraphModel graphModel) Injects the graph model for the graph this Layout should operate on.
void	setGravity(Double gravity)
void	setJitterTolerance(Double jitterTolerance)
void	setLinLogMode(Boolean linLogMode)
void	setOutboundAttractionDistribution(Boolean outboundAttractionDistribution)
void	setScalingRatio(Double scalingRatio)
void	setStrongGravityMode(Boolean strongGravityMode)
void	setThreadsCount(Integer threadCount)

Methods inherited from class java.lang.Object

equals, 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(org.gephi.graph.api.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 Double getBarnesHutTheta()

setBarnesHutTheta

public void setBarnesHutTheta(Double barnesHutTheta)

getEdgeWeightInfluence

public Double getEdgeWeightInfluence()

setEdgeWeightInfluence

public void setEdgeWeightInfluence(Double edgeWeightInfluence)

getJitterTolerance

public Double getJitterTolerance()

setJitterTolerance

public void setJitterTolerance(Double jitterTolerance)

isLinLogMode

public Boolean isLinLogMode()

setLinLogMode

public void setLinLogMode(Boolean linLogMode)

getScalingRatio

public Double getScalingRatio()

setScalingRatio

public void setScalingRatio(Double scalingRatio)

isStrongGravityMode

public Boolean isStrongGravityMode()

setStrongGravityMode

public void setStrongGravityMode(Boolean strongGravityMode)

getGravity

public Double getGravity()

setGravity

public void setGravity(Double gravity)

getThreadsCount

public Integer getThreadsCount()

setThreadsCount

public void setThreadsCount(Integer threadCount)

isOutboundAttractionDistribution

public Boolean isOutboundAttractionDistribution()

setOutboundAttractionDistribution

public void setOutboundAttractionDistribution(Boolean outboundAttractionDistribution)

isAdjustSizes

public Boolean isAdjustSizes()

setAdjustSizes

public void setAdjustSizes(Boolean adjustSizes)

isBarnesHutOptimize

public Boolean isBarnesHutOptimize()

setBarnesHutOptimize

public void setBarnesHutOptimize(Boolean barnesHutOptimize)