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
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkGraphLayoutFilter
* @brief nice layout of undirected graphs in 3D
*
* vtkGraphLayoutFilter will reposition a network of nodes, connected by
* lines or polylines, into a more pleasing arrangement. The class
* implements a simple force-directed placement algorithm
* (Fruchterman & Reingold "Graph Drawing by Force-directed Placement"
* Software-Practice and Experience 21(11) 1991).
*
* The input to the filter is a vtkPolyData representing the undirected
* graphs. A graph is represented by a set of polylines and/or lines.
* The output is also a vtkPolyData, where the point positions have been
* modified. To use the filter, specify whether you wish the layout to
* occur in 2D or 3D; the bounds in which the graph should lie (note that you
* can just use automatic bounds computation); and modify the cool down
* rate (controls the final process of simulated annealing).
*/
#ifndef vtkGraphLayoutFilter_h
#define vtkGraphLayoutFilter_h
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSGENERAL_EXPORT vtkGraphLayoutFilter : public vtkPolyDataAlgorithm
{
public:
static vtkGraphLayoutFilter* New();
vtkTypeMacro(vtkGraphLayoutFilter, vtkPolyDataAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Set / get the region in space in which to place the final graph.
* The GraphBounds only affects the results if AutomaticBoundsComputation
* is off.
*/
vtkSetVector6Macro(GraphBounds, double);
vtkGetVectorMacro(GraphBounds, double, 6);
///@}
///@{
/**
* Turn on/off automatic graph bounds calculation. If this
* boolean is off, then the manually specified GraphBounds is used.
* If on, then the input's bounds us used as the graph bounds.
*/
vtkSetMacro(AutomaticBoundsComputation, vtkTypeBool);
vtkGetMacro(AutomaticBoundsComputation, vtkTypeBool);
vtkBooleanMacro(AutomaticBoundsComputation, vtkTypeBool);
///@}
///@{
/**
* 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.
*/
vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
vtkGetMacro(MaxNumberOfIterations, int);
///@}
///@{
/**
* 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.
*/
vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
vtkGetMacro(CoolDownRate, double);
///@}
// Turn on/off layout of graph in three dimensions. If off, graph
// layout occurs in two dimensions. By default, three dimensional
// layout is on.
vtkSetMacro(ThreeDimensionalLayout, vtkTypeBool);
vtkGetMacro(ThreeDimensionalLayout, vtkTypeBool);
vtkBooleanMacro(ThreeDimensionalLayout, vtkTypeBool);
protected:
vtkGraphLayoutFilter();
~vtkGraphLayoutFilter() override = default;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
double GraphBounds[6];
vtkTypeBool AutomaticBoundsComputation; // Boolean controls automatic bounds calc.
int MaxNumberOfIterations; // Maximum number of iterations.
double CoolDownRate; // Cool-down rate. Note: Higher # = Slower rate.
vtkTypeBool ThreeDimensionalLayout; // Boolean for a third dimension.
private:
vtkGraphLayoutFilter(const vtkGraphLayoutFilter&) = delete;
void operator=(const vtkGraphLayoutFilter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
