Class LayoutAlgorithmBase<TVertex, TEdge, TGraph>

Base class for all ILayoutAlgorithm<TVertex, TEdge, TGraph> implementations.

Inheritance
System.Object
AlgorithmBase
LayoutAlgorithmBase<TVertex, TEdge, TGraph>
LayoutAlgorithmBase<TVertex, TEdge, TGraph, TVertexInfo, TEdgeInfo>
ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, TParameters>
Implements
ILayoutAlgorithm<TVertex, TEdge, TGraph>
QuikGraph.Algorithms.IAlgorithm<TGraph>
QuikGraph.Algorithms.IComputation
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GraphShape.Algorithms.Layout
Assembly: GraphShape.dll
Syntax
public abstract class LayoutAlgorithmBase<TVertex, TEdge, TGraph> : AlgorithmBase, IAlgorithm, ILayoutAlgorithm<TVertex, TEdge, TGraph>, IAlgorithm<TGraph>, IComputation where TEdge : IEdge<TVertex> where TGraph : IVertexAndEdgeListGraph<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TGraph

Graph type.

Constructors

| Improve this Doc View Source

LayoutAlgorithmBase(TGraph)

Initializes a new instance of the LayoutAlgorithmBase<TVertex, TEdge, TGraph> class.

Declaration
protected LayoutAlgorithmBase(TGraph visitedGraph)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
| Improve this Doc View Source

LayoutAlgorithmBase(TGraph, IDictionary<TVertex, Point>)

Initializes a new instance of the LayoutAlgorithmBase<TVertex, TEdge, TGraph> class.

Declaration
protected LayoutAlgorithmBase(TGraph visitedGraph, IDictionary<TVertex, Point> verticesPositions)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
System.Collections.Generic.IDictionary<TVertex, Point> verticesPositions

Vertices positions.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.

Properties

| Improve this Doc View Source

ReportOnIterationEndNeeded

Indicates if there is any watcher on iterations ends.

Declaration
public virtual bool ReportOnIterationEndNeeded { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ReportOnProgressChangedNeeded

Indicates if there is any watcher on algorithm progress.

Declaration
public bool ReportOnProgressChangedNeeded { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

VerticesPositions

Vertices positions associations.

Declaration
public IDictionary<TVertex, Point> VerticesPositions { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TVertex, Point>
| Improve this Doc View Source

VisitedGraph

Declaration
public TGraph VisitedGraph { get; }
Property Value
Type Description
TGraph

Methods

| Improve this Doc View Source

GetEdgeInfo(TEdge)

Returns the extra layout information of the edge (or null).

Declaration
public virtual object GetEdgeInfo(TEdge edge)
Parameters
Type Name Description
TEdge edge
Returns
Type Description
System.Object
| Improve this Doc View Source

GetVertexInfo(TVertex)

Returns the extra layout information of the vertex (or null).

Declaration
public virtual object GetVertexInfo(TVertex vertex)
Parameters
Type Name Description
TVertex vertex
Returns
Type Description
System.Object
| Improve this Doc View Source

OnIterationEnded(ILayoutIterationEventArgs<TVertex>)

Called when a layout iteration has ended.

Declaration
protected virtual void OnIterationEnded(ILayoutIterationEventArgs<TVertex> args)
Parameters
Type Name Description
ILayoutIterationEventArgs<TVertex> args

Event arguments.
| Improve this Doc View Source

OnProgressChanged(Double)

Called when some progress was made in layout algorithm.

Declaration
protected virtual void OnProgressChanged(double percent)
Parameters
Type Name Description
System.Double percent

New progress percentage.

Events

| Improve this Doc View Source

IterationEnded

Fired when a layout iteration has been done.

Declaration
public event LayoutIterationEndedEventHandler<TVertex> IterationEnded
Event Type
Type Description
LayoutIterationEndedEventHandler<TVertex>
| Improve this Doc View Source

ProgressChanged

Fired when layout algorithm progress changed.

Declaration
public event ProgressChangedEventHandler ProgressChanged
Event Type
Type Description
ProgressChangedEventHandler

Implements

QuikGraph.Algorithms.IAlgorithm<TGraph>
QuikGraph.Algorithms.IComputation

Extension Methods