C# Class Smrf.NodeXL.Layouts.SinusoidLayout

Lays out a graph by placing the vertices on a horizontal or vertical sine wave.
This layout places a graph's vertices on one cycle of a sine wave that spans the rectangle either horizontally or vertically.

If the graph has a metadata key of , only the vertices specified in the value's IVertex array are laid out and all other vertices are completely ignored.

If a vertex has a metadata key of , it is included in layout calculations but its own location is left unmodified.

If you want the vertices to be placed in a certain order, set the property to an object that will sort them.

Inheritance: SortableLayoutBase
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_bIsHorizontal System.Boolean
m_dCycleLength Double

Public Methods

Method Description
AssertValid ( ) : void
SinusoidLayout ( System.Boolean isHorizontal, Double cycleLength ) : System

Initializes a new instance of the SinusoidLayout class.

Protected Methods

Method Description
LayOutGraphCoreSorted ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

LayOutGraphCoreSorted() protected method

protected LayOutGraphCoreSorted ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean
graph IGraph
verticesToLayOut ICollection
layoutContext LayoutContext
backgroundWorker System.ComponentModel.BackgroundWorker
return System.Boolean

SinusoidLayout() public method

Initializes a new instance of the SinusoidLayout class.
public SinusoidLayout ( System.Boolean isHorizontal, Double cycleLength ) : System
isHorizontal System.Boolean /// true for a sine wave that runs from left to right, false for top to /// bottom. ///
cycleLength Double /// Length of the sine wave cycle, in radians. ///
return System

Property Details

m_bIsHorizontal protected property

protected Boolean,System m_bIsHorizontal
return System.Boolean

m_dCycleLength protected property

protected Double m_dCycleLength
return Double