VTK  9.3.0
vtkGraph.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
200 #ifndef vtkGraph_h
201 #define vtkGraph_h
202 
203 #include "vtkCommonDataModelModule.h" // For export macro
204 #include "vtkDataObject.h"
205 
206 // Forward declare some boost stuff even if boost wrappers
207 // are turned off.
208 namespace boost
209 {
210 class vtk_edge_iterator;
211 class vtk_out_edge_pointer_iterator;
212 class vtk_in_edge_pointer_iterator;
213 }
214 
215 VTK_ABI_NAMESPACE_BEGIN
217 class vtkCellArray;
218 class vtkEdgeListIterator;
220 class vtkDirectedGraph;
221 class vtkGraphEdge;
222 class vtkGraphEdgePoints;
224 class vtkGraphInternals;
225 class vtkIdTypeArray;
226 class vtkInEdgeIterator;
227 class vtkOutEdgeIterator;
228 class vtkPoints;
229 class vtkUndirectedGraph;
231 class vtkVariant;
232 class vtkVariantArray;
233 
234 // Edge structures.
236 {
237  vtkEdgeBase() = default;
239  : Id(id)
240  {
241  }
243 };
244 
246 {
247  vtkOutEdgeType() = default;
249  : vtkEdgeBase(id)
250  , Target(t)
251  {
252  }
254 };
255 
257 {
258  vtkInEdgeType() = default;
260  : vtkEdgeBase(id)
261  , Source(s)
262  {
263  }
265 };
266 
268 {
269  vtkEdgeType() = default;
271  : vtkEdgeBase(id)
272  , Source(s)
273  , Target(t)
274  {
275  }
278 };
279 
280 class VTKCOMMONDATAMODEL_EXPORT vtkGraph : public vtkDataObject
281 {
282 public:
283  vtkTypeMacro(vtkGraph, vtkDataObject);
284  void PrintSelf(ostream& os, vtkIndent indent) override;
285 
287 
290  vtkGetObjectMacro(VertexData, vtkDataSetAttributes);
291  vtkGetObjectMacro(EdgeData, vtkDataSetAttributes);
293 
297  int GetDataObjectType() override { return VTK_GRAPH; }
298 
302  void Initialize() override;
303 
305 
311  double* GetPoint(vtkIdType ptId);
312  void GetPoint(vtkIdType ptId, double x[3]);
314 
316 
324  virtual void SetPoints(vtkPoints* points);
326 
332 
334 
339  double* GetBounds();
340  void GetBounds(double bounds[6]);
342 
346  vtkMTimeType GetMTime() override;
347 
355 
363 
370 
375 
383 
390  virtual void GetInEdges(vtkIdType v, vtkInEdgeIterator* it);
391 
398 
403 
411 
419 
426  virtual void GetEdges(vtkEdgeListIterator* it);
427 
433 
440 
446 
453 
458 
467  vtkIdType FindVertex(const vtkVariant& pedigreeID);
468 
473  void ShallowCopy(vtkDataObject* obj) override;
474 
479  void DeepCopy(vtkDataObject* obj) override;
480 
485  virtual void CopyStructure(vtkGraph* g);
486 
492  virtual bool CheckedShallowCopy(vtkGraph* g);
493 
499  virtual bool CheckedDeepCopy(vtkGraph* g);
500 
504  virtual void Squeeze();
505 
513  unsigned long GetActualMemorySize() override;
514 
516 
520  static vtkGraph* GetData(vtkInformationVector* v, int i = 0);
522 
531 
536  bool IsSameStructure(vtkGraph* other);
537 
539 
551 
553 
558  void SetEdgePoints(vtkIdType e, vtkIdType npts, const double pts[]) VTK_SIZEHINT(pts, 3 * npts);
559  void GetEdgePoints(vtkIdType e, vtkIdType& npts, double*& pts) VTK_SIZEHINT(pts, 3 * npts);
561 
566 
571 
576 
582  void SetEdgePoint(vtkIdType e, vtkIdType i, const double x[3]);
583  void SetEdgePoint(vtkIdType e, vtkIdType i, double x, double y, double z)
584  {
585  double p[3] = { x, y, z };
586  this->SetEdgePoint(e, i, p);
587  }
588 
592  void AddEdgePoint(vtkIdType e, const double x[3]);
593  void AddEdgePoint(vtkIdType e, double x, double y, double z)
594  {
595  double p[3] = { x, y, z };
596  this->AddEdgePoint(e, p);
597  }
598 
600 
607 
614 
620 
628 
633 
637  void Dump();
638 
648 
653 
658 
659 protected:
661  ~vtkGraph() override;
662 
670  void AddVertexInternal(vtkVariantArray* propertyArr = nullptr, vtkIdType* vertex = nullptr);
671 
678  void AddVertexInternal(const vtkVariant& pedigree, vtkIdType* vertex);
679 
681 
688  vtkIdType u, vtkIdType v, bool directed, vtkVariantArray* propertyArr, vtkEdgeType* edge);
689  void AddEdgeInternal(const vtkVariant& uPedigree, vtkIdType v, bool directed,
690  vtkVariantArray* propertyArr, vtkEdgeType* edge);
691  void AddEdgeInternal(vtkIdType u, const vtkVariant& vPedigree, bool directed,
692  vtkVariantArray* propertyArr, vtkEdgeType* edge);
693  void AddEdgeInternal(const vtkVariant& uPedigree, const vtkVariant& vPedigree, bool directed,
694  vtkVariantArray* propertyArr, vtkEdgeType* edge);
696 
701  void RemoveVertexInternal(vtkIdType v, bool directed);
702 
707  void RemoveEdgeInternal(vtkIdType e, bool directed);
708 
712  void RemoveVerticesInternal(vtkIdTypeArray* arr, bool directed);
713 
717  void RemoveEdgesInternal(vtkIdTypeArray* arr, bool directed);
718 
723  virtual bool IsStructureValid(vtkGraph* g) = 0;
724 
728  virtual void CopyInternal(vtkGraph* g, bool deep);
729 
734 
739 
743  void SetInternals(vtkGraphInternals* internals);
744 
748  vtkGraphEdgePoints* EdgePoints;
749 
753  void SetEdgePoints(vtkGraphEdgePoints* edgePoints);
754 
760 
762 
765  virtual void GetOutEdges(vtkIdType v, const vtkOutEdgeType*& edges, vtkIdType& nedges);
766  virtual void GetInEdges(vtkIdType v, const vtkInEdgeType*& edges, vtkIdType& nedges);
768 
773 
775 
779  friend class vtkEdgeListIterator;
780  friend class vtkInEdgeIterator;
781  friend class vtkOutEdgeIterator;
786 
788 
794 
798  double Bounds[6];
799 
804 
806 
810  static double DefaultPoint[3];
812 
814 
817  vtkGetObjectMacro(EdgeList, vtkIdTypeArray);
818  virtual void SetEdgeList(vtkIdTypeArray* list);
821 
822 private:
823  vtkGraph(const vtkGraph&) = delete;
824  void operator=(const vtkGraph&) = delete;
825 };
826 
827 bool VTKCOMMONDATAMODEL_EXPORT operator==(vtkEdgeBase e1, vtkEdgeBase e2);
828 bool VTKCOMMONDATAMODEL_EXPORT operator!=(vtkEdgeBase e1, vtkEdgeBase e2);
829 VTKCOMMONDATAMODEL_EXPORT ostream& operator<<(ostream& out, vtkEdgeBase e);
830 
831 VTK_ABI_NAMESPACE_END
832 #endif
Iterates through adjacent vertices in a graph.
object to represent cell connectivity
Definition: vtkCellArray.h:176
general representation of visualization data
Definition: vtkDataObject.h:55
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:52
Representation of a single graph edge.
Definition: vtkGraphEdge.h:25
Internal representation of vtkGraph.
Base class for graph data types.
Definition: vtkGraph.h:281
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.
vtkDistributedGraphHelper * GetDistributedGraphHelper()
Retrieves the distributed graph helper for this graph.
void SetEdgePoint(vtkIdType e, vtkIdType i, double x, double y, double z)
Definition: vtkGraph.h:583
void AddEdgePoint(vtkIdType e, double x, double y, double z)
Definition: vtkGraph.h:593
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.
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:803
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.
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:791
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.
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:819
vtkGraphEdgePoints * EdgePoints
The structure for holding the edge points.
Definition: vtkGraph.h:748
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.
double * GetBounds()
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,...
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.
static vtkGraph * GetData(vtkInformation *info)
Retrieve a graph from an information vector.
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.
vtkPoints * GetPoints()
Returns the points array for this graph.
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:809
virtual bool CheckedShallowCopy(vtkGraph *g)
Performs the same operation as ShallowCopy(), but instead of reporting an error for an incompatible g...
vtkGraphInternals * GetGraphInternals(bool modifying)
Returns the internal representation of the graph.
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.
double * GetEdgePoint(vtkIdType e, vtkIdType i)
Get the x,y,z location of a point along edge e.
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:738
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.
virtual void GetOutEdge(vtkIdType v, vtkIdType index, vtkGraphEdge *e)
Random-access method for retrieving outgoing edges from vertex v.
void ClearEdgePoints(vtkIdType e)
Clear all points associated with an edge.
double * GetPoint(vtkIdType ptId)
These methods return the point (0,0,0) until the points structure is created, when it returns the act...
int GetDataObjectType() override
Return what type of dataset this is.
Definition: vtkGraph.h:297
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:733
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.
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.
static vtkGraph * GetData(vtkInformationVector *v, int i=0)
Retrieve a graph from an information vector.
vtkDataSetAttributes * EdgeData
The vertex and edge data.
Definition: vtkGraph.h:792
vtkFieldData * GetAttributesAsFieldData(int type) override
Returns the attributes of the data object as a vtkFieldData.
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:29
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:29
record modification and/or execution time
Definition: vtkTimeStamp.h:25
An undirected graph.
An array holding vtkVariants.
A type representing the union of many types.
Definition: vtkVariant.h:53
Iterates all vertices in a graph.
Forward declaration required for Boost serialization.
@ points
Definition: vtkX3D.h:446
@ info
Definition: vtkX3D.h:376
@ type
Definition: vtkX3D.h:516
@ index
Definition: vtkX3D.h:246
vtkEdgeBase()=default
vtkIdType Id
Definition: vtkGraph.h:242
vtkEdgeBase(vtkIdType id)
Definition: vtkGraph.h:238
vtkEdgeType(vtkIdType s, vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:270
vtkIdType Target
Definition: vtkGraph.h:277
vtkEdgeType()=default
vtkIdType Source
Definition: vtkGraph.h:276
vtkIdType Source
Definition: vtkGraph.h:264
vtkInEdgeType(vtkIdType s, vtkIdType id)
Definition: vtkGraph.h:259
vtkInEdgeType()=default
vtkIdType Target
Definition: vtkGraph.h:253
vtkOutEdgeType(vtkIdType t, vtkIdType id)
Definition: vtkGraph.h:248
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)
bool VTKCOMMONDATAMODEL_EXPORT operator!=(vtkEdgeBase e1, vtkEdgeBase e2)
VTKCOMMONDATAMODEL_EXPORT ostream & operator<<(ostream &out, vtkEdgeBase e)
int vtkIdType
Definition: vtkType.h:315
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270
#define VTK_GRAPH
Definition: vtkType.h:85
#define VTK_SIZEHINT(...)