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 171 172 173 174 175
|
/*=========================================================================
Program: Visualization Toolkit
Module: $RCSfile: vtkAbstractGraph.h,v $
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 (c) Sandia Corporation
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/
// .NAME vtkAbstractGraph - The base class for graph classes (i.e. graph and tree)
//
// .SECTION Description
// This class provides a common data structure and read-access API for
// graphs. The write-access API is left to the subclasses so each may
// restrict the structure of the graph as needed.
//
// .SECTION Thanks
// Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from
// Sandia National Laboratories for their help in developing this class API.
#ifndef __vtkAbstractGraph_h
#define __vtkAbstractGraph_h
#include "vtkPointSet.h"
class vtkGraphIdList;
class vtkPointData;
class vtkCellData;
class vtkLine;
class vtkDynamicHeap;
class VTK_FILTERING_EXPORT vtkAbstractGraph : public vtkPointSet
{
public:
vtkTypeRevisionMacro(vtkAbstractGraph,vtkPointSet);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// The number of points is the same as the number of vertices.
vtkIdType GetNumberOfPoints() { return this->GetNumberOfVertices(); }
// Description:
// These methods return the point (0,0,0) until the points structure
// is created.
double *GetPoint(vtkIdType ptId);
void GetPoint(vtkIdType ptId, double x[3]);
// Description:
// Returns the points array for this graph.
// If points is not yet constructed, generates and returns
// a new points array filled with (0,0,0) coordinates.
vtkPoints* GetPoints();
// Description:
// The number of cells is the same as the number of edges.
vtkIdType GetNumberOfCells() { return this->GetNumberOfEdges(); }
// Description:
// The cells associated with a point corresponds to the
// edges adjacent to a vertex, so this method is identical to GetVertexEdges().
void GetPointCells(vtkIdType ptId, vtkIdList* cellIds);
// Description:
// All edges have two endpoints, so the maximum cell size is two.
int GetMaxCellSize() { return 2; }
// Description:
// All edges are represented by VTK_LINE cells.
int GetCellType(vtkIdType cellId);
// Description:
// For an edge, get a line from the source to the target.
vtkCell* GetCell(vtkIdType cellId);
void GetCell(vtkIdType cellId, vtkGenericCell * cell);
// Description:
// For an edge, fill ptIds with the source and target IDs.
void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds);
// Description:
// The vertex data of a graph is the same as the point data of the data set.
vtkPointData* GetVertexData() { return this->GetPointData(); }
// Description:
// The edge data of a graph is the same as the cell data of the data set.
vtkCellData* GetEdgeData() { return this->GetCellData(); }
// Description:
// The number of vertices in the graph.
virtual vtkIdType GetNumberOfVertices() = 0;
// Description:
// The number of edges in the graph.
virtual vtkIdType GetNumberOfEdges() = 0;
// Description:
// Fill vertices with the vertex IDs of every vertex adjacent to a certain vertex.
// For an undirected graph, these all return the same vertices.
virtual void GetAdjacentVertices(vtkIdType vertex, vtkGraphIdList* vertices) = 0;
virtual void GetInVertices(vtkIdType vertex, vtkGraphIdList* vertices) = 0;
virtual void GetOutVertices(vtkIdType vertex, vtkGraphIdList* vertices) = 0;
// Description:
// Fill edges with the edge IDs of every edge incident to a certain vertex.
// For an undirected graph, these all return the same edges.
virtual void GetIncidentEdges(vtkIdType vertex, vtkGraphIdList* edges) = 0;
virtual void GetInEdges(vtkIdType vertex, vtkGraphIdList* edges) = 0;
virtual void GetOutEdges(vtkIdType vertex, vtkGraphIdList* edges) = 0;
// Description:
// Get the total, or number of incoming or outgoing edges incident to a vertex.
// For an undirected graph, these all return the same value.
virtual vtkIdType GetDegree(vtkIdType vertex) = 0;
virtual vtkIdType GetInDegree(vtkIdType vertex) = 0;
virtual vtkIdType GetOutDegree(vtkIdType vertex) = 0;
// Description:
// Return the source vertex of an edge.
virtual vtkIdType GetSourceVertex(vtkIdType edge) = 0;
// Description:
// Return the target vertex of an edge.
virtual vtkIdType GetTargetVertex(vtkIdType edge) = 0;
// Description:
// Return the other vertex adjacent to an edge.
virtual vtkIdType GetOppositeVertex(vtkIdType edge, vtkIdType vertex) = 0;
// Description:
// Return whether the graph is directed.
// This method must be implemented in all subclasses of vtkAbstractGraph.
virtual bool GetDirected() = 0;
// Description:
// Initialize the graph to an empty graph.
virtual void Initialize();
// Description:
// Create a deep copy of the graph.
virtual void DeepCopy(vtkDataObject* object);
// Description:
// Create a shallow copy of the graph.
virtual void ShallowCopy(vtkDataObject* object);
//BTX
// Description:
// Retrieve an abstract graph from an information vector.
static vtkAbstractGraph* GetData(vtkInformation* info);
static vtkAbstractGraph* GetData(vtkInformationVector* v, int i=0);
//ETX
protected:
vtkAbstractGraph();
~vtkAbstractGraph();
private:
vtkAbstractGraph(const vtkAbstractGraph &); // Not implemented.
void operator=(const vtkAbstractGraph &); // Not implemented.
vtkLine* Line;
static double DefaultPoint[3];
};
#endif
|