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

vtkTreeLayoutStrategy - hierarchical layout More...

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

List of all members.

Public Member Functions

 vtkTreeLayoutStrategy (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTreeLayoutStrategy ()
 *Undocumented Block
virtual double GetAngle ()
 The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
virtual double GetAngleMaxValue ()
 The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
virtual double GetAngleMinValue ()
 The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
virtual string GetDistanceArrayName ()
 Get/Set the array to use to determine the distance from the root.
virtual double GetLeafSpacing ()
 The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
virtual double GetLeafSpacingMaxValue ()
 The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
virtual double GetLeafSpacingMinValue ()
 The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
virtual double GetLogSpacingValue ()
 The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.
virtual bool GetRadial ()
 If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.
virtual bool GetReverseEdges ()
 If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.
virtual double GetRotation ()
 The amount of counter-clockwise rotation to apply after the layout.
override int IsA (string type)
 *Undocumented Block
override void Layout ()
 Perform the tree layout.
new vtkTreeLayoutStrategy NewInstance ()
 *Undocumented Block
virtual void RadialOff ()
 If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.
virtual void RadialOn ()
 If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.
virtual void ReverseEdgesOff ()
 If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.
virtual void ReverseEdgesOn ()
 If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.
virtual void SetAngle (double _arg)
 The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.
virtual void SetDistanceArrayName (string _arg)
 Get/Set the array to use to determine the distance from the root.
virtual void SetLeafSpacing (double _arg)
 The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.
virtual void SetLogSpacingValue (double _arg)
 The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.
virtual void SetRadial (bool _arg)
 If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.
virtual void SetReverseEdges (bool _arg)
 If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.
virtual void SetRotation (double _arg)
 The amount of counter-clockwise rotation to apply after the layout.
- Public Member Functions inherited from Kitware.VTK.vtkGraphLayoutStrategy
 vtkGraphLayoutStrategy (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual string GetEdgeWeightField ()
 Set/Get the field to use for the edge weights.
virtual bool GetWeightEdges ()
 Whether to use edge weights in the layout or not.
virtual void Initialize ()
 This method allows the layout strategy to do initialization of data structures or whatever else it might want to do.
virtual int IsLayoutComplete ()
 If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;.
virtual void SetEdgeWeightField (string field)
 Set/Get the field to use for the edge weights.
virtual void SetGraph (vtkGraph graph)
 Setting the graph for the layout strategy.
virtual void SetWeightEdges (bool state)
 Whether to use edge weights in the layout or not.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkTreeLayoutStrategy New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkTreeLayoutStrategy SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkTreeLayoutStrategy"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkGraphLayoutStrategy
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkTreeLayoutStrategy"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkGraphLayoutStrategy
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkTreeLayoutStrategy ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTreeLayoutStrategy - hierarchical layout

Description Assigns points to the nodes of a tree in either a standard or radial layout. The standard layout places each level on a horizontal line, while the radial layout places each level on a concentric circle. You may specify the sweep angle of the tree which constrains the tree to be contained within a wedge. Also, you may indicate the log scale of the tree, which diminishes the length of arcs at lower levels of the tree. Values near zero give a large proportion of the space to the tree levels near the root, while values near one give nearly equal proportions of space to all tree levels.

The user may also specify an array to use to indicate the distance from the root, either vertically (for standard layout) or radially (for radial layout). You specify this with SetDistanceArrayName().

If the input is not a tree but a general graph, this strategy first extracts a tree from the graph using a breadth-first search starting at vertex ID 0.


Constructor & Destructor Documentation

static Kitware.VTK.vtkTreeLayoutStrategy.vtkTreeLayoutStrategy ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkTreeLayoutStrategy.vtkTreeLayoutStrategy ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkTreeLayoutStrategy.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.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetAngle ( )
virtual

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetAngleMaxValue ( )
virtual

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetAngleMinValue ( )
virtual

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual string Kitware.VTK.vtkTreeLayoutStrategy.GetDistanceArrayName ( )
virtual

Get/Set the array to use to determine the distance from the root.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetLeafSpacing ( )
virtual

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetLeafSpacingMaxValue ( )
virtual

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetLeafSpacingMinValue ( )
virtual

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetLogSpacingValue ( )
virtual

The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.

virtual bool Kitware.VTK.vtkTreeLayoutStrategy.GetRadial ( )
virtual

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual bool Kitware.VTK.vtkTreeLayoutStrategy.GetReverseEdges ( )
virtual

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual double Kitware.VTK.vtkTreeLayoutStrategy.GetRotation ( )
virtual

The amount of counter-clockwise rotation to apply after the layout.

override int Kitware.VTK.vtkTreeLayoutStrategy.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

static new int Kitware.VTK.vtkTreeLayoutStrategy.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

override void Kitware.VTK.vtkTreeLayoutStrategy.Layout ( )
virtual

Perform the tree layout.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

static new vtkTreeLayoutStrategy Kitware.VTK.vtkTreeLayoutStrategy.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkTreeLayoutStrategy Kitware.VTK.vtkTreeLayoutStrategy.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.RadialOff ( )
virtual

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.RadialOn ( )
virtual

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.ReverseEdgesOff ( )
virtual

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.ReverseEdgesOn ( )
virtual

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

static new vtkTreeLayoutStrategy Kitware.VTK.vtkTreeLayoutStrategy.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetAngle ( double  _arg)
virtual

The sweep angle of the tree. For a standard tree layout, this should be between 0 and 180. For a radial tree layout, this can be between 0 and 360.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetDistanceArrayName ( string  _arg)
virtual

Get/Set the array to use to determine the distance from the root.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetLeafSpacing ( double  _arg)
virtual

The spacing of leaves. Levels near one evenly space leaves with no gaps between subtrees. Levels near zero creates large gaps between subtrees.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetLogSpacingValue ( double  _arg)
virtual

The spacing of tree levels. Levels near zero give more space to levels near the root, while levels near one (the default) create evenly-spaced levels. Levels above one give more space to levels near the leaves.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetRadial ( bool  _arg)
virtual

If set, the tree is laid out with levels on concentric circles around the root. If unset (default), the tree is laid out with levels on horizontal lines.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetReverseEdges ( bool  _arg)
virtual

If set and the input is not a tree but a general graph, the filter will reverse the edges on the graph before extracting a tree using breadth first search.

virtual void Kitware.VTK.vtkTreeLayoutStrategy.SetRotation ( double  _arg)
virtual

The amount of counter-clockwise rotation to apply after the layout.


Member Data Documentation

new readonly string Kitware.VTK.vtkTreeLayoutStrategy.MRClassNameKey = "21vtkTreeLayoutStrategy"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphLayoutStrategy.


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