VTK
vtkSimple2DLayoutStrategy.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkSimple2DLayoutStrategy.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-------------------------------------------------------------------------*/
41#ifndef vtkSimple2DLayoutStrategy_h
42#define vtkSimple2DLayoutStrategy_h
43
44#include "vtkInfovisLayoutModule.h" // For export macro
46
47class vtkFloatArray;
48
49class VTKINFOVISLAYOUT_EXPORT vtkSimple2DLayoutStrategy : public vtkGraphLayoutStrategy
50{
51public:
53
55 void PrintSelf(ostream& os, vtkIndent indent);
56
58
63 vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
64 vtkGetMacro(RandomSeed, int);
66
68
76 vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
77 vtkGetMacro(MaxNumberOfIterations, int);
79
81
88 vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
89 vtkGetMacro(IterationsPerLayout, int);
91
93
99 vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
100 vtkGetMacro(InitialTemperature, float);
102
104
112 vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
113 vtkGetMacro(CoolDownRate, double);
115
117
124 vtkSetMacro(Jitter, bool);
125 vtkGetMacro(Jitter, bool);
127
129
133 vtkSetMacro(RestDistance, float);
134 vtkGetMacro(RestDistance, float);
136
141 virtual void Initialize();
142
150 virtual void Layout();
151
156 virtual int IsLayoutComplete() {return this->LayoutComplete;}
157
158protected:
161
162 int MaxNumberOfIterations; //Maximum number of iterations.
164 float CoolDownRate; //Cool-down rate. Note: Higher # = Slower rate.
165
166private:
167
168 // An edge consists of two vertices joined together.
169 // This struct acts as a "pointer" to those two vertices.
170 typedef struct
171 {
172 vtkIdType from;
173 vtkIdType to;
174 float weight;
175 } vtkLayoutEdge;
176
177 // These are for storage of repulsion and attraction
178 vtkFloatArray *RepulsionArray;
179 vtkFloatArray *AttractionArray;
180 vtkLayoutEdge *EdgeArray;
181
182 int RandomSeed;
183 int IterationsPerLayout;
184 int TotalIterations;
185 int LayoutComplete;
186 float Temp;
187 float RestDistance;
188 bool Jitter;
189
190 vtkSimple2DLayoutStrategy(const vtkSimple2DLayoutStrategy&) VTK_DELETE_FUNCTION;
191 void operator=(const vtkSimple2DLayoutStrategy&) VTK_DELETE_FUNCTION;
192};
193
194#endif
195
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:42
abstract superclass for all graph layout strategies
a simple class to control print indentation
Definition: vtkIndent.h:40
static vtkSimple2DLayoutStrategy * New()
virtual void Initialize()
This strategy sets up some data structures for faster processing of each Layout() call.
virtual void Layout()
This is the layout method where the graph that was set in SetGraph() is laid out.
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual int IsLayoutComplete()
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
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
int vtkIdType
Definition: vtkType.h:287
#define VTK_DOUBLE_MAX
Definition: vtkType.h:163
#define VTK_INT_MAX
Definition: vtkType.h:153
#define VTK_FLOAT_MAX
Definition: vtkType.h:161