ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSimple2DLayoutStrategy Class Reference

vtkSimple2DLayoutStrategy - a simple 2D graph layout More...

Inheritance diagram for Kitware.VTK.vtkSimple2DLayoutStrategy:
[legend]
Collaboration diagram for Kitware.VTK.vtkSimple2DLayoutStrategy:
[legend]

List of all members.

Public Member Functions

 vtkSimple2DLayoutStrategy (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSimple2DLayoutStrategy ()
 Undocumented Block.
virtual double GetCoolDownRate ()
 Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
virtual double GetCoolDownRateMaxValue ()
 Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
virtual double GetCoolDownRateMinValue ()
 Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
virtual float GetInitialTemperature ()
 Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual float GetInitialTemperatureMaxValue ()
 Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual float GetInitialTemperatureMinValue ()
 Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual int GetIterationsPerLayout ()
 Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)
virtual int GetIterationsPerLayoutMaxValue ()
 Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)
virtual int GetIterationsPerLayoutMinValue ()
 Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)
virtual bool GetJitter ()
 Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON.
virtual int GetMaxNumberOfIterations ()
 Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual int GetMaxNumberOfIterationsMaxValue ()
 Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual int GetMaxNumberOfIterationsMinValue ()
 Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual int GetRandomSeed ()
 Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.
virtual int GetRandomSeedMaxValue ()
 Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.
virtual int GetRandomSeedMinValue ()
 Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.
virtual float GetRestDistance ()
 Manually set the resting distance. Otherwise the distance is computed automatically.
override void Initialize ()
 This strategy sets up some data structures for faster processing of each Layout() call.
override int IsA (string type)
 Undocumented Block.
override int IsLayoutComplete ()
 I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
override void Layout ()
 This is the layout method where the graph that was set in SetGraph() is laid out. The method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout please implement the IsLayoutComplete() method.
new vtkSimple2DLayoutStrategy NewInstance ()
 Undocumented Block.
virtual void SetCoolDownRate (double _arg)
 Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)
virtual void SetInitialTemperature (float _arg)
 Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual void SetIterationsPerLayout (int _arg)
 Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)
virtual void SetJitter (bool _arg)
 Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON.
virtual void SetMaxNumberOfIterations (int _arg)
 Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)
virtual void SetRandomSeed (int _arg)
 Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.
virtual void SetRestDistance (float _arg)
 Manually set the resting distance. Otherwise the distance is computed automatically.

Static Public Member Functions

static new
vtkSimple2DLayoutStrategy 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkSimple2DLayoutStrategy 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSimple2DLayoutStrategy"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "25vtkSimple2DLayoutStrategy"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkSimple2DLayoutStrategy_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkSimple2DLayoutStrategy_GetCoolDownRate_01 (HandleRef pThis)
static internal double vtkSimple2DLayoutStrategy_GetCoolDownRateMaxValue_02 (HandleRef pThis)
static internal double vtkSimple2DLayoutStrategy_GetCoolDownRateMinValue_03 (HandleRef pThis)
static internal float vtkSimple2DLayoutStrategy_GetInitialTemperature_04 (HandleRef pThis)
static internal float vtkSimple2DLayoutStrategy_GetInitialTemperatureMaxValue_05 (HandleRef pThis)
static internal float vtkSimple2DLayoutStrategy_GetInitialTemperatureMinValue_06 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetIterationsPerLayout_07 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetIterationsPerLayoutMaxValue_08 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetIterationsPerLayoutMinValue_09 (HandleRef pThis)
static internal byte vtkSimple2DLayoutStrategy_GetJitter_10 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetMaxNumberOfIterations_11 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetMaxNumberOfIterationsMaxValue_12 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetMaxNumberOfIterationsMinValue_13 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetRandomSeed_14 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetRandomSeedMaxValue_15 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_GetRandomSeedMinValue_16 (HandleRef pThis)
static internal float vtkSimple2DLayoutStrategy_GetRestDistance_17 (HandleRef pThis)
static internal void vtkSimple2DLayoutStrategy_Initialize_18 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_IsA_19 (HandleRef pThis, string type)
static internal int vtkSimple2DLayoutStrategy_IsLayoutComplete_20 (HandleRef pThis)
static internal int vtkSimple2DLayoutStrategy_IsTypeOf_21 (string type)
static internal void vtkSimple2DLayoutStrategy_Layout_22 (HandleRef pThis)
static internal IntPtr vtkSimple2DLayoutStrategy_NewInstance_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSimple2DLayoutStrategy_SafeDownCast_25 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSimple2DLayoutStrategy_SetCoolDownRate_26 (HandleRef pThis, double _arg)
static internal void vtkSimple2DLayoutStrategy_SetInitialTemperature_27 (HandleRef pThis, float _arg)
static internal void vtkSimple2DLayoutStrategy_SetIterationsPerLayout_28 (HandleRef pThis, int _arg)
static internal void vtkSimple2DLayoutStrategy_SetJitter_29 (HandleRef pThis, byte _arg)
static internal void vtkSimple2DLayoutStrategy_SetMaxNumberOfIterations_30 (HandleRef pThis, int _arg)
static internal void vtkSimple2DLayoutStrategy_SetRandomSeed_31 (HandleRef pThis, int _arg)
static internal void vtkSimple2DLayoutStrategy_SetRestDistance_32 (HandleRef pThis, float _arg)

Static Private Member Functions

static vtkSimple2DLayoutStrategy ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSimple2DLayoutStrategy - a simple 2D graph layout

Description This class is an implementation of the work presented in: Fruchterman & Reingold "Graph Drawing by Force-directed Placement" Software-Practice and Experience 21(11) 1991). The class includes some optimizations but nothing too fancy.

Thanks Thanks to Brian Wylie from Sandia National Laboratories for creating this class.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkSimple2DLayoutStrategy.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON.

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

Manually set the resting distance. Otherwise the distance is computed automatically.

This strategy sets up some data structures for faster processing of each Layout() call.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

override int Kitware.VTK.vtkSimple2DLayoutStrategy.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

static new int Kitware.VTK.vtkSimple2DLayoutStrategy.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

override void Kitware.VTK.vtkSimple2DLayoutStrategy.Layout ( ) [virtual]

This is the layout method where the graph that was set in SetGraph() is laid out. The method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout please implement the IsLayoutComplete() method.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSimple2DLayoutStrategy.SetCoolDownRate ( double  _arg) [virtual]

Set/Get the Cool-down rate. The higher this number is, the longer it will take to "cool-down", and thus, the more the graph will be modified. The default is '10' for no particular reason. Note: The strong recommendation is that you do not change this parameter. :)

virtual void Kitware.VTK.vtkSimple2DLayoutStrategy.SetInitialTemperature ( float  _arg) [virtual]

Set the initial temperature. The temperature default is '5' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

Set/Get the number of iterations per layout. The only use for this ivar is for the application to do visualizations of the layout before it's complete. The default is '100' to match the default 'MaxNumberOfIterations' Note: Changing this parameter is just fine :)

virtual void Kitware.VTK.vtkSimple2DLayoutStrategy.SetJitter ( bool  _arg) [virtual]

Set Random jitter of the nodes at initialization to on or off. Note: It's strongly recommendation to have jitter ON even if you have initial coordinates in your graph. Default is ON.

Set/Get the maximum number of iterations to be used. The higher this number, the more iterations through the algorithm is possible, and thus, the more the graph gets modified. The default is '100' for no particular reason Note: The strong recommendation is that you do not change this parameter. :)

virtual void Kitware.VTK.vtkSimple2DLayoutStrategy.SetRandomSeed ( int  _arg) [virtual]

Seed the random number generator used to jitter point positions. This has a significant effect on their final positions when the layout is complete.

virtual void Kitware.VTK.vtkSimple2DLayoutStrategy.SetRestDistance ( float  _arg) [virtual]

Manually set the resting distance. Otherwise the distance is computed automatically.

static internal double Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_GetCoolDownRate_01 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_GetJitter_10 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_GetRestDistance_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_Initialize_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_IsA_19 ( HandleRef  pThis,
string  type 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_Layout_22 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_NewInstance_24 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SafeDownCast_25 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetCoolDownRate_26 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetInitialTemperature_27 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetIterationsPerLayout_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetJitter_29 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetMaxNumberOfIterations_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetRandomSeed_31 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSimple2DLayoutStrategy.vtkSimple2DLayoutStrategy_SetRestDistance_32 ( HandleRef  pThis,
float  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSimple2DLayoutStrategy.MRClassNameKey = "25vtkSimple2DLayoutStrategy" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

new const string Kitware.VTK.vtkSimple2DLayoutStrategy.MRFullTypeName = "Kitware.VTK.vtkSimple2DLayoutStrategy"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.


The documentation for this class was generated from the following file: