vtkGraphHierarchicalBundle Class Reference

#include <vtkGraphHierarchicalBundle.h>

Inheritance diagram for vtkGraphHierarchicalBundle:

[legend]

Collaboration diagram for vtkGraphHierarchicalBundle:

[legend]

List of all members.

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.

Tests:: vtkGraphHierarchicalBundle (Tests)

Definition at line 62 of file vtkGraphHierarchicalBundle.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 vtkGraphHierarchicalBundle *	New ()
static int	IsTypeOf (const char *type)
static vtkGraphHierarchicalBundle *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGraphHierarchicalBundle ()
	~vtkGraphHierarchicalBundle ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
double	BundlingStrength
bool	DirectMapping

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkGraphHierarchicalBundle::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 67 of file vtkGraphHierarchicalBundle.h.

Constructor & Destructor Documentation

vtkGraphHierarchicalBundle::vtkGraphHierarchicalBundle ( ) [protected]

vtkGraphHierarchicalBundle::~vtkGraphHierarchicalBundle ( ) [inline, protected]

Definition at line 92 of file vtkGraphHierarchicalBundle.h.

Member Function Documentation

static vtkGraphHierarchicalBundle* vtkGraphHierarchicalBundle::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkGraphHierarchicalBundle::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGraphHierarchicalBundle::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkGraphHierarchicalBundle::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkGraphHierarchicalBundle* vtkGraphHierarchicalBundle::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkGraphHierarchicalBundle::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkGraphHierarchicalBundle::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 vtkGraphHierarchicalBundle::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 vtkGraphHierarchicalBundle::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 vtkGraphHierarchicalBundle::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 vtkGraphHierarchicalBundle::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 vtkGraphHierarchicalBundle::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.