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.vtkCommunity2DLayoutStrategy Class Reference

vtkCommunity2DLayoutStrategy - a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community. More...

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

List of all members.

Public Member Functions

 vtkCommunity2DLayoutStrategy (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCommunity2DLayoutStrategy ()
 Undocumented Block.
virtual string GetCommunityArrayName ()
 Get/Set the community array name.
virtual float GetCommunityStrength ()
 Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.
virtual float GetCommunityStrengthMaxValue ()
 Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.
virtual float GetCommunityStrengthMinValue ()
 Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.
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 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 vtkCommunity2DLayoutStrategy NewInstance ()
 Undocumented Block.
virtual void SetCommunityArrayName (string _arg)
 Get/Set the community array name.
virtual void SetCommunityStrength (float _arg)
 Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.
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 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
vtkCommunity2DLayoutStrategy 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkCommunity2DLayoutStrategy 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "28vtkCommunity2DLayoutStrategy"
 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 vtkCommunity2DLayoutStrategy_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCommunity2DLayoutStrategy_GetCommunityArrayName_01 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetCommunityStrength_02 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetCommunityStrengthMaxValue_03 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetCommunityStrengthMinValue_04 (HandleRef pThis)
static internal double vtkCommunity2DLayoutStrategy_GetCoolDownRate_05 (HandleRef pThis)
static internal double vtkCommunity2DLayoutStrategy_GetCoolDownRateMaxValue_06 (HandleRef pThis)
static internal double vtkCommunity2DLayoutStrategy_GetCoolDownRateMinValue_07 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetInitialTemperature_08 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetInitialTemperatureMaxValue_09 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetInitialTemperatureMinValue_10 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetIterationsPerLayout_11 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetIterationsPerLayoutMaxValue_12 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetIterationsPerLayoutMinValue_13 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetMaxNumberOfIterations_14 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetMaxNumberOfIterationsMaxValue_15 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetMaxNumberOfIterationsMinValue_16 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetRandomSeed_17 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetRandomSeedMaxValue_18 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_GetRandomSeedMinValue_19 (HandleRef pThis)
static internal float vtkCommunity2DLayoutStrategy_GetRestDistance_20 (HandleRef pThis)
static internal void vtkCommunity2DLayoutStrategy_Initialize_21 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_IsA_22 (HandleRef pThis, string type)
static internal int vtkCommunity2DLayoutStrategy_IsLayoutComplete_23 (HandleRef pThis)
static internal int vtkCommunity2DLayoutStrategy_IsTypeOf_24 (string type)
static internal void vtkCommunity2DLayoutStrategy_Layout_25 (HandleRef pThis)
static internal IntPtr vtkCommunity2DLayoutStrategy_NewInstance_27 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCommunity2DLayoutStrategy_SafeDownCast_28 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCommunity2DLayoutStrategy_SetCommunityArrayName_29 (HandleRef pThis, string _arg)
static internal void vtkCommunity2DLayoutStrategy_SetCommunityStrength_30 (HandleRef pThis, float _arg)
static internal void vtkCommunity2DLayoutStrategy_SetCoolDownRate_31 (HandleRef pThis, double _arg)
static internal void vtkCommunity2DLayoutStrategy_SetInitialTemperature_32 (HandleRef pThis, float _arg)
static internal void vtkCommunity2DLayoutStrategy_SetIterationsPerLayout_33 (HandleRef pThis, int _arg)
static internal void vtkCommunity2DLayoutStrategy_SetMaxNumberOfIterations_34 (HandleRef pThis, int _arg)
static internal void vtkCommunity2DLayoutStrategy_SetRandomSeed_35 (HandleRef pThis, int _arg)
static internal void vtkCommunity2DLayoutStrategy_SetRestDistance_36 (HandleRef pThis, float _arg)

Static Private Member Functions

static vtkCommunity2DLayoutStrategy ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCommunity2DLayoutStrategy - a simple fast 2D graph layout that looks for a community array on it's input and strengthens edges within a community and weakens edges not within the community.

Description This class is a density grid based force directed layout strategy. Also please note that 'fast' is relative to quite slow. :) The layout running time is O(V+E) with an extremely high constant. Thanks Thanks to Godzilla for not eating my computer so that this class could be written.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy ( 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.vtkCommunity2DLayoutStrategy.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.

Get/Set the community array name.

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

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/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.vtkCommunity2DLayoutStrategy.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.vtkCommunity2DLayoutStrategy.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

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.vtkCommunity2DLayoutStrategy.SetCommunityArrayName ( string  _arg) [virtual]

Get/Set the community array name.

virtual void Kitware.VTK.vtkCommunity2DLayoutStrategy.SetCommunityStrength ( float  _arg) [virtual]

Set the community 'strength'. The default is '1' which means vertices in the same community will be placed close together, values closer to .1 (minimum) will mean a layout closer to traditional force directed.

virtual void Kitware.VTK.vtkCommunity2DLayoutStrategy.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. :)

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 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.vtkCommunity2DLayoutStrategy.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.vtkCommunity2DLayoutStrategy.SetRestDistance ( float  _arg) [virtual]

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

static internal int Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_IsA_22 ( HandleRef  pThis,
string  type 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_Layout_25 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_NewInstance_27 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SafeDownCast_28 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetCommunityArrayName_29 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetCommunityStrength_30 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetCoolDownRate_31 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetInitialTemperature_32 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetIterationsPerLayout_33 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetMaxNumberOfIterations_34 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetRandomSeed_35 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCommunity2DLayoutStrategy.vtkCommunity2DLayoutStrategy_SetRestDistance_36 ( HandleRef  pThis,
float  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCommunity2DLayoutStrategy.MRClassNameKey = "28vtkCommunity2DLayoutStrategy" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.


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