VTK  9.3.0
vtkSimple2DLayoutStrategy.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
34 #ifndef vtkSimple2DLayoutStrategy_h
35 #define vtkSimple2DLayoutStrategy_h
36 
37 #include "vtkGraphLayoutStrategy.h"
38 #include "vtkInfovisLayoutModule.h" // For export macro
39 
40 VTK_ABI_NAMESPACE_BEGIN
41 class vtkFloatArray;
42 
43 class VTKINFOVISLAYOUT_EXPORT vtkSimple2DLayoutStrategy : public vtkGraphLayoutStrategy
44 {
45 public:
47 
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
57  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
58  vtkGetMacro(RandomSeed, int);
60 
62 
70  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
71  vtkGetMacro(MaxNumberOfIterations, int);
73 
75 
82  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
83  vtkGetMacro(IterationsPerLayout, int);
85 
87 
93  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
94  vtkGetMacro(InitialTemperature, float);
96 
98 
106  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
107  vtkGetMacro(CoolDownRate, double);
109 
111 
118  vtkSetMacro(Jitter, bool);
119  vtkGetMacro(Jitter, bool);
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  // An edge consists of two vertices joined together.
162  // This struct acts as a "pointer" to those two vertices.
163  struct vtkLayoutEdge_t
164  {
165  vtkIdType from;
166  vtkIdType to;
167  float weight;
168  };
169  using vtkLayoutEdge = struct vtkLayoutEdge_t;
170 
171  // These are for storage of repulsion and attraction
172  vtkFloatArray* RepulsionArray;
173  vtkFloatArray* AttractionArray;
174  vtkLayoutEdge* EdgeArray;
175 
176  int RandomSeed;
177  int IterationsPerLayout;
178  int TotalIterations;
179  int LayoutComplete;
180  float Temp;
181  float RestDistance;
182  bool Jitter;
183 
185  void operator=(const vtkSimple2DLayoutStrategy&) = delete;
186 };
187 
188 VTK_ABI_NAMESPACE_END
189 #endif
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:40
abstract superclass for all graph layout strategies
a simple class to control print indentation
Definition: vtkIndent.h:38
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.
static vtkSimple2DLayoutStrategy * New()
~vtkSimple2DLayoutStrategy() override
void Layout() override
This is the layout method where the graph that was set in SetGraph() is laid out.
int IsLayoutComplete() override
I'm an iterative layout so this method lets the caller know if I'm done laying out the graph.
@ weight
Definition: vtkX3D.h:532
int vtkIdType
Definition: vtkType.h:315
#define VTK_DOUBLE_MAX
Definition: vtkType.h:154
#define VTK_INT_MAX
Definition: vtkType.h:144
#define VTK_FLOAT_MAX
Definition: vtkType.h:152