org.gephi.layout.plugin

Class AbstractLayout

java.lang.Object

org.gephi.layout.plugin.AbstractLayout

All Implemented Interfaces:

Layout

Direct Known Subclasses:

AbstractScaleLayout, ForceAtlasLayout, FruchtermanReingold, LabelAdjust, NoverlapLayout, RandomLayout, RotateLayout, YifanHuLayout

public abstract class AbstractLayout
extends Object
implements Layout

Base class for layout algorithms.

Author:

Helder Suzuki

Constructor Summary

Constructors

Constructor and Description
AbstractLayout(LayoutBuilder layoutBuilder)

Method Summary

Modifier and Type	Method and Description
boolean	canAlgo() Tests if the algorithm can run, called before each pass.
static void	ensureSafeLayoutNodePositions(org.gephi.graph.api.GraphModel graphModel) See https://github.com/gephi/gephi/issues/603 Nodes position to NaN on applied layout
LayoutBuilder	getBuilder() The reference to the LayoutBuilder that instanciated this Layout.
boolean	isConverged()
void	setConverged(boolean converged)
void	setGraphModel(org.gephi.graph.api.GraphModel graphModel) Injects the graph model for the graph this Layout should operate on.

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

endAlgo, getProperties, goAlgo, initAlgo, resetPropertiesValues

Constructor Detail

AbstractLayout

public AbstractLayout(LayoutBuilder layoutBuilder)

Method Detail

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

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

setConverged

public void setConverged(boolean converged)

isConverged

public boolean isConverged()

ensureSafeLayoutNodePositions

public static void ensureSafeLayoutNodePositions(org.gephi.graph.api.GraphModel graphModel)

See https://github.com/gephi/gephi/issues/603 Nodes position to NaN on applied layout

Parameters:

graphModel -