forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkGraphHierarchicalBundleEdges.h
102 lines (86 loc) · 4.3 KB
/
vtkGraphHierarchicalBundleEdges.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*=========================================================================
Program: Visualization Toolkit
Module: vtkGraphHierarchicalBundleEdges.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkGraphHierarchicalBundleEdges - layout graph arcs in bundles
//
// .SECTION Description
// 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.
// .SECTION 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.
#ifndef vtkGraphHierarchicalBundleEdges_h
#define vtkGraphHierarchicalBundleEdges_h
#include "vtkInfovisCoreModule.h" // For export macro
#include "vtkGraphAlgorithm.h"
class VTKINFOVISCORE_EXPORT vtkGraphHierarchicalBundleEdges : public vtkGraphAlgorithm
{
public:
static vtkGraphHierarchicalBundleEdges *New();
vtkTypeMacro(vtkGraphHierarchicalBundleEdges,vtkGraphAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// 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.
vtkSetClampMacro(BundlingStrength, double, 0.0, 1.0);
vtkGetMacro(BundlingStrength, double);
// Description:
// 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.
vtkSetMacro(DirectMapping, bool);
vtkGetMacro(DirectMapping, bool);
vtkBooleanMacro(DirectMapping, bool);
// Description:
// Set the input type of the algorithm to vtkGraph.
int FillInputPortInformation(int port, vtkInformation* info);
protected:
vtkGraphHierarchicalBundleEdges();
~vtkGraphHierarchicalBundleEdges() {}
double BundlingStrength;
bool DirectMapping;
// Description:
// Convert the vtkGraph into vtkPolyData.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
private:
vtkGraphHierarchicalBundleEdges(const vtkGraphHierarchicalBundleEdges&); // Not implemented.
void operator=(const vtkGraphHierarchicalBundleEdges&); // Not implemented.
};
#endif