forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkOutEdgeIterator.h
115 lines (96 loc) · 3.14 KB
/
vtkOutEdgeIterator.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
/*=========================================================================
Program: Visualization Toolkit
Module: vtkOutEdgeIterator.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 vtkOutEdgeIterator
* @brief Iterates through all outgoing edges from a vertex.
*
*
* vtkOutEdgeIterator iterates through all edges whose source is a particular
* vertex. Instantiate this class directly and call Initialize() to traverse
* the vertex of a graph. Alternately, use GetInEdges() on the graph to
* initialize the iterator. it->Next() returns a vtkOutEdgeType structure,
* which contains Id, the edge's id, and Target, the edge's target vertex.
*
* @sa
* vtkGraph vtkInEdgeIterator
*/
#ifndef vtkOutEdgeIterator_h
#define vtkOutEdgeIterator_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkGraph.h" // For edge type definitions
class vtkGraphEdge;
class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
{
public:
static vtkOutEdgeIterator *New();
vtkTypeMacro(vtkOutEdgeIterator, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Initialize the iterator with a graph and vertex.
*/
void Initialize(vtkGraph *g, vtkIdType v);
//@{
/**
* Get the graph and vertex associated with this iterator.
*/
vtkGetObjectMacro(Graph, vtkGraph);
vtkGetMacro(Vertex, vtkIdType);
//@}
//@{
/**
* Returns the next edge in the graph.
*/
inline vtkOutEdgeType Next()
{
vtkOutEdgeType e = *this->Current;
++this->Current;
return e;
}
//@}
/**
* Just like Next(), but
* returns heavy-weight vtkGraphEdge object instead of
* the vtkEdgeType struct, for use with wrappers.
* The graph edge is owned by this iterator, and changes
* after each call to NextGraphEdge().
*/
vtkGraphEdge *NextGraphEdge();
/**
* Whether this iterator has more edges.
*/
bool HasNext()
{
return this->Current != this->End;
}
protected:
vtkOutEdgeIterator();
~vtkOutEdgeIterator() override;
/**
* Protected method for setting the graph used
* by Initialize().
*/
virtual void SetGraph(vtkGraph *graph);
vtkGraph *Graph;
const vtkOutEdgeType *Current;
const vtkOutEdgeType *End;
vtkIdType Vertex;
vtkGraphEdge *GraphEdge;
private:
vtkOutEdgeIterator(const vtkOutEdgeIterator&) = delete;
void operator=(const vtkOutEdgeIterator&) = delete;
};
#endif