VTK
vtkFast2DLayoutStrategy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkFast2DLayoutStrategy.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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
33 #ifndef vtkFast2DLayoutStrategy_h
34 #define vtkFast2DLayoutStrategy_h
35 
36 #include "vtkInfovisLayoutModule.h" // For export macro
37 #include "vtkGraphLayoutStrategy.h"
38 
39 #include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
40 
41 class vtkFastSplatter;
42 class vtkFloatArray;
43 class vtkGraphToPolyData;
44 class vtkImageData;
45 
46 class VTKINFOVISLAYOUT_EXPORT vtkFast2DLayoutStrategy : public vtkGraphLayoutStrategy
47 {
48 public:
49  static vtkFast2DLayoutStrategy *New();
50 
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
60  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
61  vtkGetMacro(RandomSeed, int);
63 
65 
73  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
74  vtkGetMacro(MaxNumberOfIterations, int);
76 
78 
85  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
86  vtkGetMacro(IterationsPerLayout, int);
88 
90 
96  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
97  vtkGetMacro(InitialTemperature, float);
99 
101 
109  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
110  vtkGetMacro(CoolDownRate, double);
112 
114 
118  vtkSetMacro(RestDistance, float);
119  vtkGetMacro(RestDistance, float);
121 
126  void Initialize() override;
127 
135  void Layout() override;
136 
141  int IsLayoutComplete() override {return this->LayoutComplete;}
142 
143 protected:
145  ~vtkFast2DLayoutStrategy() override;
146 
147  int MaxNumberOfIterations; //Maximum number of iterations.
149  float CoolDownRate; //Cool-down rate. Note: Higher # = Slower rate.
150 
151 private:
152 
153  // An edge consists of two vertices joined together.
154  // This struct acts as a "pointer" to those two vertices.
155  typedef struct
156  {
157  vtkIdType from;
158  vtkIdType to;
159  float weight;
160  } vtkLayoutEdge;
161 
162  // This class 'has a' vtkFastSplatter for the density grid
166  vtkSmartPointer<vtkFloatArray> RepulsionArray;
167  vtkSmartPointer<vtkFloatArray> AttractionArray;
168 
169  vtkLayoutEdge *EdgeArray;
170 
171  int RandomSeed;
172  int IterationsPerLayout;
173  int TotalIterations;
174  int LayoutComplete;
175  float Temp;
176  float RestDistance;
177 
178  // Private helper methods
179  void GenerateCircularSplat(vtkImageData *splat, int x, int y);
180  void GenerateGaussianSplat(vtkImageData *splat, int x, int y);
181  void ResolveCoincidentVertices();
182 
184  void operator=(const vtkFast2DLayoutStrategy&) = delete;
185 };
186 
187 #endif
188 
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
#define VTK_INT_MAX
Definition: vtkType.h:159
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:35
int vtkIdType
Definition: vtkType.h:347
int IsLayoutComplete() override
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
abstract superclass for all graph layout strategies
convert a vtkGraph to vtkPolyData
#define VTK_FLOAT_MAX
Definition: vtkType.h:167
A splatter optimized for splatting single kernels.
a simple class to control print indentation
Definition: vtkIndent.h:33
topologically and geometrically regular array of data
Definition: vtkImageData.h:39
a simple fast 2D graph layout
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Initialize()
This method allows the layout strategy to do initialization of data structures or whatever else it mi...
virtual void Layout()=0
This is the layout method where the graph that was set in SetGraph() is laid out.