forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkBoostBreadthFirstSearch.h
170 lines (143 loc) · 4.98 KB
/
vtkBoostBreadthFirstSearch.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBoostBreadthFirstSearch.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 vtkBoostBreadthFirstSearch
* @brief Boost breadth_first_search on a vtkGraph
*
*
*
* This vtk class uses the Boost breadth_first_search
* generic algorithm to perform a breadth first search from a given
* a 'source' vertex on the input graph (a vtkGraph).
*
* @sa
* vtkGraph vtkBoostGraphAdapter
*/
#ifndef vtkBoostBreadthFirstSearch_h
#define vtkBoostBreadthFirstSearch_h
#include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
#include "vtkStdString.h" // For string type
#include "vtkVariant.h" // For variant type
#include "vtkGraphAlgorithm.h"
class vtkSelection;
class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearch : public vtkGraphAlgorithm
{
public:
static vtkBoostBreadthFirstSearch *New();
vtkTypeMacro(vtkBoostBreadthFirstSearch, vtkGraphAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
//@{
/**
* Convenience methods for setting the origin selection input.
*/
void SetOriginSelection(vtkSelection *s);
void SetOriginSelectionConnection(vtkAlgorithmOutput* algOutput)
{
this->SetInputConnection(1, algOutput);
}
//@}
/**
* Set the index (into the vertex array) of the
* breadth first search 'origin' vertex.
*/
void SetOriginVertex(vtkIdType index);
/**
* Set the breadth first search 'origin' vertex.
* This method is basically the same as above
* but allows the application to simply specify
* an array name and value, instead of having to
* know the specific index of the vertex.
*/
void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
/**
* Convenience method for setting the origin vertex
* given an array name and string value.
* This method is primarily for the benefit of the
* VTK Parallel client/server layer, callers should
* prefer to use SetOriginVertex() whenever possible.
*/
void SetOriginVertexString(char* arrayName, char* value);
//@{
/**
* Set the output array name. If no output array name is
* set then the name 'BFS' is used.
*/
vtkSetStringMacro(OutputArrayName);
//@}
//@{
/**
* Use the vtkSelection from input port 1 as the origin vertex.
* The selection should be a IDS selection with field type POINTS.
* The first ID in the selection will be used for the origin vertex.
* Default is off (origin is specified by SetOriginVertex(...)).
*/
vtkSetMacro(OriginFromSelection, bool);
vtkGetMacro(OriginFromSelection, bool);
vtkBooleanMacro(OriginFromSelection, bool);
//@}
//@{
/**
* Create an output selection containing the ID of a vertex based
* on the output selection type. The default is to use the
* the maximum distance from the starting vertex. Defaults to off.
*/
vtkGetMacro(OutputSelection, bool);
vtkSetMacro(OutputSelection, bool);
vtkBooleanMacro(OutputSelection, bool);
//@}
//@{
/**
* Set the output selection type. The default is to use the
* the maximum distance from the starting vertex "MAX_DIST_FROM_ROOT".
* But you can also specify other things like "ROOT","2D_MAX", etc
*/
vtkSetStringMacro(OutputSelectionType);
//@}
protected:
vtkBoostBreadthFirstSearch();
~vtkBoostBreadthFirstSearch();
virtual int RequestData(
vtkInformation *,
vtkInformationVector **,
vtkInformationVector *);
virtual int FillInputPortInformation(
int port, vtkInformation* info);
virtual int FillOutputPortInformation(
int port, vtkInformation* info);
private:
vtkIdType OriginVertexIndex;
char* InputArrayName;
char* OutputArrayName;
vtkVariant OriginValue;
bool OutputSelection;
bool OriginFromSelection;
char* OutputSelectionType;
//@{
/**
* Using the convenience function internally
*/
vtkSetStringMacro(InputArrayName);
//@}
/**
* This method is basically a helper function to find
* the index of a specific value within a specific array
*/
vtkIdType GetVertexIndex(
vtkAbstractArray *abstract,vtkVariant value);
vtkBoostBreadthFirstSearch(const vtkBoostBreadthFirstSearch&) VTK_DELETE_FUNCTION;
void operator=(const vtkBoostBreadthFirstSearch&) VTK_DELETE_FUNCTION;
};
#endif