VTK
vtkGraphLayoutFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGraphLayoutFilter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
36 #ifndef vtkGraphLayoutFilter_h
37 #define vtkGraphLayoutFilter_h
38 
39 #include "vtkFiltersGeneralModule.h" // For export macro
40 #include "vtkPolyDataAlgorithm.h"
41 
43 {
44 public:
46 
48  void PrintSelf(ostream& os, vtkIndent indent);
49 
51 
54  vtkSetVector6Macro(GraphBounds,double);
55  vtkGetVectorMacro(GraphBounds,double,6);
57 
59 
62  vtkSetMacro(AutomaticBoundsComputation, int);
63  vtkGetMacro(AutomaticBoundsComputation, int);
64  vtkBooleanMacro(AutomaticBoundsComputation, int);
66 
68 
71  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
72  vtkGetMacro(MaxNumberOfIterations, int);
74 
76 
79  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
80  vtkGetMacro(CoolDownRate, double);
82 
83  // Turn on/off layout of graph in three dimensions. If off, graph
84  // layout occurs in two dimensions. By default, three dimensional
85  // layout is on.
86  vtkSetMacro(ThreeDimensionalLayout, int);
87  vtkGetMacro(ThreeDimensionalLayout, int);
88  vtkBooleanMacro(ThreeDimensionalLayout, int);
89 
90 protected:
93 
95 
96  double GraphBounds[6];
97  int AutomaticBoundsComputation; //Boolean controls automatic bounds calc.
98  int MaxNumberOfIterations; //Maximum number of iterations.
99  double CoolDownRate; //Cool-down rate. Note: Higher # = Slower rate.
100  int ThreeDimensionalLayout; //Boolean for a third dimension.
101 private:
102  vtkGraphLayoutFilter(const vtkGraphLayoutFilter&); // Not implemented.
103  void operator=(const vtkGraphLayoutFilter&); // Not implemented.
104 };
105 
106 #endif
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:132
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkGraphLayoutFilter::ThreeDimensionalLayout
int ThreeDimensionalLayout
Definition: vtkGraphLayoutFilter.h:100
vtkGraphLayoutFilter::New
static vtkGraphLayoutFilter * New()
vtkGetVectorMacro
#define vtkGetVectorMacro(name, type, count)
Definition: vtkSetGet.h:424
vtkPolyDataAlgorithm.h
vtkSetClampMacro
#define vtkSetClampMacro(name, type, min, max)
Definition: vtkSetGet.h:143
vtkGraphLayoutFilter::AutomaticBoundsComputation
int AutomaticBoundsComputation
Definition: vtkGraphLayoutFilter.h:97
vtkFiltersGeneralModule.h
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
VTKFILTERSGENERAL_EXPORT
#define VTKFILTERSGENERAL_EXPORT
Definition: vtkFiltersGeneralModule.h:15
vtkGraphLayoutFilter::CoolDownRate
double CoolDownRate
Definition: vtkGraphLayoutFilter.h:99
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkGraphLayoutFilter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
vtkGraphLayoutFilter
nice layout of undirected graphs in 3D
Definition: vtkGraphLayoutFilter.h:43
vtkSetVector6Macro
#define vtkSetVector6Macro(name, type)
Definition: vtkSetGet.h:360
vtkGraphLayoutFilter::vtkGraphLayoutFilter
vtkGraphLayoutFilter()
vtkGraphLayoutFilter::~vtkGraphLayoutFilter
~vtkGraphLayoutFilter()
Definition: vtkGraphLayoutFilter.h:92
vtkGraphLayoutFilter::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition: vtkType.h:142
vtkGraphLayoutFilter::MaxNumberOfIterations
int MaxNumberOfIterations
Definition: vtkGraphLayoutFilter.h:98
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44