Base class for graph data types. More...

#include <vtkGraph.h>

Inheritance diagram for vtkGraph:

Collaboration diagram for vtkGraph:

Public Types
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS , FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkGraph *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	GetDataObjectType () override
	Return what type of dataset this is.

void	Initialize () override
	Initialize to an empty graph.

void	ComputeBounds ()
	Compute the bounds of the graph.

vtkMTimeType	GetMTime () override
	The modified time of the graph.

virtual void	GetOutEdges (vtkIdType v, vtkOutEdgeIterator *it)
	Initializes the out edge iterator to iterate over all outgoing edges of vertex v.

virtual vtkIdType	GetDegree (vtkIdType v)
	The total of all incoming and outgoing vertices for vertex v.

virtual vtkIdType	GetOutDegree (vtkIdType v)
	The number of outgoing edges from vertex v.

virtual vtkOutEdgeType	GetOutEdge (vtkIdType v, vtkIdType index)
	Random-access method for retrieving outgoing edges from vertex v.

virtual void	GetOutEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
	Random-access method for retrieving outgoing edges from vertex v.

virtual void	GetInEdges (vtkIdType v, vtkInEdgeIterator *it)
	Initializes the in edge iterator to iterate over all incoming edges to vertex v.

virtual vtkIdType	GetInDegree (vtkIdType v)
	The number of incoming edges to vertex v.

virtual vtkInEdgeType	GetInEdge (vtkIdType v, vtkIdType index)
	Random-access method for retrieving incoming edges to vertex v.

virtual void	GetInEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
	Random-access method for retrieving incoming edges to vertex v.

virtual void	GetAdjacentVertices (vtkIdType v, vtkAdjacentVertexIterator *it)
	Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v.

virtual void	GetEdges (vtkEdgeListIterator *it)
	Initializes the edge list iterator to iterate over all edges in the graph.

virtual vtkIdType	GetNumberOfEdges ()
	The number of edges in the graph.

virtual void	GetVertices (vtkVertexListIterator *it)
	Initializes the vertex list iterator to iterate over all vertices in the graph.

virtual vtkIdType	GetNumberOfVertices ()
	The number of vertices in the graph.

void	SetDistributedGraphHelper (vtkDistributedGraphHelper *helper)
	Sets the distributed graph helper of this graph, turning it into a distributed graph.

vtkDistributedGraphHelper *	GetDistributedGraphHelper ()
	Retrieves the distributed graph helper for this graph.

vtkIdType	FindVertex (const vtkVariant &pedigreeID)
	Retrieve the vertex with the given pedigree ID.

void	ShallowCopy (vtkDataObject *obj) override
	Shallow copies the data object into this graph.

void	DeepCopy (vtkDataObject *obj) override
	Deep copies the data object into this graph.

virtual void	CopyStructure (vtkGraph *g)
	Does a shallow copy of the topological information, but not the associated attributes.

virtual bool	CheckedShallowCopy (vtkGraph *g)
	Performs the same operation as ShallowCopy(), but instead of reporting an error for an incompatible graph, returns false.

virtual bool	CheckedDeepCopy (vtkGraph *g)
	Performs the same operation as DeepCopy(), but instead of reporting an error for an incompatible graph, returns false.

virtual void	Squeeze ()
	Reclaim unused memory.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

void	ReorderOutVertices (vtkIdType v, vtkIdTypeArray *vertices)
	Reorder the outgoing vertices of a vertex.

bool	IsSameStructure (vtkGraph *other)
	Returns true if both graphs point to the same adjacency structure.

vtkIdType	GetNumberOfEdgePoints (vtkIdType e)
	Get the number of edge points associated with an edge.

double *	GetEdgePoint (vtkIdType e, vtkIdType i)
	Get the x,y,z location of a point along edge e.

void	ClearEdgePoints (vtkIdType e)
	Clear all points associated with an edge.

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)

void	AddEdgePoint (vtkIdType e, const double x[3])
	Adds a point to the end of the list of edge points for a certain edge.

void	AddEdgePoint (vtkIdType e, double x, double y, double z)

vtkGraphInternals *	GetGraphInternals (bool modifying)
	Returns the internal representation of the graph.

void	GetInducedEdges (vtkIdTypeArray verts, vtkIdTypeArray edges)
	Fills a list of edge indices with the edges contained in the induced subgraph formed by the vertices in the vertex list.

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData.

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (VERTEX, EDGE, etc.).

void	Dump ()
	Dump the contents of the graph to standard output.

vtkIdType	GetEdgeId (vtkIdType a, vtkIdType b)
	Returns the Id of the edge between vertex a and vertex b.

bool	ToDirectedGraph (vtkDirectedGraph *g)
	Convert the graph to a directed graph.

bool	ToUndirectedGraph (vtkUndirectedGraph *g)
	Convert the graph to an undirected graph.


virtual vtkDataSetAttributes *	GetVertexData ()
	Get the vertex or edge data.

virtual vtkDataSetAttributes *	GetEdgeData ()
	Get the vertex or edge data.


double *	GetPoint (vtkIdType ptId)
	These methods return the point (0,0,0) until the points structure is created, when it returns the actual point position.

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 actual point position.


vtkPoints *	GetPoints ()
	Returns the points array for this graph.

virtual void	SetPoints (vtkPoints *points)
	Returns the points array for this graph.


double *	GetBounds ()
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

void	GetBounds (double bounds[6])
	Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).


vtkIdType	GetSourceVertex (vtkIdType e)
	Retrieve the source and target vertices for an edge id.

vtkIdType	GetTargetVertex (vtkIdType e)
	Retrieve the source and target vertices for an edge id.


void	SetEdgePoints (vtkIdType e, vtkIdType npts, const double pts[])
	Get/Set the internal edge control points associated with each edge.

void	GetEdgePoints (vtkIdType e, vtkIdType &npts, double *&pts)
	Get/Set the internal edge control points associated with each edge.


void	ShallowCopyEdgePoints (vtkGraph *g)
	Copy the internal edge point data from another graph into this graph.

void	DeepCopyEdgePoints (vtkGraph *g)
	Copy the internal edge point data from another graph into this graph.

Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.

virtual void	Initialize ()
	Restore data object to initial state,.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

virtual int	GetDataObjectType ()
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.

virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkGraph *	SafeDownCast (vtkObjectBase *o)


static vtkGraph *	GetData (vtkInformation *info)
	Retrieve a graph from an information vector.

static vtkGraph *	GetData (vtkInformationVector *v, int i=0)
	Retrieve a graph from an information vector.

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGraph ()

	~vtkGraph () override

void	AddVertexInternal (vtkVariantArray propertyArr=nullptr, vtkIdType vertex=nullptr)
	Protected method for adding vertices, optionally with properties, used by mutable subclasses.

void	AddVertexInternal (const vtkVariant &pedigree, vtkIdType *vertex)
	Adds a vertex with the given pedigree ID to the graph.

void	RemoveVertexInternal (vtkIdType v, bool directed)
	Removes a vertex from the graph, along with any adjacent edges.

void	RemoveEdgeInternal (vtkIdType e, bool directed)
	Removes an edge from the graph.

void	RemoveVerticesInternal (vtkIdTypeArray *arr, bool directed)
	Removes a collection of vertices from the graph, along with any adjacent edges.

void	RemoveEdgesInternal (vtkIdTypeArray *arr, bool directed)
	Removes a collection of edges from the graph.

virtual bool	IsStructureValid (vtkGraph *g)=0
	Subclasses override this method to accept the structure based on their requirements.

virtual void	CopyInternal (vtkGraph *g, bool deep)
	Copy internal data structure.

void	SetInternals (vtkGraphInternals *internals)
	Private method for setting internals.

void	SetEdgePoints (vtkGraphEdgePoints *edgePoints)
	Private method for setting edge points.

void	ForceOwnership ()
	If this instance does not own its internals, it makes a copy of the internals.

void	BuildEdgeList ()
	Builds a mapping from edge id to source/target vertex id.


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	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.

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	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.


virtual void	GetOutEdges (vtkIdType v, const vtkOutEdgeType *&edges, vtkIdType &nedges)
	Fast access functions for iterators.

virtual void	GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
	Fast access functions for iterators.

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkGraphInternals *	Internals
	The adjacency list internals of this graph.

vtkDistributedGraphHelper *	DistributedHelper
	The distributed graph helper.

vtkGraphEdgePoints *	EdgePoints
	The structure for holding the edge points.

double	Bounds [6]
	(xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds.

vtkTimeStamp	ComputeTime
	Time at which bounds were computed.


vtkDataSetAttributes *	VertexData
	The vertex and edge data.

vtkDataSetAttributes *	EdgeData
	The vertex and edge data.

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends

class	vtkAdjacentVertexIterator
	Friend iterator classes.

class	vtkEdgeListIterator
	Friend iterator classes.

class	vtkInEdgeIterator
	Friend iterator classes.

class	vtkOutEdgeIterator
	Friend iterator classes.

class	boost::vtk_edge_iterator
	Friend iterator classes.

class	boost::vtk_in_edge_pointer_iterator
	Friend iterator classes.

class	boost::vtk_out_edge_pointer_iterator
	Friend iterator classes.

Friends inherited from vtkObject
Friends inherited from vtkObjectBase
class	vtkGarbageCollectorToObjectBaseFriendship

class	vtkWeakPointerBaseToObjectBaseFriendship

class	vtkMemkindRAII

class	vtkTDSCMemkindRAII

class	vtkDebugLeaks

VTKCOMMONCORE_EXPORT ostream &	operator<< (ostream &os, vtkObjectBase &o)

vtkPoints *	Points
	The vertex locations.

static double	DefaultPoint [3]
	The vertex locations.

vtkIdTypeArray *	EdgeList
	The optional mapping from edge id to source/target ids.

virtual vtkIdTypeArray *	GetEdgeList ()
	The optional mapping from edge id to source/target ids.

virtual void	SetEdgeList (vtkIdTypeArray *list)
	The optional mapping from edge id to source/target ids.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Base class for graph data types.

vtkGraph is the abstract base class that provides all read-only API for graph data types. A graph consists of a collection of vertices and a collection of edges connecting pairs of vertices. The vtkDirectedGraph subclass represents a graph whose edges have inherent order from source vertex to target vertex, while vtkUndirectedGraph is a graph whose edges have no inherent ordering.

Graph vertices may be traversed in two ways. In the current implementation, all vertices are assigned consecutive ids starting at zero, so they may be traversed in a simple for loop from 0 to graph->GetNumberOfVertices() - 1. You may alternately create a vtkVertexListIterator and call graph->GetVertices(it). it->Next() will return the id of the next vertex, while it->HasNext() indicates whether there are more vertices in the graph. This is the preferred method, since in the future graphs may support filtering or subsetting where the vertex ids may not be contiguous.

Graph edges must be traversed through iterators. To traverse all edges in a graph, create an instance of vtkEdgeListIterator and call graph->GetEdges(it). it->Next() returns lightweight vtkEdgeType structures, which contain the public fields Id, Source and Target. Id is the identifier for the edge, which may be used to look up values in associated edge data arrays. Source and Target store the ids of the source and target vertices of the edge. Note that the edge list iterator DOES NOT necessarily iterate over edges in order of ascending id. To traverse edges from wrapper code (Python, Java), use it->NextGraphEdge() instead of it->Next(). This will return a heavyweight, wrappable vtkGraphEdge object, which has the same fields as vtkEdgeType accessible through getter methods.

To traverse all edges outgoing from a vertex, create a vtkOutEdgeIterator and call graph->GetOutEdges(v, it). it->Next() returns a lightweight vtkOutEdgeType containing the fields Id and Target. The source of the edge is always the vertex that was passed as an argument to GetOutEdges(). Incoming edges may be similarly traversed with vtkInEdgeIterator, which returns vtkInEdgeType structures with Id and Source fields. Both vtkOutEdgeIterator and vtkInEdgeIterator also provide the wrapper functions NextGraphEdge() which return vtkGraphEdge objects.

An additional iterator, vtkAdjacentVertexIterator can traverse outgoing vertices directly, instead needing to parse through edges. Initialize the iterator by calling graph->GetAdjacentVertices(v, it).

vtkGraph has two instances of vtkDataSetAttributes for associated vertex and edge data. It also has a vtkPoints instance which may store x,y,z locations for each vertex. This is populated by filters such as vtkGraphLayout and vtkAssignCoordinates.

All graph types share the same implementation, so the structure of one may be shared among multiple graphs, even graphs of different types. Structures from vtkUndirectedGraph and vtkMutableUndirectedGraph may be shared directly. Structures from vtkDirectedGraph, vtkMutableDirectedGraph, and vtkTree may be shared directly with the exception that setting a structure to a tree requires that a "is a tree" test passes.

For graph types that are known to be compatible, calling ShallowCopy() or DeepCopy() will work as expected. When the outcome of a conversion is unknown (i.e. setting a graph to a tree), CheckedShallowCopy() and CheckedDeepCopy() exist which are identical to ShallowCopy() and DeepCopy(), except that instead of emitting an error for an incompatible structure, the function returns false. This allows you to programmatically check structure compatibility without causing error messages.

To construct a graph, use vtkMutableDirectedGraph or vtkMutableUndirectedGraph. You may then use CheckedShallowCopy to set the contents of a mutable graph type into one of the non-mutable types vtkDirectedGraph, vtkUndirectedGraph. To construct a tree, use vtkMutableDirectedGraph, with directed edges which point from the parent to the child, then use CheckedShallowCopy to set the structure to a vtkTree.

Warning: All copy operations implement copy-on-write. The structures are initially shared, but if one of the graphs is modified, the structure is copied so that to the user they function as if they were deep copied. This means that care must be taken if different threads are accessing different graph instances that share the same structure. Race conditions may develop if one thread is modifying the graph at the same time that another graph is copying the structure.

Vertex pedigree IDs:: The vertices in a vtkGraph can be associated with pedigree IDs through GetVertexData()->SetPedigreeIds. In this case, there is a 1-1 mapping between pedigree Ids and vertices. One can query the vertex ID based on the pedigree ID using FindVertex, add new vertices by pedigree ID with AddVertex, and add edges based on the pedigree IDs of the source and target vertices. For example, AddEdge("Here", "There") will find (or add) vertices with pedigree ID "Here" and "There" and then introduce an edge from "Here" to "There".

Vertex pedigree IDs:: To configure the vtkGraph with a pedigree ID mapping, create a vtkDataArray that will store the pedigree IDs and set that array as the pedigree ID array for the vertices via GetVertexData()->SetPedigreeIds().

Distributed graphs:: vtkGraph instances can be distributed across multiple machines, to allow the construction and manipulation of graphs larger than a single machine could handle. A distributed graph will typically be distributed across many different nodes within a cluster, using the Message Passing Interface (MPI) to allow those cluster nodes to communicate.

Distributed graphs:: An empty vtkGraph can be made into a distributed graph by attaching an instance of a vtkDistributedGraphHelper via the SetDistributedGraphHelper() method. To determine whether a graph is distributed or not, call GetDistributedGraphHelper() and check whether the result is non-nullptr. For a distributed graph, the number of processors across which the graph is distributed can be retrieved by extracting the value for the DATA_NUMBER_OF_PIECES key in the vtkInformation object (retrieved by GetInformation()) associated with the graph. Similarly, the value corresponding to the DATA_PIECE_NUMBER key of the vtkInformation object describes which piece of the data this graph instance provides.

Distributed graphs:: Distributed graphs behave somewhat differently from non-distributed graphs, and will require special care. In a distributed graph, each of the processors will contain a subset of the vertices in the graph. That subset of vertices can be accessed via the vtkVertexListIterator produced by GetVertices(). GetNumberOfVertices(), therefore, returns the number of vertices stored locally: it does not account for vertices stored on other processors. A vertex (or edge) is identified by both the rank of its owning processor and by its index within that processor, both of which are encoded within the vtkIdType value that describes that vertex (or edge). The owning processor is a value between 0 and P-1, where P is the number of processors across which the vtkGraph has been distributed. The local index will be a value between 0 and GetNumberOfVertices(), for vertices, or GetNumberOfEdges(), for edges, and can be used to access the local parts of distributed data arrays. When given a vtkIdType identifying a vertex, one can determine the owner of the vertex with vtkDistributedGraphHelper::GetVertexOwner() and the local index with vtkDistributedGraphHelper::GetVertexIndex(). With edges, the appropriate methods are vtkDistributedGraphHelper::GetEdgeOwner() and vtkDistributedGraphHelper::GetEdgeIndex(), respectively. To construct a vtkIdType representing either a vertex or edge given only its owner and local index, use vtkDistributedGraphHelper::MakeDistributedId().

Distributed graphs:: The edges in a distributed graph are always stored on the processors that own the vertices named by the edge. For example, given a directed edge (u, v), the edge will be stored in the out-edges list for vertex u on the processor that owns u, and in the in-edges list for vertex v on the processor that owns v. This "row-wise" decomposition of the graph means that, for any vertex that is local to a processor, that processor can look at all of the incoming and outgoing edges of the graph. Processors cannot, however, access the incoming or outgoing edge lists of vertex owned by other processors. Vertices owned by other processors will not be encountered when traversing the vertex list via GetVertices(), but may be encountered by traversing the in- and out-edge lists of local vertices or the edge list.

Distributed graphs:: Distributed graphs can have pedigree IDs for the vertices in the same way that non-distributed graphs can. In this case, the distribution of the vertices in the graph is based on pedigree ID. For example, a vertex with the pedigree ID "Here" might land on processor 0 while a vertex pedigree ID "There" would end up on processor 3. By default, the pedigree IDs themselves are hashed to give a random (and, hopefully, even) distribution of the vertices. However, one can provide a different vertex distribution function by calling vtkDistributedGraphHelper::SetVertexPedigreeIdDistribution. Once a distributed graph has pedigree IDs, the no-argument AddVertex() method can no longer be used. Additionally, once a vertex has a pedigree ID, that pedigree ID should not be changed unless the user can guarantee that the vertex distribution will still map that vertex to the same processor where it already resides.

See also: vtkDirectedGraph vtkUndirectedGraph vtkMutableDirectedGraph vtkMutableUndirectedGraph vtkTree vtkDistributedGraphHelper

Thanks:: Thanks to Brian Wylie, Timothy Shead, Ken Moreland of Sandia National Laboratories and Douglas Gregor of Indiana University for designing these classes.

Examples:: vtkGraph (Examples)

Online Examples:

GraphAlgorithmFilter

GraphAlgorithmSource

vtkTestGraphAlgorithmFilter

vtkTestGraphAlgorithmSource

ConnectedComponents

Tests:: vtkGraph (Tests)

Definition at line 339 of file vtkGraph.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkGraph::Superclass

Definition at line 342 of file vtkGraph.h.

Constructor & Destructor Documentation

◆ vtkGraph()

vtkGraph::vtkGraph ( )

protected

◆ ~vtkGraph()

vtkGraph::~vtkGraph ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkGraph::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkGraph::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObject.

Reimplemented in vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkMolecule, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkReebGraph, vtkTree, and vtkUndirectedGraph.

◆ SafeDownCast()

static vtkGraph * vtkGraph::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGraph::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

Reimplemented in vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkMolecule, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkReebGraph, vtkTree, and vtkUndirectedGraph.

◆ NewInstance()

vtkGraph * vtkGraph::NewInstance ( ) const

◆ PrintSelf()

void vtkGraph::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule, vtkMutableDirectedGraph, vtkMutableUndirectedGraph, vtkReebGraph, vtkTree, and vtkUndirectedGraph.

◆ GetVertexData()

virtual vtkDataSetAttributes * vtkGraph::GetVertexData ( )

virtual

Get the vertex or edge data.

◆ GetEdgeData()

virtual vtkDataSetAttributes * vtkGraph::GetEdgeData ( )

virtual

Get the vertex or edge data.

◆ GetDataObjectType()

int vtkGraph::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule, vtkReebGraph, vtkTree, and vtkUndirectedGraph.

Definition at line 356 of file vtkGraph.h.

◆ Initialize()

void vtkGraph::Initialize ( )

overridevirtual

Initialize to an empty graph.

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule.

◆ GetPoint() [1/2]

double * vtkGraph::GetPoint ( vtkIdType ptId )

These methods return the point (0,0,0) until the points structure is created, when it returns the actual point position.

In a distributed graph, only the points for local vertices can be retrieved.

◆ GetPoint() [2/2]

void vtkGraph::GetPoint	(	vtkIdType	ptId,
		double	x[3]
	)

These methods return the point (0,0,0) until the points structure is created, when it returns the actual point position.

In a distributed graph, only the points for local vertices can be retrieved.

◆ GetPoints()

vtkPoints * vtkGraph::GetPoints ( )

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. In a distributed graph, only the points for local vertices can be retrieved or modified.

◆ SetPoints()

virtual void vtkGraph::SetPoints ( vtkPoints * points )

virtual

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. In a distributed graph, only the points for local vertices can be retrieved or modified.

◆ ComputeBounds()

void vtkGraph::ComputeBounds ( )

Compute the bounds of the graph.

In a distributed graph, this computes the bounds around the local part of the graph.

◆ GetBounds() [1/2]

double * vtkGraph::GetBounds ( )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

In a distributed graph, this computes the bounds around the local part of the graph.

◆ GetBounds() [2/2]

void vtkGraph::GetBounds ( double bounds[6] )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

In a distributed graph, this computes the bounds around the local part of the graph.

◆ GetMTime()

vtkMTimeType vtkGraph::GetMTime ( )

overridevirtual

The modified time of the graph.

Reimplemented from vtkDataObject.

◆ GetOutEdges() [1/2]

virtual void vtkGraph::GetOutEdges	(	vtkIdType	v,
		vtkOutEdgeIterator *	it
	)

virtual

Initializes the out edge iterator to iterate over all outgoing edges of vertex v.

For an undirected graph, returns all incident edges. In a distributed graph, the vertex v must be local to this processor.

◆ GetDegree()

virtual vtkIdType vtkGraph::GetDegree ( vtkIdType v )

virtual

The total of all incoming and outgoing vertices for vertex v.

For undirected graphs, this is simply the number of edges incident to v. In a distributed graph, the vertex v must be local to this processor.

◆ GetOutDegree()

virtual vtkIdType vtkGraph::GetOutDegree ( vtkIdType v )

virtual

The number of outgoing edges from vertex v.

For undirected graphs, returns the same as GetDegree(). In a distributed graph, the vertex v must be local to this processor.

◆ GetOutEdge() [1/2]

virtual vtkOutEdgeType vtkGraph::GetOutEdge	(	vtkIdType	v,
		vtkIdType	index
	)

virtual

Random-access method for retrieving outgoing edges from vertex v.

◆ GetOutEdge() [2/2]

virtual void vtkGraph::GetOutEdge	(	vtkIdType	v,
		vtkIdType	index,
		vtkGraphEdge *	e
	)

virtual

Random-access method for retrieving outgoing edges from vertex v.

The method fills the vtkGraphEdge instance with the id, source, and target of the edge. This method is provided for wrappers, GetOutEdge(vtkIdType, vtkIdType) is preferred.

◆ GetInEdges() [1/2]

virtual void vtkGraph::GetInEdges	(	vtkIdType	v,
		vtkInEdgeIterator *	it
	)

virtual

Initializes the in edge iterator to iterate over all incoming edges to vertex v.

For an undirected graph, returns all incident edges. In a distributed graph, the vertex v must be local to this processor.

Reimplemented in vtkUndirectedGraph.

◆ GetInDegree()

virtual vtkIdType vtkGraph::GetInDegree ( vtkIdType v )

virtual

The number of incoming edges to vertex v.

For undirected graphs, returns the same as GetDegree(). In a distributed graph, the vertex v must be local to this processor.

Reimplemented in vtkUndirectedGraph.

◆ GetInEdge() [1/2]

virtual vtkInEdgeType vtkGraph::GetInEdge	(	vtkIdType	v,
		vtkIdType	index
	)

virtual

Random-access method for retrieving incoming edges to vertex v.

Reimplemented in vtkUndirectedGraph.

◆ GetInEdge() [2/2]

virtual void vtkGraph::GetInEdge	(	vtkIdType	v,
		vtkIdType	index,
		vtkGraphEdge *	e
	)

virtual

Random-access method for retrieving incoming edges to vertex v.

The method fills the vtkGraphEdge instance with the id, source, and target of the edge. This method is provided for wrappers, GetInEdge(vtkIdType, vtkIdType) is preferred.

Reimplemented in vtkUndirectedGraph.

◆ GetAdjacentVertices()

virtual void vtkGraph::GetAdjacentVertices	(	vtkIdType	v,
		vtkAdjacentVertexIterator *	it
	)

virtual

Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v.

For an undirected graph, returns all adjacent vertices. In a distributed graph, the vertex v must be local to this processor.

◆ GetEdges()

virtual void vtkGraph::GetEdges ( vtkEdgeListIterator * it )

virtual

Initializes the edge list iterator to iterate over all edges in the graph.

Edges may not be traversed in order of increasing edge id. In a distributed graph, this returns edges that are stored locally.

◆ GetNumberOfEdges()

virtual vtkIdType vtkGraph::GetNumberOfEdges ( )

virtual

The number of edges in the graph.

In a distributed graph, this returns the number of edges stored locally.

◆ GetVertices()

virtual void vtkGraph::GetVertices ( vtkVertexListIterator * it )

virtual

Initializes the vertex list iterator to iterate over all vertices in the graph.

In a distributed graph, the iterator traverses all local vertices.

◆ GetNumberOfVertices()

virtual vtkIdType vtkGraph::GetNumberOfVertices ( )

virtual

The number of vertices in the graph.

In a distributed graph, returns the number of local vertices in the graph.

◆ SetDistributedGraphHelper()

void vtkGraph::SetDistributedGraphHelper ( vtkDistributedGraphHelper * helper )

Sets the distributed graph helper of this graph, turning it into a distributed graph.

This operation can only be executed on an empty graph.

◆ GetDistributedGraphHelper()

vtkDistributedGraphHelper * vtkGraph::GetDistributedGraphHelper ( )

Retrieves the distributed graph helper for this graph.

◆ FindVertex()

vtkIdType vtkGraph::FindVertex ( const vtkVariant & pedigreeID )

Retrieve the vertex with the given pedigree ID.

If successful, returns the ID of the vertex. Otherwise, either the vertex data does not have a pedigree ID array or there is no vertex with the given pedigree ID, so this function returns -1. If the graph is a distributed graph, this method will return the Distributed-ID of the vertex.

◆ ShallowCopy()

void vtkGraph::ShallowCopy ( vtkDataObject * obj )

overridevirtual

Shallow copies the data object into this graph.

If it is an incompatible graph, reports an error.

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule.

◆ DeepCopy()

void vtkGraph::DeepCopy ( vtkDataObject * obj )

overridevirtual

Deep copies the data object into this graph.

If it is an incompatible graph, reports an error.

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule, and vtkReebGraph.

virtual void vtkGraph::Squeeze ( )

virtual

Reclaim unused memory.

◆ GetActualMemorySize()

unsigned long vtkGraph::GetActualMemorySize ( )

overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).

Reimplemented from vtkDataObject.

Reimplemented in vtkMolecule.

◆ GetData() [1/2]

static vtkGraph * vtkGraph::GetData ( vtkInformation * info )

static

Retrieve a graph from an information vector.

◆ GetData() [2/2]

static vtkGraph * vtkGraph::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

static

Retrieve a graph from an information vector.

◆ ReorderOutVertices()

void vtkGraph::ReorderOutVertices	(	vtkIdType	v,
		vtkIdTypeArray *	vertices
	)

Reorder the outgoing vertices of a vertex.

The vertex list must have the same elements as the current out edge list, just in a different order. This method does not change the topology of the graph. In a distributed graph, the vertex v must be local.

◆ IsSameStructure()

bool vtkGraph::IsSameStructure ( vtkGraph * other )

Returns true if both graphs point to the same adjacency structure.

Can be used to test the copy-on-write feature of the graph.

◆ GetSourceVertex()

vtkIdType vtkGraph::GetSourceVertex ( vtkIdType e )

Retrieve the source and target vertices for an edge id.

NOTE: The first time this is called, the graph will build a mapping array from edge id to source/target that is the same size as the number of edges in the graph. If you have access to a vtkOutEdgeType, vtkInEdgeType, vtkEdgeType, or vtkGraphEdge, you should directly use these structures to look up the source or target instead of this method.

◆ GetTargetVertex()

vtkIdType vtkGraph::GetTargetVertex ( vtkIdType e )

Retrieve the source and target vertices for an edge id.

NOTE: The first time this is called, the graph will build a mapping array from edge id to source/target that is the same size as the number of edges in the graph. If you have access to a vtkOutEdgeType, vtkInEdgeType, vtkEdgeType, or vtkGraphEdge, you should directly use these structures to look up the source or target instead of this method.

◆ SetEdgePoints() [1/2]

void vtkGraph::SetEdgePoints	(	vtkIdType	e,
		vtkIdType	npts,
		const double	pts[]
	)

Get/Set the internal edge control points associated with each edge.

The size of the pts array is 3*npts, and holds the x,y,z location of each edge control point.

◆ GetEdgePoints()

void vtkGraph::GetEdgePoints	(	vtkIdType	e,
		vtkIdType &	npts,
		double *&	pts
	)

Get/Set the internal edge control points associated with each edge.

The size of the pts array is 3*npts, and holds the x,y,z location of each edge control point.

◆ GetNumberOfEdgePoints()

vtkIdType vtkGraph::GetNumberOfEdgePoints ( vtkIdType e )

Get the number of edge points associated with an edge.

◆ GetEdgePoint()

double * vtkGraph::GetEdgePoint	(	vtkIdType	e,
		vtkIdType	i
	)

Get the x,y,z location of a point along edge e.

◆ ClearEdgePoints()

void vtkGraph::ClearEdgePoints ( vtkIdType e )

Clear all points associated with an edge.

◆ SetEdgePoint() [1/2]

void vtkGraph::SetEdgePoint	(	vtkIdType	e,
		vtkIdType	i,
		const double	x[3]
	)

Set an x,y,z location of a point along an edge.

This assumes there is already a point at location i, and simply overwrites it.

◆ SetEdgePoint() [2/2]

void vtkGraph::SetEdgePoint	(	vtkIdType	e,
		vtkIdType	i,
		double	x,
		double	y,
		double	z
	)

inline

Definition at line 642 of file vtkGraph.h.

◆ AddEdgePoint() [1/2]

void vtkGraph::AddEdgePoint	(	vtkIdType	e,
		const double	x[3]
	)

Adds a point to the end of the list of edge points for a certain edge.

◆ AddEdgePoint() [2/2]

void vtkGraph::AddEdgePoint	(	vtkIdType	e,
		double	x,
		double	y,
		double	z
	)

inline

Definition at line 652 of file vtkGraph.h.

◆ ShallowCopyEdgePoints()

void vtkGraph::ShallowCopyEdgePoints ( vtkGraph * g )

Copy the internal edge point data from another graph into this graph.

Both graphs must have the same number of edges.

◆ DeepCopyEdgePoints()

void vtkGraph::DeepCopyEdgePoints ( vtkGraph * g )

Copy the internal edge point data from another graph into this graph.

Both graphs must have the same number of edges.

◆ GetGraphInternals()

vtkGraphInternals * vtkGraph::GetGraphInternals ( bool modifying )

Returns the internal representation of the graph.

If modifying is true, then the returned vtkGraphInternals object will be unique to this vtkGraph object.

◆ GetInducedEdges()

void vtkGraph::GetInducedEdges	(	vtkIdTypeArray *	verts,
		vtkIdTypeArray *	edges
	)

Fills a list of edge indices with the edges contained in the induced subgraph formed by the vertices in the vertex list.

◆ GetAttributesAsFieldData()

vtkFieldData * vtkGraph::GetAttributesAsFieldData ( int type )

overridevirtual

Returns the attributes of the data object as a vtkFieldData.

This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented from vtkDataObject.

◆ GetNumberOfElements()

vtkIdType vtkGraph::GetNumberOfElements ( int type )

overridevirtual

Get the number of elements for a specific attribute type (VERTEX, EDGE, etc.).

Reimplemented from vtkDataObject.

◆ Dump()

void vtkGraph::Dump ( )

Dump the contents of the graph to standard output.

◆ GetEdgeId()

vtkIdType vtkGraph::GetEdgeId	(	vtkIdType	a,
		vtkIdType	b
	)

Returns the Id of the edge between vertex a and vertex b.

This is independent of directionality of the edge, that is, if edge A->B exists or if edge B->A exists, this function will return its Id. If multiple edges exist between a and b, here is no guarantee about which one will be returned. Returns -1 if no edge exists between a and b.

◆ ToDirectedGraph()

bool vtkGraph::ToDirectedGraph ( vtkDirectedGraph * g )

Convert the graph to a directed graph.

◆ ToUndirectedGraph()

bool vtkGraph::ToUndirectedGraph ( vtkUndirectedGraph * g )

Convert the graph to an undirected graph.

◆ AddVertexInternal() [1/2]

void vtkGraph::AddVertexInternal	(	vtkVariantArray *	propertyArr = `nullptr`,
		vtkIdType *	vertex = `nullptr`
	)

protected

Protected method for adding vertices, optionally with properties, used by mutable subclasses.

If vertex is non-null, it will be set to the newly-added (or found) vertex. Note that if propertyArr is non-null and the vertex data contains pedigree IDs, a vertex will only be added if there is no vertex with that pedigree ID.

◆ AddVertexInternal() [2/2]

void vtkGraph::AddVertexInternal	(	const vtkVariant &	pedigree,
		vtkIdType *	vertex
	)

protected

Adds a vertex with the given pedigree ID to the graph.

If a vertex with this pedigree ID already exists, no new vertex is added, but the vertex argument is set to the ID of the existing vertex. Otherwise, a new vertex is added and its ID is provided.

◆ AddEdgeInternal() [1/4]

void vtkGraph::AddEdgeInternal	(	vtkIdType	u,
		vtkIdType	v,
		bool	directed,
		vtkVariantArray *	propertyArr,
		vtkEdgeType *	edge
	)

protected

Protected method for adding edges of a certain directedness used by mutable subclasses.

If propertyArr is non-null, it specifies the properties to be attached to the newly-created edge. If non-null, edge will receive the newly-added edge.

◆ AddEdgeInternal() [2/4]

void vtkGraph::AddEdgeInternal	(	const vtkVariant &	uPedigree,
		vtkIdType	v,
		bool	directed,
		vtkVariantArray *	propertyArr,
		vtkEdgeType *	edge
	)

protected

Protected method for adding edges of a certain directedness used by mutable subclasses.

If propertyArr is non-null, it specifies the properties to be attached to the newly-created edge. If non-null, edge will receive the newly-added edge.

◆ AddEdgeInternal() [3/4]

void vtkGraph::AddEdgeInternal	(	vtkIdType	u,
		const vtkVariant &	vPedigree,
		bool	directed,
		vtkVariantArray *	propertyArr,
		vtkEdgeType *	edge
	)

protected

Protected method for adding edges of a certain directedness used by mutable subclasses.

If propertyArr is non-null, it specifies the properties to be attached to the newly-created edge. If non-null, edge will receive the newly-added edge.

◆ AddEdgeInternal() [4/4]

void vtkGraph::AddEdgeInternal	(	const vtkVariant &	uPedigree,
		const vtkVariant &	vPedigree,
		bool	directed,
		vtkVariantArray *	propertyArr,
		vtkEdgeType *	edge
	)

protected

Protected method for adding edges of a certain directedness used by mutable subclasses.

If propertyArr is non-null, it specifies the properties to be attached to the newly-created edge. If non-null, edge will receive the newly-added edge.

◆ RemoveVertexInternal()

void vtkGraph::RemoveVertexInternal	(	vtkIdType	v,
		bool	directed
	)

protected

Removes a vertex from the graph, along with any adjacent edges.

This invalidates the id of the last vertex, since it is reassigned to v.

◆ RemoveEdgeInternal()

void vtkGraph::RemoveEdgeInternal	(	vtkIdType	e,
		bool	directed
	)

protected

Removes an edge from the graph.

This invalidates the id of the last edge, since it is reassigned to e.

◆ RemoveVerticesInternal()

void vtkGraph::RemoveVerticesInternal	(	vtkIdTypeArray *	arr,
		bool	directed
	)

protected

Removes a collection of vertices from the graph, along with any adjacent edges.

◆ RemoveEdgesInternal()

void vtkGraph::RemoveEdgesInternal	(	vtkIdTypeArray *	arr,
		bool	directed
	)

protected

Removes a collection of edges from the graph.

◆ IsStructureValid()

virtual bool vtkGraph::IsStructureValid ( vtkGraph * g )

protectedpure virtual

Subclasses override this method to accept the structure based on their requirements.

Implemented in vtkDirectedAcyclicGraph, vtkDirectedGraph, vtkTree, and vtkUndirectedGraph.

◆ CopyInternal()

virtual void vtkGraph::CopyInternal	(	vtkGraph *	g,
		bool	deep
	)

protectedvirtual

Copy internal data structure.

◆ SetInternals()

void vtkGraph::SetInternals ( vtkGraphInternals * internals )

protected

Private method for setting internals.

◆ SetEdgePoints() [2/2]

void vtkGraph::SetEdgePoints ( vtkGraphEdgePoints * edgePoints )

protected

Private method for setting edge points.

◆ ForceOwnership()

void vtkGraph::ForceOwnership ( )

protected

If this instance does not own its internals, it makes a copy of the internals.

This is called before any write operation.

◆ GetOutEdges() [2/2]

virtual void vtkGraph::GetOutEdges	(	vtkIdType	v,
		const vtkOutEdgeType *&	edges,
		vtkIdType &	nedges
	)

protectedvirtual

Fast access functions for iterators.

◆ GetInEdges() [2/2]

virtual void vtkGraph::GetInEdges	(	vtkIdType	v,
		const vtkInEdgeType *&	edges,
		vtkIdType &	nedges
	)

protectedvirtual

Fast access functions for iterators.

Reimplemented in vtkUndirectedGraph.

◆ BuildEdgeList()

void vtkGraph::BuildEdgeList ( )

protected

Builds a mapping from edge id to source/target vertex id.

◆ GetEdgeList()

virtual vtkIdTypeArray * vtkGraph::GetEdgeList ( )

protectedvirtual

The optional mapping from edge id to source/target ids.

Member Data Documentation

◆ Internals

vtkGraphInternals* vtkGraph::Internals

protected

The adjacency list internals of this graph.

Definition at line 792 of file vtkGraph.h.

◆ DistributedHelper

vtkDistributedGraphHelper* vtkGraph::DistributedHelper

vtkIdTypeArray* vtkGraph::EdgeList

protected

The optional mapping from edge id to source/target ids.

Definition at line 878 of file vtkGraph.h.

The documentation for this class was generated from the following file:

Common/DataModel/vtkGraph.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGraph()

◆ ~vtkGraph()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetVertexData()

◆ GetEdgeData()

◆ GetDataObjectType()

◆ Initialize()

◆ GetPoint() [1/2]

◆ GetPoint() [2/2]

◆ GetPoints()

◆ SetPoints()

◆ ComputeBounds()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetMTime()

◆ GetOutEdges() [1/2]

◆ GetDegree()

◆ GetOutDegree()

◆ GetOutEdge() [1/2]

◆ GetOutEdge() [2/2]

◆ GetInEdges() [1/2]

◆ GetInDegree()

◆ GetInEdge() [1/2]

◆ GetInEdge() [2/2]

◆ GetAdjacentVertices()

◆ GetEdges()

◆ GetNumberOfEdges()

◆ GetVertices()

◆ GetNumberOfVertices()

◆ SetDistributedGraphHelper()

◆ GetDistributedGraphHelper()

◆ FindVertex()

◆ ShallowCopy()

◆ DeepCopy()

◆ CopyStructure()

◆ CheckedShallowCopy()

◆ CheckedDeepCopy()

◆ Squeeze()

◆ GetActualMemorySize()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ ReorderOutVertices()

◆ IsSameStructure()

◆ GetSourceVertex()

◆ GetTargetVertex()

◆ SetEdgePoints() [1/2]

◆ GetEdgePoints()

◆ GetNumberOfEdgePoints()

◆ GetEdgePoint()

◆ ClearEdgePoints()

◆ SetEdgePoint() [1/2]

◆ SetEdgePoint() [2/2]

◆ AddEdgePoint() [1/2]

◆ AddEdgePoint() [2/2]

◆ ShallowCopyEdgePoints()

◆ DeepCopyEdgePoints()

◆ GetGraphInternals()

◆ GetInducedEdges()

◆ GetAttributesAsFieldData()

◆ GetNumberOfElements()

◆ Dump()

◆ GetEdgeId()

◆ ToDirectedGraph()