VTK
vtkAttributeClustering2DLayoutStrategy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAttributeClustering2DLayoutStrategy.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 vtkAttributeClustering2DLayoutStrategy_h
34 #define vtkAttributeClustering2DLayoutStrategy_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 vtkImageData;
43 class vtkIntArray;
44 class vtkFloatArray;
45 
46 class VTKINFOVISLAYOUT_EXPORT vtkAttributeClustering2DLayoutStrategy : public vtkGraphLayoutStrategy
47 {
48 public:
50 
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
59  vtkGetStringMacro(VertexAttribute);
60  void SetVertexAttribute(const char*);
62 
64 
69  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
70  vtkGetMacro(RandomSeed, int);
72 
74 
82  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
83  vtkGetMacro(MaxNumberOfIterations, int);
85 
87 
94  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
95  vtkGetMacro(IterationsPerLayout, int);
97 
99 
105  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
106  vtkGetMacro(InitialTemperature, float);
108 
110 
118  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
119  vtkGetMacro(CoolDownRate, double);
121 
123 
127  vtkSetMacro(RestDistance, float);
128  vtkGetMacro(RestDistance, float);
130 
135  void Initialize() override;
136 
144  void Layout() override;
145 
150  int IsLayoutComplete() override {return this->LayoutComplete;}
151 
152 protected:
155 
156  int MaxNumberOfIterations; //Maximum number of iterations.
158  float CoolDownRate; //Cool-down rate. Note: Higher # = Slower rate.
159 
160 private:
161 
162  // This class 'has a' vtkFastSplatter for the density grid
165  vtkSmartPointer<vtkFloatArray> RepulsionArray;
166  vtkSmartPointer<vtkFloatArray> AttractionArray;
167  vtkSmartPointer<vtkIntArray> EdgeCountArray;
168 
169  int RandomSeed;
170  int IterationsPerLayout;
171  int TotalIterations;
172  int LayoutComplete;
173  float Temp;
174  float RestDistance;
175  float CuttingThreshold;
176  char* VertexAttribute;
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 
183  class Internals;
184  Internals* Implementation;
185 
187  void operator=(const vtkAttributeClustering2DLayoutStrategy&) = delete;
188 };
189 
190 #endif
191 
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:41
abstract superclass for all graph layout strategies
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:45
#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:39
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
int IsLayoutComplete() override
I&#39;m an iterative layout so this method lets the caller know if I&#39;m done laying out the graph...
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. ...