VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGraphHierarchicalBundleEdges Class Reference

layout graph arcs in bundles More...

#include <vtkGraphHierarchicalBundleEdges.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGraphHierarchicalBundleEdgesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int FillInputPortInformation (int port, vtkInformation *info)
 
virtual void SetBundlingStrength (double)
 
virtual double GetBundlingStrength ()
 
virtual void SetDirectMapping (bool)
 
virtual bool GetDirectMapping ()
 
virtual void DirectMappingOn ()
 
virtual void DirectMappingOff ()
 

Static Public Member Functions

static
vtkGraphHierarchicalBundleEdges
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkGraphHierarchicalBundleEdges
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkGraphHierarchicalBundleEdges ()
 
 ~vtkGraphHierarchicalBundleEdges ()
 

Protected Attributes

double BundlingStrength
 
bool DirectMapping
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Detailed Description

layout graph arcs in bundles

This algorithm creates a vtkPolyData from a vtkGraph. As opposed to vtkGraphToPolyData, which converts each arc into a straight line, each arc is converted to a polyline, following a tree structure. The filter requires both a vtkGraph and vtkTree as input. The tree vertices must be a superset of the graph vertices. A common example is when the graph vertices correspond to the leaves of the tree, but the internal vertices of the tree represent groupings of graph vertices. The algorithm matches the vertices using the array "PedigreeId". The user may alternately set the DirectMapping flag to indicate that the two structures must have directly corresponding offsets (i.e. node i in the graph must correspond to node i in the tree).

The vtkGraph defines the topology of the output vtkPolyData (i.e. the connections between nodes) while the vtkTree defines the geometry (i.e. the location of nodes and arc routes). Thus, the tree must have been assigned vertex locations, but the graph does not need locations, in fact they will be ignored. The edges approximately follow the path from the source to target nodes in the tree. A bundling parameter controls how closely the edges are bundled together along the tree structure.

You may follow this algorithm with vtkSplineFilter in order to make nicely curved edges.

Thanks:
This algorithm was developed in the paper Danny Holten. Hierarchical Edge Bundles: Visualization of Adjacency Relations Relations in Hierarchical Data. IEEE Transactions on Visualization and Computer Graphics, Vol. 12, No. 5, 2006. pp. 741-748.

Definition at line 60 of file vtkGraphHierarchicalBundleEdges.h.

Member Typedef Documentation

Definition at line 65 of file vtkGraphHierarchicalBundleEdges.h.

Constructor & Destructor Documentation

vtkGraphHierarchicalBundleEdges::vtkGraphHierarchicalBundleEdges ( )
protected
vtkGraphHierarchicalBundleEdges::~vtkGraphHierarchicalBundleEdges ( )
inlineprotected

Definition at line 90 of file vtkGraphHierarchicalBundleEdges.h.

Member Function Documentation

static vtkGraphHierarchicalBundleEdges* vtkGraphHierarchicalBundleEdges::New ( )
static
static int vtkGraphHierarchicalBundleEdges::IsTypeOf ( const char *  type)
static
virtual int vtkGraphHierarchicalBundleEdges::IsA ( const char *  type)
virtual
static vtkGraphHierarchicalBundleEdges* vtkGraphHierarchicalBundleEdges::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkGraphHierarchicalBundleEdges::NewInstanceInternal ( ) const
protectedvirtual
vtkGraphHierarchicalBundleEdges* vtkGraphHierarchicalBundleEdges::NewInstance ( ) const
void vtkGraphHierarchicalBundleEdges::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkGraphHierarchicalBundleEdges::SetBundlingStrength ( double  )
virtual

The level of arc bundling in the graph. A strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The default value is 0.8.

virtual double vtkGraphHierarchicalBundleEdges::GetBundlingStrength ( )
virtual

The level of arc bundling in the graph. A strength of 0 creates straight lines, while a strength of 1 forces arcs to pass directly through hierarchy node points. The default value is 0.8.

virtual void vtkGraphHierarchicalBundleEdges::SetDirectMapping ( bool  )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual bool vtkGraphHierarchicalBundleEdges::GetDirectMapping ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual void vtkGraphHierarchicalBundleEdges::DirectMappingOn ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

virtual void vtkGraphHierarchicalBundleEdges::DirectMappingOff ( )
virtual

If on, uses direct mapping from tree to graph vertices. If off, both the graph and tree must contain PedigreeId arrays which are used to match graph and tree vertices. Default is off.

int vtkGraphHierarchicalBundleEdges::FillInputPortInformation ( int  port,
vtkInformation *  info 
)

Set the input type of the algorithm to vtkGraph.

int vtkGraphHierarchicalBundleEdges::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Convert the vtkGraph into vtkPolyData.

Member Data Documentation

double vtkGraphHierarchicalBundleEdges::BundlingStrength
protected

Definition at line 92 of file vtkGraphHierarchicalBundleEdges.h.

bool vtkGraphHierarchicalBundleEdges::DirectMapping
protected

Definition at line 93 of file vtkGraphHierarchicalBundleEdges.h.


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