Class CompoundFDPLayoutAlgorithm<TVertex, TEdge, TGraph>

Compound FDP layout algorithm.

Inheritance
System.Object
AlgorithmBase
LayoutAlgorithmBase<TVertex, TEdge, TGraph>
ParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, CompoundFDPLayoutParameters>
DefaultParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, CompoundFDPLayoutParameters>
CompoundFDPLayoutAlgorithm<TVertex, TEdge, TGraph>
Implements
IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph>
ICompoundLayoutAlgorithm<TVertex, TEdge, TGraph>
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 class CompoundFDPLayoutAlgorithm<TVertex, TEdge, TGraph> : DefaultParameterizedLayoutAlgorithmBase<TVertex, TEdge, TGraph, CompoundFDPLayoutParameters>, IAlgorithm, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph, CompoundFDPLayoutParameters>, IParameterizedLayoutAlgorithm<TVertex, TEdge, TGraph>, ICompoundLayoutAlgorithm<TVertex, TEdge, TGraph>, ILayoutAlgorithm<TVertex, TEdge, TGraph>, IAlgorithm<TGraph>, IComputation where TVertex : class where TEdge : IEdge<TVertex> where TGraph : IBidirectionalGraph<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TGraph

Graph type.

Constructors

| Improve this Doc View Source

CompoundFDPLayoutAlgorithm(TGraph, IDictionary<TVertex, Point>, IDictionary<TVertex, Size>, IDictionary<TVertex, Thickness>, IDictionary<TVertex, CompoundVertexInnerLayoutType>, CompoundFDPLayoutParameters)

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

Declaration
public CompoundFDPLayoutAlgorithm(TGraph visitedGraph, IDictionary<TVertex, Point> verticesPositions, IDictionary<TVertex, Size> verticesSizes, IDictionary<TVertex, Thickness> verticesBorders, IDictionary<TVertex, CompoundVertexInnerLayoutType> layoutTypes, CompoundFDPLayoutParameters parameters = null)
Parameters
Type Name Description
TGraph visitedGraph

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

Vertices positions.
System.Collections.Generic.IDictionary<TVertex, Size> verticesSizes

Vertices sizes.
System.Collections.Generic.IDictionary<TVertex, Thickness> verticesBorders

Vertices borders.
System.Collections.Generic.IDictionary<TVertex, CompoundVertexInnerLayoutType> layoutTypes

Layout types per vertex.
CompoundFDPLayoutParameters parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
System.ArgumentNullException

verticesSizes is null.
System.ArgumentNullException

verticesBorders is null.
System.ArgumentNullException

layoutTypes is null.
| Improve this Doc View Source

CompoundFDPLayoutAlgorithm(TGraph, IDictionary<TVertex, Size>, IDictionary<TVertex, Thickness>, IDictionary<TVertex, CompoundVertexInnerLayoutType>, CompoundFDPLayoutParameters)

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

Declaration
public CompoundFDPLayoutAlgorithm(TGraph visitedGraph, IDictionary<TVertex, Size> verticesSizes, IDictionary<TVertex, Thickness> verticesBorders, IDictionary<TVertex, CompoundVertexInnerLayoutType> layoutTypes, CompoundFDPLayoutParameters parameters = null)
Parameters
Type Name Description
TGraph visitedGraph

Graph to layout.
System.Collections.Generic.IDictionary<TVertex, Size> verticesSizes

Vertices sizes.
System.Collections.Generic.IDictionary<TVertex, Thickness> verticesBorders

Vertices borders.
System.Collections.Generic.IDictionary<TVertex, CompoundVertexInnerLayoutType> layoutTypes

Layout types per vertex.
CompoundFDPLayoutParameters parameters

Optional algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

visitedGraph is null.
System.ArgumentNullException

verticesSizes is null.
System.ArgumentNullException

verticesBorders is null.
System.ArgumentNullException

layoutTypes is null.

Properties

| Improve this Doc View Source

InnerCanvasSizes

Inner canvas vertices sizes.

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

Levels

The levels of the graph (generated by the containment associations).

Declaration
public IList<HashSet<TVertex>> Levels { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Collections.Generic.HashSet<TVertex>>

Methods

| Improve this Doc View Source

ApplyApplicationSpecificForces()

Applies the application specific forces to the vertices.

Declaration
protected virtual void ApplyApplicationSpecificForces()
| Improve this Doc View Source

Initialize()

Called on algorithm initialization step.

Declaration
protected override void Initialize()
Overrides
| Improve this Doc View Source

InternalCompute()

Algorithm compute step.

Declaration
protected override void InternalCompute()
Overrides
| Improve this Doc View Source

LevelOfVertex(TVertex)

Gets the level of a given vertex.

Declaration
public int LevelOfVertex(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

Vertex to get its level.
Returns
Type Description
System.Int32

Vertex level.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
QuikGraph.VertexNotFoundException

vertex is not part of the VisitedGraph.

Implements

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

Extension Methods