Gephi Toolkit Javadoc

org.gephi.layout.plugin.multilevel
Class MultiLevelLayout

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

public class MultiLevelLayout
extends AbstractLayout
implements Layout

Author:
Helder Suzuki

Nested Class Summary
static interface MultiLevelLayout.CoarseningStrategy
           
 
Field Summary
 
Fields inherited from class org.gephi.layout.plugin.AbstractLayout
dynamicModel, graphModel
 
Constructor Summary
MultiLevelLayout(LayoutBuilder layoutBuilder, MultiLevelLayout.CoarseningStrategy coarseningStrategy)
           
 
Method Summary
 void endAlgo()
          Called when the algorithm is finished (canAlgo() returns false).
 java.lang.Float getBarnesHutTheta()
           
 java.lang.Double getMinCoarseningRate()
           
 java.lang.Integer getMinSize()
           
 java.lang.Float getOptimalDistance()
           
 LayoutProperty[] getProperties()
          The properties for this layout.
 java.lang.Integer getQuadTreeMaxLevel()
           
 java.lang.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).
 void resetPropertiesValues()
          Resets the properties values to the default values.
 void setBarnesHutTheta(java.lang.Float barnesHutTheta)
           
 void setMinCoarseningRate(java.lang.Double minCoarseningRate)
           
 void setMinSize(java.lang.Integer minSize)
           
 void setOptimalDistance(java.lang.Float optimalDistance)
           
 void setQuadTreeMaxLevel(java.lang.Integer quadTreeMaxLevel)
           
 void setStepRatio(java.lang.Float stepRatio)
           
 
Methods inherited from class org.gephi.layout.plugin.AbstractLayout
canAlgo, 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
canAlgo, getBuilder, setGraphModel
 

Constructor Detail

MultiLevelLayout

public MultiLevelLayout(LayoutBuilder layoutBuilder,
                        MultiLevelLayout.CoarseningStrategy coarseningStrategy)
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

endAlgo

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

Specified by:
endAlgo in interface Layout

resetPropertiesValues

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

Specified by:
resetPropertiesValues 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

getMinSize

public java.lang.Integer getMinSize()
Returns:
the minSize

setMinSize

public void setMinSize(java.lang.Integer minSize)
Parameters:
minSize - the minSize to set

getMinCoarseningRate

public java.lang.Double getMinCoarseningRate()
Returns:
the minCoarseningRate

setMinCoarseningRate

public void setMinCoarseningRate(java.lang.Double minCoarseningRate)
Parameters:
minCoarseningRate - the minCoarseningRate to set

getStepRatio

public java.lang.Float getStepRatio()
Returns:
the stepRatio

setStepRatio

public void setStepRatio(java.lang.Float stepRatio)
Parameters:
stepRatio - the stepRatio to set

getOptimalDistance

public java.lang.Float getOptimalDistance()
Returns:
the optimalDistance

setOptimalDistance

public void setOptimalDistance(java.lang.Float optimalDistance)
Parameters:
optimalDistance - the optimalDistance to set

getQuadTreeMaxLevel

public java.lang.Integer getQuadTreeMaxLevel()
Returns:
the quadTreeMaxLevel

setQuadTreeMaxLevel

public void setQuadTreeMaxLevel(java.lang.Integer quadTreeMaxLevel)
Parameters:
quadTreeMaxLevel - the quadTreeMaxLevel to set

getBarnesHutTheta

public java.lang.Float getBarnesHutTheta()
Returns:
the barnesHutTheta

setBarnesHutTheta

public void setBarnesHutTheta(java.lang.Float barnesHutTheta)
Parameters:
barnesHutTheta - the barnesHutTheta to set

Gephi Toolkit Javadoc