VTK  9.1.0
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-------------------------------------------------------------------------*/
39#ifndef vtkFast2DLayoutStrategy_h
40#define vtkFast2DLayoutStrategy_h
41
43#include "vtkInfovisLayoutModule.h" // For export macro
44
45#include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
46
47class vtkFastSplatter;
48class vtkFloatArray;
50class vtkImageData;
51
52class VTKINFOVISLAYOUT_EXPORT vtkFast2DLayoutStrategy : public vtkGraphLayoutStrategy
53{
54public:
56
58 void PrintSelf(ostream& os, vtkIndent indent) override;
59
61
66 vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
67 vtkGetMacro(RandomSeed, int);
69
71
79 vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
80 vtkGetMacro(MaxNumberOfIterations, int);
82
84
91 vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
92 vtkGetMacro(IterationsPerLayout, int);
94
96
102 vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
103 vtkGetMacro(InitialTemperature, float);
105
107
115 vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
116 vtkGetMacro(CoolDownRate, double);
118
120
124 vtkSetMacro(RestDistance, float);
125 vtkGetMacro(RestDistance, float);
127
132 void Initialize() override;
133
141 void Layout() override;
142
147 int IsLayoutComplete() override { return this->LayoutComplete; }
148
149protected:
152
153 int MaxNumberOfIterations; // Maximum number of iterations.
155 float CoolDownRate; // Cool-down rate. Note: Higher # = Slower rate.
156
157private:
158 // An edge consists of two vertices joined together.
159 // This struct acts as a "pointer" to those two vertices.
160 struct vtkLayoutEdge_t
161 {
162 vtkIdType from;
163 vtkIdType to;
164 float weight;
165 };
166 using vtkLayoutEdge = struct vtkLayoutEdge_t;
167
168 // This class 'has a' vtkFastSplatter for the density grid
172 vtkSmartPointer<vtkFloatArray> RepulsionArray;
173 vtkSmartPointer<vtkFloatArray> AttractionArray;
174
175 vtkLayoutEdge* EdgeArray;
176
177 int RandomSeed;
178 int IterationsPerLayout;
179 int TotalIterations;
180 int LayoutComplete;
181 float Temp;
182 float RestDistance;
183
184 // Private helper methods
185 void GenerateCircularSplat(vtkImageData* splat, int x, int y);
186 void GenerateGaussianSplat(vtkImageData* splat, int x, int y);
187 void ResolveCoincidentVertices();
188
190 void operator=(const vtkFast2DLayoutStrategy&) = delete;
191};
192
193#endif
a simple fast 2D graph layout
static vtkFast2DLayoutStrategy * New()
void Layout() override
This is the layout method where the graph that was set in SetGraph() is laid out.
~vtkFast2DLayoutStrategy() override
int IsLayoutComplete() override
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Initialize() override
This strategy sets up some data structures for faster processing of each Layout() call.
A splatter optimized for splatting single kernels.
dynamic, self-adjusting array of float
abstract superclass for all graph layout strategies
convert a vtkGraph to vtkPolyData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
a simple class to control print indentation
Definition: vtkIndent.h:113
Hold a reference to a vtkObjectBase instance.
int vtkIdType
Definition: vtkType.h:332
#define VTK_DOUBLE_MAX
Definition: vtkType.h:165
#define VTK_INT_MAX
Definition: vtkType.h:155
#define VTK_FLOAT_MAX
Definition: vtkType.h:163