VTK  9.2.6
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-------------------------------------------------------------------------*/
216#ifndef vtkGraph_h
217#define vtkGraph_h
218
219#include "vtkCommonDataModelModule.h" // For export macro
220#include "vtkDataObject.h"
221
223class vtkCellArray;
226class vtkDirectedGraph;
227class vtkGraphEdge;
228class vtkGraphEdgePoints;
231class vtkIdTypeArray;
234class vtkPoints;
237class vtkVariant;
238class vtkVariantArray;
239
240// Forward declare some boost stuff even if boost wrappers
241// are turned off.
242namespace boost
243{
244class vtk_edge_iterator;
245class vtk_out_edge_pointer_iterator;
246class vtk_in_edge_pointer_iterator;
247}
248
249// Edge structures.
251{
252 vtkEdgeBase() = default;
254 : Id(id)
255 {
256 }
258};
259
261{
262 vtkOutEdgeType() = default;
264 : vtkEdgeBase(id)
265 , Target(t)
266 {
267 }
269};
270
272{
273 vtkInEdgeType() = default;
275 : vtkEdgeBase(id)
276 , Source(s)
277 {
278 }
280};
281
283{
284 vtkEdgeType() = default;
286 : vtkEdgeBase(id)
287 , Source(s)
288 , Target(t)
289 {
290 }
293};
294
295class VTKCOMMONDATAMODEL_EXPORT vtkGraph : public vtkDataObject
296{
297public:
298 vtkTypeMacro(vtkGraph, vtkDataObject);
299 void PrintSelf(ostream& os, vtkIndent indent) override;
300
302
305 vtkGetObjectMacro(VertexData, vtkDataSetAttributes);
306 vtkGetObjectMacro(EdgeData, vtkDataSetAttributes);
308
312 int GetDataObjectType() override { return VTK_GRAPH; }
313
317 void Initialize() override;
318
320
326 double* GetPoint(vtkIdType ptId);
327 void GetPoint(vtkIdType ptId, double x[3]);
329
331
339 virtual void SetPoints(vtkPoints* points);
341
347
349
354 double* GetBounds();
355 void GetBounds(double bounds[6]);
357
362
370
378
385
390
397 virtual void GetOutEdge(vtkIdType v, vtkIdType index, vtkGraphEdge* e);
398
406
413
418
425 virtual void GetInEdge(vtkIdType v, vtkIdType index, vtkGraphEdge* e);
426
434
441 virtual void GetEdges(vtkEdgeListIterator* it);
442
448
455
461
468
473
482 vtkIdType FindVertex(const vtkVariant& pedigreeID);
483
488 void ShallowCopy(vtkDataObject* obj) override;
489
494 void DeepCopy(vtkDataObject* obj) override;
495
500 virtual void CopyStructure(vtkGraph* g);
501
507 virtual bool CheckedShallowCopy(vtkGraph* g);
508
514 virtual bool CheckedDeepCopy(vtkGraph* g);
515
519 virtual void Squeeze();
520
528 unsigned long GetActualMemorySize() override;
529
531
535 static vtkGraph* GetData(vtkInformationVector* v, int i = 0);
537
546
552
554
566
568
573 void SetEdgePoints(vtkIdType e, vtkIdType npts, const double pts[]) VTK_SIZEHINT(pts, 3 * npts);
574 void GetEdgePoints(vtkIdType e, vtkIdType& npts, double*& pts) VTK_SIZEHINT(pts, 3 * npts);
576
581
586
591
597 void SetEdgePoint(vtkIdType e, vtkIdType i, const double x[3]);
598 void SetEdgePoint(vtkIdType e, vtkIdType i, double x, double y, double z)
599 {
600 double p[3] = { x, y, z };
601 this->SetEdgePoint(e, i, p);
602 }
603
607 void AddEdgePoint(vtkIdType e, const double x[3]);
608 void AddEdgePoint(vtkIdType e, double x, double y, double z)
609 {
610 double p[3] = { x, y, z };
611 this->AddEdgePoint(e, p);
612 }
613
615
622
629
635
643
647 vtkIdType GetNumberOfElements(int type) override;
648
652 void Dump();
653
663
668
673
674protected:
676 ~vtkGraph() override;
677
685 void AddVertexInternal(vtkVariantArray* propertyArr = nullptr, vtkIdType* vertex = nullptr);
686
693 void AddVertexInternal(const vtkVariant& pedigree, vtkIdType* vertex);
694
696
703 vtkIdType u, vtkIdType v, bool directed, vtkVariantArray* propertyArr, vtkEdgeType* edge);
704 void AddEdgeInternal(const vtkVariant& uPedigree, vtkIdType v, bool directed,
705 vtkVariantArray* propertyArr, vtkEdgeType* edge);
706 void AddEdgeInternal(vtkIdType u, const vtkVariant& vPedigree, bool directed,
707 vtkVariantArray* propertyArr, vtkEdgeType* edge);
708 void AddEdgeInternal(const vtkVariant& uPedigree, const vtkVariant& vPedigree, bool directed,
709 vtkVariantArray* propertyArr, vtkEdgeType* edge);
711
716 void RemoveVertexInternal(vtkIdType v, bool directed);
717
722 void RemoveEdgeInternal(vtkIdType e, bool directed);
723
727 void RemoveVerticesInternal(vtkIdTypeArray* arr, bool directed);
728
732 void RemoveEdgesInternal(vtkIdTypeArray* arr, bool directed);
733
738 virtual bool IsStructureValid(vtkGraph* g) = 0;
739
743 virtual void CopyInternal(vtkGraph* g, bool deep);
744
749
754
759
763 vtkGraphEdgePoints* EdgePoints;
764
768 void SetEdgePoints(vtkGraphEdgePoints* edgePoints);
769
775
777
780 virtual void GetOutEdges(vtkIdType v, const vtkOutEdgeType*& edges, vtkIdType& nedges);
781 virtual void GetInEdges(vtkIdType v, const vtkInEdgeType*& edges, vtkIdType& nedges);
783
788
790
795 friend class vtkInEdgeIterator;
796 friend class vtkOutEdgeIterator;
801
803
809
813 double Bounds[6];
814
819
821
825 static double DefaultPoint[3];
827
829
832 vtkGetObjectMacro(EdgeList, vtkIdTypeArray);
833 virtual void SetEdgeList(vtkIdTypeArray* list);
836
837private:
838 vtkGraph(const vtkGraph&) = delete;
839 void operator=(const vtkGraph&) = delete;
840};
841
842bool VTKCOMMONDATAMODEL_EXPORT operator==(vtkEdgeBase e1, vtkEdgeBase e2);
843bool VTKCOMMONDATAMODEL_EXPORT operator!=(vtkEdgeBase e1, vtkEdgeBase e2);
844VTKCOMMONDATAMODEL_EXPORT ostream& operator<<(ostream& out, vtkEdgeBase e);
845
846#endif
Iterates through adjacent vertices in a graph.
object to represent cell connectivity
Definition: vtkCellArray.h:187
general representation of visualization data
Definition: vtkDataObject.h:66
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:63
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
Internal representation of vtkGraph.
Base class for graph data types.
Definition: vtkGraph.h:296
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:598
void AddEdgePoint(vtkIdType e, double x, double y, double z)
Definition: vtkGraph.h:608
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:818
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:806
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:834
vtkGraphEdgePoints * EdgePoints
The structure for holding the edge points.
Definition: vtkGraph.h:763
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:824
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:753
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:312
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:748
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:807
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:40
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:40
record modification and/or execution time
Definition: vtkTimeStamp.h:36
An undirected graph.
An array holding vtkVariants.
A atomic type representing the union of many types.
Definition: vtkVariant.h:70
Iterates all vertices in a graph.
Forward declaration required for Boost serialization.
vtkEdgeBase()=default
vtkIdType Id
Definition: vtkGraph.h:257
vtkEdgeBase(vtkIdType id)
Definition: vtkGraph.h:253
vtkEdgeType(vtkIdType s, vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:285
vtkIdType Target
Definition: vtkGraph.h:292
vtkEdgeType()=default
vtkIdType Source
Definition: vtkGraph.h:291
vtkIdType Source
Definition: vtkGraph.h:279
vtkInEdgeType(vtkIdType s, vtkIdType id)
Definition: vtkGraph.h:274
vtkInEdgeType()=default
vtkIdType Target
Definition: vtkGraph.h:268
vtkOutEdgeType(vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:263
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(...)