forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkGraphLayoutStrategy.h
109 lines (90 loc) · 3.22 KB
/
vtkGraphLayoutStrategy.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*=========================================================================
Program: Visualization Toolkit
Module: vtkGraphLayoutStrategy.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/**
* @class vtkGraphLayoutStrategy
* @brief abstract superclass for all graph layout strategies
*
*
* All graph layouts should subclass from this class. vtkGraphLayoutStrategy
* works as a plug-in to the vtkGraphLayout algorithm. The Layout()
* function should perform some reasonable "chunk" of the layout.
* This allows the user to be able to see the progress of the layout.
* Use IsLayoutComplete() to tell the user when there is no more layout
* to perform.
*
* @par Thanks:
* Thanks to Brian Wylie from Sandia National Laboratories for adding incremental
* layout capabilities.
*/
#ifndef vtkGraphLayoutStrategy_h
#define vtkGraphLayoutStrategy_h
#include "vtkInfovisLayoutModule.h" // For export macro
#include "vtkObject.h"
class vtkGraph;
class VTKINFOVISLAYOUT_EXPORT vtkGraphLayoutStrategy : public vtkObject
{
public:
vtkTypeMacro(vtkGraphLayoutStrategy,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
/**
* Setting the graph for the layout strategy
*/
virtual void SetGraph(vtkGraph *graph);
/**
* This method allows the layout strategy to
* do initialization of data structures
* or whatever else it might want to do.
*/
virtual void Initialize() {}
/**
* This is the layout method where the graph that was
* set in SetGraph() is laid out. The method can either
* entirely layout the graph or iteratively lay out the
* graph. If you have an iterative layout please implement
* the IsLayoutComplete() method.
*/
virtual void Layout()=0;
/**
* If your concrete class is iterative than
* you should overload IsLayoutComplete()
* otherwise it simply returns 1 by default;
*/
virtual int IsLayoutComplete() {return 1;}
//@{
/**
* Whether to use edge weights in the layout or not.
*/
virtual void SetWeightEdges(bool state);
vtkGetMacro(WeightEdges, bool);
//@}
//@{
/**
* Set/Get the field to use for the edge weights.
*/
virtual void SetEdgeWeightField(const char* field);
vtkGetStringMacro(EdgeWeightField);
//@}
protected:
vtkGraphLayoutStrategy();
~vtkGraphLayoutStrategy();
vtkGraph *Graph;
char *EdgeWeightField;
bool WeightEdges;
private:
vtkGraphLayoutStrategy(const vtkGraphLayoutStrategy&) VTK_DELETE_FUNCTION;
void operator=(const vtkGraphLayoutStrategy&) VTK_DELETE_FUNCTION;
};
#endif