org.gephi.layout.plugin.force.yifanHu

Class YifanHuLayout

java.lang.Object

org.gephi.layout.plugin.AbstractLayout

org.gephi.layout.plugin.force.yifanHu.YifanHuLayout

All Implemented Interfaces:

Layout

public class YifanHuLayout
extends AbstractLayout
implements Layout

Hu's basic algorithm

Author:

Helder Suzuki

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	YifanHuLayout.ElectricalForce Fr = -C*K*K*(n2-n1)/||n2-n1||
class	YifanHuLayout.SpringForce Fa = (n2 - n1) * ||n2 - n1|| / K

Constructor Summary

Constructors

Constructor and Description
YifanHuLayout(LayoutBuilder layoutBuilder, Displacement displacement)

Method Summary

Modifier and Type	Method and Description
void	endAlgo() Called when the algorithm is finished (canAlgo() returns false).
float	getAverageEdgeLength(org.gephi.graph.api.Graph graph)
Float	getBarnesHutTheta()
Float	getConvergenceThreshold()
Float	getInitialStep()
Float	getOptimalDistance()
LayoutProperty[]	getProperties() The properties for this layout.
Integer	getQuadTreeMaxLevel()
Float	getRelativeStrength()
Float	getStepRatio()
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	isAdaptiveCooling()
void	resetPropertiesValues() Resets the properties values to the default values.
void	setAdaptiveCooling(Boolean adaptiveCooling)
void	setBarnesHutTheta(Float barnesHutTheta)
void	setConvergenceThreshold(Float convergenceThreshold)
void	setInitialStep(Float initialStep)
void	setOptimalDistance(Float optimalDistance)
void	setQuadTreeMaxLevel(Integer quadTreeMaxLevel)
void	setRelativeStrength(Float relativeStrength)
void	setStep(Float step)
void	setStepRatio(Float stepRatio)

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

canAlgo, 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

canAlgo, getBuilder, setGraphModel

Constructor Detail

YifanHuLayout

public YifanHuLayout(LayoutBuilder layoutBuilder,
                     Displacement displacement)

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

getAverageEdgeLength

public float getAverageEdgeLength(org.gephi.graph.api.Graph graph)

getProperties

public LayoutProperty[] getProperties()

Description copied from interface: Layout

The properties for this layout.

Specified by:

getProperties in interface Layout

Returns:

the layout properties

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

endAlgo

public void endAlgo()

Description copied from interface: Layout

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

Specified by:

endAlgo 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

getQuadTreeMaxLevel

public Integer getQuadTreeMaxLevel()

setQuadTreeMaxLevel

public void setQuadTreeMaxLevel(Integer quadTreeMaxLevel)

getBarnesHutTheta

public Float getBarnesHutTheta()

setBarnesHutTheta

public void setBarnesHutTheta(Float barnesHutTheta)

getOptimalDistance

public Float getOptimalDistance()

Returns:

the optimalDistance

setOptimalDistance

public void setOptimalDistance(Float optimalDistance)

Parameters:

optimalDistance - the optimalDistance to set

getRelativeStrength

public Float getRelativeStrength()

Returns:

the relativeStrength

setRelativeStrength

public void setRelativeStrength(Float relativeStrength)

Parameters:

relativeStrength - the relativeStrength to set

setStep

public void setStep(Float step)

Parameters:

step - the step to set

isAdaptiveCooling

public Boolean isAdaptiveCooling()

Returns:

the adaptiveCooling

setAdaptiveCooling

public void setAdaptiveCooling(Boolean adaptiveCooling)

Parameters:

adaptiveCooling - the adaptiveCooling to set

getStepRatio

public Float getStepRatio()

Returns:

the stepRatio

setStepRatio

public void setStepRatio(Float stepRatio)

Parameters:

stepRatio - the stepRatio to set

getConvergenceThreshold

public Float getConvergenceThreshold()

Returns:

the convergenceThreshold

setConvergenceThreshold

public void setConvergenceThreshold(Float convergenceThreshold)

Parameters:

convergenceThreshold - the convergenceThreshold to set

getInitialStep

public Float getInitialStep()

Returns:

the initialStep

setInitialStep

public void setInitialStep(Float initialStep)

Parameters:

initialStep - the initialStep to set