VTK  9.1.0
vtkGraph.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkGraph.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-------------------------------------------------------------------------*/
259#ifndef vtkGraph_h
260#define vtkGraph_h
261
262#include "vtkCommonDataModelModule.h" // For export macro
263#include "vtkDataObject.h"
264
266class vtkCellArray;
269class vtkDirectedGraph;
270class vtkGraphEdge;
271class vtkGraphEdgePoints;
274class vtkIdTypeArray;
277class vtkPoints;
280class vtkVariant;
281class vtkVariantArray;
282
283// Forward declare some boost stuff even if boost wrappers
284// are turned off.
285namespace boost
286{
287class vtk_edge_iterator;
288class vtk_out_edge_pointer_iterator;
289class vtk_in_edge_pointer_iterator;
290}
291
292// Edge structures.
294{
295 vtkEdgeBase() = default;
297 : Id(id)
298 {
299 }
301};
302
304{
305 vtkOutEdgeType() = default;
307 : vtkEdgeBase(id)
308 , Target(t)
309 {
310 }
312};
313
315{
316 vtkInEdgeType() = default;
318 : vtkEdgeBase(id)
319 , Source(s)
320 {
321 }
323};
324
326{
327 vtkEdgeType() = default;
329 : vtkEdgeBase(id)
330 , Source(s)
331 , Target(t)
332 {
333 }
336};
337
338class VTKCOMMONDATAMODEL_EXPORT vtkGraph : public vtkDataObject
339{
340public:
341 vtkTypeMacro(vtkGraph, vtkDataObject);
342 void PrintSelf(ostream& os, vtkIndent indent) override;
343
345
348 vtkGetObjectMacro(VertexData, vtkDataSetAttributes);
349 vtkGetObjectMacro(EdgeData, vtkDataSetAttributes);
351
355 int GetDataObjectType() override { return VTK_GRAPH; }
356
360 void Initialize() override;
361
363
369 double* GetPoint(vtkIdType ptId);
370 void GetPoint(vtkIdType ptId, double x[3]);
372
374
382 virtual void SetPoints(vtkPoints* points);
384
390
392
397 double* GetBounds();
398 void GetBounds(double bounds[6]);
400
405
413
421
428
433
440 virtual void GetOutEdge(vtkIdType v, vtkIdType index, vtkGraphEdge* e);
441
449
456
461
468 virtual void GetInEdge(vtkIdType v, vtkIdType index, vtkGraphEdge* e);
469
477
484 virtual void GetEdges(vtkEdgeListIterator* it);
485
491
498
504
511
516
525 vtkIdType FindVertex(const vtkVariant& pedigreeID);
526
531 void ShallowCopy(vtkDataObject* obj) override;
532
537 void DeepCopy(vtkDataObject* obj) override;
538
543 virtual void CopyStructure(vtkGraph* g);
544
550 virtual bool CheckedShallowCopy(vtkGraph* g);
551
557 virtual bool CheckedDeepCopy(vtkGraph* g);
558
562 virtual void Squeeze();
563
571 unsigned long GetActualMemorySize() override;
572
574
578 static vtkGraph* GetData(vtkInformationVector* v, int i = 0);
580
589
595
597
609
611
616 void SetEdgePoints(vtkIdType e, vtkIdType npts, const double pts[]) VTK_SIZEHINT(pts, 3 * npts);
617 void GetEdgePoints(vtkIdType e, vtkIdType& npts, double*& pts) VTK_SIZEHINT(pts, 3 * npts);
619
624
629
634
640 void SetEdgePoint(vtkIdType e, vtkIdType i, const double x[3]);
641 void SetEdgePoint(vtkIdType e, vtkIdType i, double x, double y, double z)
642 {
643 double p[3] = { x, y, z };
644 this->SetEdgePoint(e, i, p);
645 }
646
650 void AddEdgePoint(vtkIdType e, const double x[3]);
651 void AddEdgePoint(vtkIdType e, double x, double y, double z)
652 {
653 double p[3] = { x, y, z };
654 this->AddEdgePoint(e, p);
655 }
656
658
665
672
678
686
690 vtkIdType GetNumberOfElements(int type) override;
691
695 void Dump();
696
706
711
716
717protected:
719 ~vtkGraph() override;
720
728 void AddVertexInternal(vtkVariantArray* propertyArr = nullptr, vtkIdType* vertex = nullptr);
729
736 void AddVertexInternal(const vtkVariant& pedigree, vtkIdType* vertex);
737
739
746 vtkIdType u, vtkIdType v, bool directed, vtkVariantArray* propertyArr, vtkEdgeType* edge);
747 void AddEdgeInternal(const vtkVariant& uPedigree, vtkIdType v, bool directed,
748 vtkVariantArray* propertyArr, vtkEdgeType* edge);
749 void AddEdgeInternal(vtkIdType u, const vtkVariant& vPedigree, bool directed,
750 vtkVariantArray* propertyArr, vtkEdgeType* edge);
751 void AddEdgeInternal(const vtkVariant& uPedigree, const vtkVariant& vPedigree, bool directed,
752 vtkVariantArray* propertyArr, vtkEdgeType* edge);
754
759 void RemoveVertexInternal(vtkIdType v, bool directed);
760
765 void RemoveEdgeInternal(vtkIdType e, bool directed);
766
770 void RemoveVerticesInternal(vtkIdTypeArray* arr, bool directed);
771
775 void RemoveEdgesInternal(vtkIdTypeArray* arr, bool directed);
776
781 virtual bool IsStructureValid(vtkGraph* g) = 0;
782
786 virtual void CopyInternal(vtkGraph* g, bool deep);
787
792
797
802
806 vtkGraphEdgePoints* EdgePoints;
807
811 void SetEdgePoints(vtkGraphEdgePoints* edgePoints);
812
818
820
823 virtual void GetOutEdges(vtkIdType v, const vtkOutEdgeType*& edges, vtkIdType& nedges);
824 virtual void GetInEdges(vtkIdType v, const vtkInEdgeType*& edges, vtkIdType& nedges);
826
831
833
838 friend class vtkInEdgeIterator;
839 friend class vtkOutEdgeIterator;
844
846
852
856 double Bounds[6];
857
862
864
868 static double DefaultPoint[3];
870
872
875 vtkGetObjectMacro(EdgeList, vtkIdTypeArray);
876 virtual void SetEdgeList(vtkIdTypeArray* list);
879
880private:
881 vtkGraph(const vtkGraph&) = delete;
882 void operator=(const vtkGraph&) = delete;
883};
884
885bool VTKCOMMONDATAMODEL_EXPORT operator==(vtkEdgeBase e1, vtkEdgeBase e2);
886bool VTKCOMMONDATAMODEL_EXPORT operator!=(vtkEdgeBase e1, vtkEdgeBase e2);
887VTKCOMMONDATAMODEL_EXPORT ostream& operator<<(ostream& out, vtkEdgeBase e);
888
889#endif
Iterates through adjacent vertices in a graph.
object to represent cell connectivity
Definition: vtkCellArray.h:290
general representation of visualization data
represent and manipulate attribute data in a dataset
A directed graph.
helper for the vtkGraph class that allows the graph to be distributed across multiple memory spaces.
Iterates through all edges in a graph.
represent and manipulate fields of data
Definition: vtkFieldData.h:164
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
Internal representation of vtkGraph.
Base class for graph data types.
Definition: vtkGraph.h:339
static vtkGraph * GetData(vtkInformationVector *v, int i=0)
Retrieve a graph from an information vector.
double * GetBounds()
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
virtual vtkIdType GetOutDegree(vtkIdType v)
The number of outgoing edges from vertex v.
void SetEdgePoint(vtkIdType e, vtkIdType i, const double x[3])
Set an x,y,z location of a point along an edge.
void SetEdgePoint(vtkIdType e, vtkIdType i, double x, double y, double z)
Definition: vtkGraph.h:641
void AddEdgePoint(vtkIdType e, double x, double y, double z)
Definition: vtkGraph.h:651
vtkPoints * GetPoints()
Returns the points array for this graph.
void ComputeBounds()
Compute the bounds of the graph.
void AddEdgePoint(vtkIdType e, const double x[3])
Adds a point to the end of the list of edge points for a certain edge.
static vtkGraph * GetData(vtkInformation *info)
Retrieve a graph from an information vector.
virtual vtkIdType GetNumberOfVertices()
The number of vertices in the graph.
void BuildEdgeList()
Builds a mapping from edge id to source/target vertex id.
vtkTimeStamp ComputeTime
Time at which bounds were computed.
Definition: vtkGraph.h:861
virtual void GetInEdge(vtkIdType v, vtkIdType index, vtkGraphEdge *e)
Random-access method for retrieving incoming edges to vertex v.
void AddVertexInternal(vtkVariantArray *propertyArr=nullptr, vtkIdType *vertex=nullptr)
Protected method for adding vertices, optionally with properties, used by mutable subclasses.
void AddEdgeInternal(vtkIdType u, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
Protected method for adding edges of a certain directedness used by mutable subclasses.
void AddVertexInternal(const vtkVariant &pedigree, vtkIdType *vertex)
Adds a vertex with the given pedigree ID to the graph.
void ForceOwnership()
If this instance does not own its internals, it makes a copy of the internals.
void SetDistributedGraphHelper(vtkDistributedGraphHelper *helper)
Sets the distributed graph helper of this graph, turning it into a distributed graph.
double * GetPoint(vtkIdType ptId)
These methods return the point (0,0,0) until the points structure is created, when it returns the act...
vtkIdType GetNumberOfEdgePoints(vtkIdType e)
Get the number of edge points associated with an edge.
~vtkGraph() override
virtual bool CheckedDeepCopy(vtkGraph *g)
Performs the same operation as DeepCopy(), but instead of reporting an error for an incompatible grap...
void RemoveVertexInternal(vtkIdType v, bool directed)
Removes a vertex from the graph, along with any adjacent edges.
void Initialize() override
Initialize to an empty graph.
vtkDataSetAttributes * VertexData
The vertex and edge data.
Definition: vtkGraph.h:849
virtual void GetAdjacentVertices(vtkIdType v, vtkAdjacentVertexIterator *it)
Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v.
void RemoveEdgesInternal(vtkIdTypeArray *arr, bool directed)
Removes a collection of edges from the graph.
virtual vtkInEdgeType GetInEdge(vtkIdType v, vtkIdType index)
Random-access method for retrieving incoming edges to vertex v.
double * GetEdgePoint(vtkIdType e, vtkIdType i)
Get the x,y,z location of a point along edge e.
vtkIdType FindVertex(const vtkVariant &pedigreeID)
Retrieve the vertex with the given pedigree ID.
void GetInducedEdges(vtkIdTypeArray *verts, vtkIdTypeArray *edges)
Fills a list of edge indices with the edges contained in the induced subgraph formed by the vertices ...
virtual void SetEdgeList(vtkIdTypeArray *list)
The optional mapping from edge id to source/target ids.
void SetEdgePoints(vtkIdType e, vtkIdType npts, const double pts[])
Get/Set the internal edge control points associated with each edge.
vtkIdTypeArray * EdgeList
The optional mapping from edge id to source/target ids.
Definition: vtkGraph.h:877
vtkGraphEdgePoints * EdgePoints
The structure for holding the edge points.
Definition: vtkGraph.h:806
vtkIdType GetTargetVertex(vtkIdType e)
Retrieve the source and target vertices for an edge id.
void RemoveEdgeInternal(vtkIdType e, bool directed)
Removes an edge from the graph.
bool IsSameStructure(vtkGraph *other)
Returns true if both graphs point to the same adjacency structure.
vtkMTimeType GetMTime() override
The modified time of the graph.
void RemoveVerticesInternal(vtkIdTypeArray *arr, bool directed)
Removes a collection of vertices from the graph, along with any adjacent edges.
bool ToUndirectedGraph(vtkUndirectedGraph *g)
Convert the graph to an undirected graph.
void AddEdgeInternal(const vtkVariant &uPedigree, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
Protected method for adding edges of a certain directedness used by mutable subclasses.
void AddEdgeInternal(const vtkVariant &uPedigree, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
Protected method for adding edges of a certain directedness used by mutable subclasses.
virtual void CopyStructure(vtkGraph *g)
Does a shallow copy of the topological information, but not the associated attributes.
virtual void CopyInternal(vtkGraph *g, bool deep)
Copy internal data structure.
void GetBounds(double bounds[6])
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
vtkIdType GetEdgeId(vtkIdType a, vtkIdType b)
Returns the Id of the edge between vertex a and vertex b.
vtkPoints * Points
The vertex locations.
Definition: vtkGraph.h:867
virtual bool CheckedShallowCopy(vtkGraph *g)
Performs the same operation as ShallowCopy(), but instead of reporting an error for an incompatible g...
void ShallowCopy(vtkDataObject *obj) override
Shallow copies the data object into this graph.
virtual void SetPoints(vtkPoints *points)
Returns the points array for this graph.
bool ToDirectedGraph(vtkDirectedGraph *g)
Convert the graph to a directed graph.
virtual void Squeeze()
Reclaim unused memory.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void GetInEdges(vtkIdType v, vtkInEdgeIterator *it)
Initializes the in edge iterator to iterate over all incoming edges to vertex v.
vtkIdType GetSourceVertex(vtkIdType e)
Retrieve the source and target vertices for an edge id.
void DeepCopyEdgePoints(vtkGraph *g)
Copy the internal edge point data from another graph into this graph.
vtkDistributedGraphHelper * DistributedHelper
The distributed graph helper.
Definition: vtkGraph.h:796
virtual void GetOutEdges(vtkIdType v, vtkOutEdgeIterator *it)
Initializes the out edge iterator to iterate over all outgoing edges of vertex v.
virtual void GetInEdges(vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
Fast access functions for iterators.
void DeepCopy(vtkDataObject *obj) override
Deep copies the data object into this graph.
vtkFieldData * GetAttributesAsFieldData(int type) override
Returns the attributes of the data object as a vtkFieldData.
virtual void GetOutEdge(vtkIdType v, vtkIdType index, vtkGraphEdge *e)
Random-access method for retrieving outgoing edges from vertex v.
vtkDistributedGraphHelper * GetDistributedGraphHelper()
Retrieves the distributed graph helper for this graph.
void ClearEdgePoints(vtkIdType e)
Clear all points associated with an edge.
int GetDataObjectType() override
Return what type of dataset this is.
Definition: vtkGraph.h:355
void AddEdgeInternal(vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
Protected method for adding edges of a certain directedness used by mutable subclasses.
void SetInternals(vtkGraphInternals *internals)
Private method for setting internals.
virtual void GetOutEdges(vtkIdType v, const vtkOutEdgeType *&edges, vtkIdType &nedges)
Fast access functions for iterators.
vtkGraphInternals * Internals
The adjacency list internals of this graph.
Definition: vtkGraph.h:791
virtual void GetEdges(vtkEdgeListIterator *it)
Initializes the edge list iterator to iterate over all edges in the graph.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
virtual vtkIdType GetNumberOfEdges()
The number of edges in the graph.
vtkGraphInternals * GetGraphInternals(bool modifying)
Returns the internal representation of the graph.
void ShallowCopyEdgePoints(vtkGraph *g)
Copy the internal edge point data from another graph into this graph.
void SetEdgePoints(vtkGraphEdgePoints *edgePoints)
Private method for setting edge points.
void Dump()
Dump the contents of the graph to standard output.
virtual vtkIdType GetInDegree(vtkIdType v)
The number of incoming edges to vertex v.
void GetEdgePoints(vtkIdType e, vtkIdType &npts, double *&pts)
Get/Set the internal edge control points associated with each edge.
vtkDataSetAttributes * EdgeData
The vertex and edge data.
Definition: vtkGraph.h:850
virtual vtkOutEdgeType GetOutEdge(vtkIdType v, vtkIdType index)
Random-access method for retrieving outgoing edges from vertex v.
void GetPoint(vtkIdType ptId, double x[3])
These methods return the point (0,0,0) until the points structure is created, when it returns the act...
void ReorderOutVertices(vtkIdType v, vtkIdTypeArray *vertices)
Reorder the outgoing vertices of a vertex.
vtkIdType GetNumberOfElements(int type) override
Get the number of elements for a specific attribute type (VERTEX, EDGE, etc.).
virtual void GetVertices(vtkVertexListIterator *it)
Initializes the vertex list iterator to iterate over all vertices in the graph.
virtual vtkIdType GetDegree(vtkIdType v)
The total of all incoming and outgoing vertices for vertex v.
virtual bool IsStructureValid(vtkGraph *g)=0
Subclasses override this method to accept the structure based on their requirements.
dynamic, self-adjusting array of vtkIdType
Iterates through all incoming edges to a vertex.
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Iterates through all outgoing edges from a vertex.
represent and manipulate 3D points
Definition: vtkPoints.h:143
record modification and/or execution time
Definition: vtkTimeStamp.h:52
An undirected graph.
An array holding vtkVariants.
A atomic type representing the union of many types.
Definition: vtkVariant.h:145
Iterates all vertices in a graph.
Forward declaration required for Boost serialization.
vtkEdgeBase()=default
vtkIdType Id
Definition: vtkGraph.h:300
vtkEdgeBase(vtkIdType id)
Definition: vtkGraph.h:296
vtkEdgeType(vtkIdType s, vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:328
vtkIdType Target
Definition: vtkGraph.h:335
vtkEdgeType()=default
vtkIdType Source
Definition: vtkGraph.h:334
vtkIdType Source
Definition: vtkGraph.h:322
vtkInEdgeType(vtkIdType s, vtkIdType id)
Definition: vtkGraph.h:317
vtkInEdgeType()=default
vtkIdType Target
Definition: vtkGraph.h:311
vtkOutEdgeType(vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:306
vtkOutEdgeType()=default
std::pair< boost::graph_traits< vtkGraph * >::edge_iterator, boost::graph_traits< vtkGraph * >::edge_iterator > edges(vtkGraph *g)
std::pair< boost::graph_traits< vtkGraph * >::vertex_iterator, boost::graph_traits< vtkGraph * >::vertex_iterator > vertices(vtkGraph *g)
bool VTKCOMMONDATAMODEL_EXPORT operator==(vtkEdgeBase e1, vtkEdgeBase e2)
VTKCOMMONDATAMODEL_EXPORT ostream & operator<<(ostream &out, vtkEdgeBase e)
bool VTKCOMMONDATAMODEL_EXPORT operator!=(vtkEdgeBase e1, vtkEdgeBase e2)
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
#define VTK_GRAPH
Definition: vtkType.h:97
#define VTK_SIZEHINT(...)