VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMutableUndirectedGraph Class Reference

An editable undirected graph. More...

#include <vtkMutableUndirectedGraph.h>

Inheritance diagram for vtkMutableUndirectedGraph:
[legend]
Collaboration diagram for vtkMutableUndirectedGraph:
[legend]

Public Types

typedef vtkUndirectedGraph Superclass
 
- Public Types inherited from vtkUndirectedGraph
typedef vtkGraph Superclass
 
- Public Types inherited from vtkGraph
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkMutableUndirectedGraphNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkIdType SetNumberOfVertices (vtkIdType numVerts)
 Allocates space for the specified number of vertices in the graph's internal data structures. More...
 
vtkIdType AddVertex ()
 Adds a vertex to the graph and returns the index of the new vertex. More...
 
vtkIdType AddVertex (vtkVariantArray *propertyArr)
 Adds a vertex to the graph with associated properties defined in propertyArr and returns the index of the new vertex. More...
 
vtkIdType AddVertex (const vtkVariant &pedigreeId)
 Adds a vertex with the given pedigreeID to the graph and returns the index of the new vertex. More...
 
vtkEdgeType AddEdge (vtkIdType u, vtkIdType v)
 Adds an undirected edge from u to v, where u and v are vertex indices, and returns a vtkEdgeType structure describing that edge. More...
 
vtkEdgeType AddEdge (vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr)
 Adds an undirected edge from u to v, where u and v are vertex indices, with associated properties defined in propertyArr and returns a vtkEdgeType structure describing that edge. More...
 
vtkEdgeType AddEdge (const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=nullptr)
 Adds an undirected edge from u to v, where u is a vertex pedigree ID and v is a vertex index, and returns a vtkEdgeType structure describing that edge. More...
 
vtkEdgeType AddEdge (vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
 Adds a directed edge from u to v, where u is a vertex index and v is a vertex pedigree ID, and returns a vtkEdgeType structure describing that edge. More...
 
vtkEdgeType AddEdge (const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
 Adds a directed edge from u to v, where u and v are vertex pedigree IDs, and returns a vtkEdgeType structure describing that edge. More...
 
void LazyAddVertex ()
 Adds a vertex to the graph. More...
 
void LazyAddVertex (vtkVariantArray *propertyArr)
 Adds a vertex to the graph with associated properties defined in propertyArr. More...
 
void LazyAddVertex (const vtkVariant &pedigreeId)
 Adds a vertex with the given pedigreeID to the graph. More...
 
void LazyAddEdge (vtkIdType u, vtkIdType v)
 Adds an undirected edge from u to v, where u and v are vertex indices. More...
 
void LazyAddEdge (vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr)
 Adds an undirected edge from u to v, where u and v are vertex indices. More...
 
void LazyAddEdge (const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=nullptr)
 Adds an undirected edge from u to v, where u is a vertex pedigree ID and v is a vertex index. More...
 
void LazyAddEdge (vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
 Adds an undirected edge from u to v, where u is a vertex index and v is a vertex pedigree ID. More...
 
void LazyAddEdge (const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
 Adds an undirected edge from u to v, where u and v are vertex pedigree IDs. More...
 
vtkGraphEdgeAddGraphEdge (vtkIdType u, vtkIdType v)
 Variant of AddEdge() that returns a heavyweight vtkGraphEdge object. More...
 
void RemoveVertex (vtkIdType v)
 Removes the vertex from the graph along with any connected edges. More...
 
void RemoveEdge (vtkIdType e)
 Removes the edge from the graph. More...
 
void RemoveVertices (vtkIdTypeArray *arr)
 Removes a collection of vertices from the graph along with any connected edges. More...
 
void RemoveEdges (vtkIdTypeArray *arr)
 Removes a collection of edges from the graph. More...
 
- Public Member Functions inherited from vtkUndirectedGraph
vtkUndirectedGraphNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
vtkIdType GetInDegree (vtkIdType v) override
 Returns the full degree of the vertex. More...
 
vtkInEdgeType GetInEdge (vtkIdType v, vtkIdType i) override
 Random-access method for retrieving the in edges of a vertex. More...
 
void GetInEdge (vtkIdType v, vtkIdType i, vtkGraphEdge *e) override
 Random-access method for retrieving incoming edges to vertex v. More...
 
void GetInEdges (vtkIdType v, vtkInEdgeIterator *it) override
 Initialize the iterator to get the incoming edges to a vertex. More...
 
bool IsStructureValid (vtkGraph *g) override
 Check the structure, and accept it if it is a valid undirected graph. More...
 
- Public Member Functions inherited from vtkGraph
vtkGraphNewInstance () const
 
void Initialize () override
 Initialize to an empty graph. More...
 
void ComputeBounds ()
 Compute the bounds of the graph. More...
 
vtkMTimeType GetMTime () override
 The modified time of the graph. More...
 
virtual void GetOutEdges (vtkIdType v, vtkOutEdgeIterator *it)
 Initializes the out edge iterator to iterate over all outgoing edges of vertex v. More...
 
virtual vtkIdType GetDegree (vtkIdType v)
 The total of all incoming and outgoing vertices for vertex v. More...
 
virtual vtkIdType GetOutDegree (vtkIdType v)
 The number of outgoing edges from vertex v. More...
 
virtual vtkOutEdgeType GetOutEdge (vtkIdType v, vtkIdType index)
 Random-access method for retrieving outgoing edges from vertex v. More...
 
virtual void GetOutEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
 Random-access method for retrieving outgoing edges from vertex v. More...
 
virtual void GetAdjacentVertices (vtkIdType v, vtkAdjacentVertexIterator *it)
 Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v. More...
 
virtual void GetEdges (vtkEdgeListIterator *it)
 Initializes the edge list iterator to iterate over all edges in the graph. More...
 
virtual vtkIdType GetNumberOfEdges ()
 The number of edges in the graph. More...
 
virtual void GetVertices (vtkVertexListIterator *it)
 Initializes the vertex list iterator to iterate over all vertices in the graph. More...
 
virtual vtkIdType GetNumberOfVertices ()
 The number of vertices in the graph. More...
 
void SetDistributedGraphHelper (vtkDistributedGraphHelper *helper)
 Sets the distributed graph helper of this graph, turning it into a distributed graph. More...
 
vtkDistributedGraphHelperGetDistributedGraphHelper ()
 Retrieves the distributed graph helper for this graph. More...
 
vtkIdType FindVertex (const vtkVariant &pedigreeID)
 Retrieve the vertex with the given pedigree ID. More...
 
void ShallowCopy (vtkDataObject *obj) override
 Shallow copies the data object into this graph. More...
 
void DeepCopy (vtkDataObject *obj) override
 Deep copies the data object into this graph. More...
 
virtual void CopyStructure (vtkGraph *g)
 Does a shallow copy of the topological information, but not the associated attributes. More...
 
virtual bool CheckedShallowCopy (vtkGraph *g)
 Performs the same operation as ShallowCopy(), but instead of reporting an error for an incompatible graph, returns false. More...
 
virtual bool CheckedDeepCopy (vtkGraph *g)
 Performs the same operation as DeepCopy(), but instead of reporting an error for an incompatible graph, returns false. More...
 
virtual void Squeeze ()
 Reclaim unused memory. More...
 
void ReorderOutVertices (vtkIdType v, vtkIdTypeArray *vertices)
 Reorder the outgoing vertices of a vertex. More...
 
bool IsSameStructure (vtkGraph *other)
 Returns true if both graphs point to the same adjacency structure. More...
 
vtkIdType GetNumberOfEdgePoints (vtkIdType e)
 Get the number of edge points associated with an edge. More...
 
doubleGetEdgePoint (vtkIdType e, vtkIdType i)
 Get the x,y,z location of a point along edge e. More...
 
void ClearEdgePoints (vtkIdType e)
 Clear all points associated with an edge. More...
 
void SetEdgePoint (vtkIdType e, vtkIdType i, double x[3])
 Set an x,y,z location of a point along an edge. More...
 
void SetEdgePoint (vtkIdType e, vtkIdType i, double x, double y, double z)
 
void AddEdgePoint (vtkIdType e, double x[3])
 Adds a point to the end of the list of edge points for a certain edge. More...
 
void AddEdgePoint (vtkIdType e, double x, double y, double z)
 
vtkGraphInternalsGetGraphInternals (bool modifying)
 Returns the internal representation of the graph. More...
 
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. More...
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (VERTEX, EDGE, etc.). More...
 
void Dump ()
 Dump the contents of the graph to standard output. More...
 
vtkIdType GetEdgeId (vtkIdType a, vtkIdType b)
 Returns the Id of the edge between vertex a and vertex b. More...
 
bool ToDirectedGraph (vtkDirectedGraph *g)
 Convert the graph to a directed graph. More...
 
bool ToUndirectedGraph (vtkUndirectedGraph *g)
 Convert the graph to an undirected graph. More...
 
virtual vtkDataSetAttributesGetVertexData ()
 Get the vertex or edge data. More...
 
virtual vtkDataSetAttributesGetEdgeData ()
 Get the vertex or edge data. More...
 
doubleGetPoint (vtkIdType ptId)
 These methods return the point (0,0,0) until the points structure is created, when it returns the actual point position. More...
 
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. More...
 
vtkPointsGetPoints ()
 Returns the points array for this graph. More...
 
virtual void SetPoints (vtkPoints *points)
 Returns the points array for this graph. More...
 
doubleGetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
void GetBounds (double bounds[6])
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
vtkIdType GetSourceVertex (vtkIdType e)
 Retrieve the source and target vertices for an edge id. More...
 
vtkIdType GetTargetVertex (vtkIdType e)
 Retrieve the source and target vertices for an edge id. More...
 
void SetEdgePoints (vtkIdType e, vtkIdType npts, double *pts)
 Get/Set the internal edge control points associated with each edge. More...
 
void GetEdgePoints (vtkIdType e, vtkIdType &npts, double *&pts)
 Get/Set the internal edge control points associated with each edge. More...
 
void ShallowCopyEdgePoints (vtkGraph *g)
 Copy the internal edge point data from another graph into this graph. More...
 
void DeepCopyEdgePoints (vtkGraph *g)
 Copy the internal edge point data from another graph into this graph. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual unsigned long GetActualMemorySize ()
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. More...
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object. More...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object. More...
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkMutableUndirectedGraphNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMutableUndirectedGraphSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUndirectedGraph
static vtkUndirectedGraphNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUndirectedGraphSafeDownCast (vtkObjectBase *o)
 
static vtkUndirectedGraphGetData (vtkInformation *info)
 Retrieve a graph from an information vector. More...
 
static vtkUndirectedGraphGetData (vtkInformationVector *v, int i=0)
 Retrieve a graph from an information vector. More...
 
- Static Public Member Functions inherited from vtkGraph
static int IsTypeOf (const char *type)
 
static vtkGraphSafeDownCast (vtkObjectBase *o)
 
static vtkGraphGetData (vtkInformation *info)
 Retrieve a graph from an information vector. More...
 
static vtkGraphGetData (vtkInformationVector *v, int i=0)
 Retrieve a graph from an information vector. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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) More...
 
static vtkInformationGetNamedFieldInformation (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. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (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). More...
 
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). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static int GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMutableUndirectedGraph ()
 
 ~vtkMutableUndirectedGraph () override
 
- Protected Member Functions inherited from vtkUndirectedGraph
 vtkUndirectedGraph ()
 
 ~vtkUndirectedGraph () override
 
void GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges) override
 For iterators, returns the same edge list as GetOutEdges(). More...
 
- Protected Member Functions inherited from vtkGraph
 vtkGraph ()
 
 ~vtkGraph () override
 
void AddVertexInternal (vtkVariantArray *propertyArr=nullptr, vtkIdType *vertex=nullptr)
 Protected method for adding vertices, optionally with properties, used by mutable subclasses. More...
 
void AddVertexInternal (const vtkVariant &pedigree, vtkIdType *vertex)
 Adds a vertex with the given pedigree ID to the graph. More...
 
void RemoveVertexInternal (vtkIdType v, bool directed)
 Removes a vertex from the graph, along with any adjacent edges. More...
 
void RemoveEdgeInternal (vtkIdType e, bool directed)
 Removes an edge from the graph. More...
 
void RemoveVerticesInternal (vtkIdTypeArray *arr, bool directed)
 Removes a collection of vertices from the graph, along with any adjacent edges. More...
 
void RemoveEdgesInternal (vtkIdTypeArray *arr, bool directed)
 Removes a collection of edges from the graph. More...
 
virtual void CopyInternal (vtkGraph *g, bool deep)
 Copy internal data structure. More...
 
void SetInternals (vtkGraphInternals *internals)
 Private method for setting internals. More...
 
void SetEdgePoints (vtkGraphEdgePoints *edgePoints)
 Private method for setting edge points. More...
 
void ForceOwnership ()
 If this instance does not own its internals, it makes a copy of the internals. More...
 
void BuildEdgeList ()
 Builds a mapping from edge id to source/target vertex id. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void GetOutEdges (vtkIdType v, const vtkOutEdgeType *&edges, vtkIdType &nedges)
 Fast access functions for iterators. More...
 
virtual vtkIdTypeArrayGetEdgeList ()
 The optional mapping from edge id to source/target ids. More...
 
virtual void SetEdgeList (vtkIdTypeArray *list)
 The optional mapping from edge id to source/target ids. More...
 
- Protected Member Functions inherited from vtkDataObject
 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkGraphEdgeGraphEdge
 Graph edge that is reused of AddGraphEdge calls. More...
 
- Protected Attributes inherited from vtkGraph
vtkGraphInternalsInternals
 The adjacency list internals of this graph. More...
 
vtkDistributedGraphHelperDistributedHelper
 The distributed graph helper. More...
 
vtkGraphEdgePoints * EdgePoints
 The structure for holding the edge points. More...
 
double Bounds [6]
 (xmin,xmax, ymin,ymax, zmin,zmax) geometric bounds. More...
 
vtkTimeStamp ComputeTime
 Time at which bounds were computed. More...
 
vtkDataSetAttributesVertexData
 The vertex and edge data. More...
 
vtkDataSetAttributesEdgeData
 The vertex and edge data. More...
 
vtkPointsPoints
 The vertex locations. More...
 
vtkIdTypeArrayEdgeList
 The optional mapping from edge id to source/target ids. More...
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Attributes inherited from vtkGraph
static double DefaultPoint [3]
 The vertex locations. More...
 

Detailed Description

An editable undirected graph.

vtkMutableUndirectedGraph is an undirected graph with additional functions for adding vertices and edges. ShallowCopy(), DeepCopy(), CheckedShallowCopy(), and CheckedDeepCopy() will succeed when the argument is a vtkUndirectedGraph or vtkMutableUndirectedGraph.

See also
vtkUndirectedGraph vtkGraph
Tests:
vtkMutableUndirectedGraph (Tests)

Definition at line 46 of file vtkMutableUndirectedGraph.h.

Member Typedef Documentation

Definition at line 50 of file vtkMutableUndirectedGraph.h.

Constructor & Destructor Documentation

vtkMutableUndirectedGraph::vtkMutableUndirectedGraph ( )
protected
vtkMutableUndirectedGraph::~vtkMutableUndirectedGraph ( )
overrideprotected

Member Function Documentation

static vtkMutableUndirectedGraph* vtkMutableUndirectedGraph::New ( )
static
static int vtkMutableUndirectedGraph::IsTypeOf ( const char *  type)
static
virtual int vtkMutableUndirectedGraph::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 vtkUndirectedGraph.

static vtkMutableUndirectedGraph* vtkMutableUndirectedGraph::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMutableUndirectedGraph::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkUndirectedGraph.

vtkMutableUndirectedGraph* vtkMutableUndirectedGraph::NewInstance ( ) const
void vtkMutableUndirectedGraph::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 vtkGraph.

virtual vtkIdType vtkMutableUndirectedGraph::SetNumberOfVertices ( vtkIdType  numVerts)
virtual

Allocates space for the specified number of vertices in the graph's internal data structures.

The previous number of vertices is returned on success and -1 is returned on failure.

This has no effect on the number of vertex coordinate tuples or vertex attribute tuples allocated; you are responsible for guaranteeing these match. Also, this call is not implemented for distributed-memory graphs since the semantics are unclear; calling this function on a graph with a non-nullptr DistributedGraphHelper will generate an error message, no allocation will be performed, and a value of -1 will be returned.

vtkIdType vtkMutableUndirectedGraph::AddVertex ( )

Adds a vertex to the graph and returns the index of the new vertex.

Note
In a distributed graph (i.e. a graph whose DistributedHelper is non-null), this routine cannot be used to add a vertex if the vertices in the graph have pedigree IDs, because this routine will always add the vertex locally, which may conflict with the proper location of the vertex based on the distribution of the pedigree IDs.
vtkIdType vtkMutableUndirectedGraph::AddVertex ( vtkVariantArray propertyArr)

Adds a vertex to the graph with associated properties defined in propertyArr and returns the index of the new vertex.

The number and order of values in propertyArr must match up with the arrays in the vertex data retrieved by GetVertexData().

If a vertex with the given pedigree ID already exists, its properties will be overwritten with the properties in propertyArr and the existing vertex index will be returned.

Note
In a distributed graph (i.e. a graph whose DistributedHelper is non-null) the vertex added or found might not be local. In this case, AddVertex will wait until the vertex can be added or found remotely, so that the proper vertex index can be returned. If you don't actually need to use the vertex index, consider calling LazyAddVertex, which provides better performance by eliminating the delays associated with returning the vertex index.
vtkIdType vtkMutableUndirectedGraph::AddVertex ( const vtkVariant pedigreeId)

Adds a vertex with the given pedigreeID to the graph and returns the index of the new vertex.

If a vertex with the given pedigree ID already exists, the existing vertex index will be returned.

Note
In a distributed graph (i.e. a graph whose DistributedHelper is non-null) the vertex added or found might not be local. In this case, AddVertex will wait until the vertex can be added or found remotely, so that the proper vertex index can be returned. If you don't actually need to use the vertex index, consider calling LazyAddVertex, which provides better performance by eliminating the delays associated with returning the vertex index.
vtkEdgeType vtkMutableUndirectedGraph::AddEdge ( vtkIdType  u,
vtkIdType  v 
)

Adds an undirected edge from u to v, where u and v are vertex indices, and returns a vtkEdgeType structure describing that edge.

vtkEdgeType contains fields for Source vertex index, Target vertex index, and edge index Id.

vtkEdgeType vtkMutableUndirectedGraph::AddEdge ( vtkIdType  u,
vtkIdType  v,
vtkVariantArray propertyArr 
)

Adds an undirected edge from u to v, where u and v are vertex indices, with associated properties defined in propertyArr and returns a vtkEdgeType structure describing that edge.

The number and order of values in propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

vtkEdgeType contains fields for Source vertex index, Target vertex index, and edge index Id.

vtkEdgeType vtkMutableUndirectedGraph::AddEdge ( const vtkVariant u,
vtkIdType  v,
vtkVariantArray propertyArr = nullptr 
)

Adds an undirected edge from u to v, where u is a vertex pedigree ID and v is a vertex index, and returns a vtkEdgeType structure describing that edge.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

vtkEdgeType contains fields for Source vertex index, Target vertex index, and edge index Id.

vtkEdgeType vtkMutableUndirectedGraph::AddEdge ( vtkIdType  u,
const vtkVariant v,
vtkVariantArray propertyArr = nullptr 
)

Adds a directed edge from u to v, where u is a vertex index and v is a vertex pedigree ID, and returns a vtkEdgeType structure describing that edge.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

vtkEdgeType contains fields for Source vertex index, Target vertex index, and edge index Id.

vtkEdgeType vtkMutableUndirectedGraph::AddEdge ( const vtkVariant u,
const vtkVariant v,
vtkVariantArray propertyArr = nullptr 
)

Adds a directed edge from u to v, where u and v are vertex pedigree IDs, and returns a vtkEdgeType structure describing that edge.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

vtkEdgeType contains fields for Source vertex index, Target vertex index, and edge index Id.

void vtkMutableUndirectedGraph::LazyAddVertex ( )

Adds a vertex to the graph.

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddVertex ( vtkVariantArray propertyArr)

Adds a vertex to the graph with associated properties defined in propertyArr.

The number and order of values in propertyArr must match up with the arrays in the vertex data retrieved by GetVertexData().

If a vertex with the given pedigree ID already exists, its properties will be overwritten with the properties in propertyArr.

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddVertex ( const vtkVariant pedigreeId)

Adds a vertex with the given pedigreeID to the graph.

If a vertex with the given pedigree ID already exists, no operation is performed.

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddEdge ( vtkIdType  u,
vtkIdType  v 
)

Adds an undirected edge from u to v, where u and v are vertex indices.

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddEdge ( vtkIdType  u,
vtkIdType  v,
vtkVariantArray propertyArr 
)

Adds an undirected edge from u to v, where u and v are vertex indices.

The number and order of values in propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddEdge ( const vtkVariant u,
vtkIdType  v,
vtkVariantArray propertyArr = nullptr 
)

Adds an undirected edge from u to v, where u is a vertex pedigree ID and v is a vertex index.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddEdge ( vtkIdType  u,
const vtkVariant v,
vtkVariantArray propertyArr = nullptr 
)

Adds an undirected edge from u to v, where u is a vertex index and v is a vertex pedigree ID.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

void vtkMutableUndirectedGraph::LazyAddEdge ( const vtkVariant u,
const vtkVariant v,
vtkVariantArray propertyArr = nullptr 
)

Adds an undirected edge from u to v, where u and v are vertex pedigree IDs.

The number and order of values in the optional parameter propertyArr must match up with the arrays in the edge data retrieved by GetEdgeData().

This method is lazily evaluated for distributed graphs (i.e. graphs whose DistributedHelper is non-null) the next time Synchronize is called on the helper.

vtkGraphEdge* vtkMutableUndirectedGraph::AddGraphEdge ( vtkIdType  u,
vtkIdType  v 
)

Variant of AddEdge() that returns a heavyweight vtkGraphEdge object.

The graph owns the reference of the edge and will replace its contents on the next call to AddGraphEdge().

Note
This is a less efficient method for use with wrappers. In C++ you should use the faster AddEdge().
void vtkMutableUndirectedGraph::RemoveVertex ( vtkIdType  v)

Removes the vertex from the graph along with any connected edges.

Note: This invalidates the last vertex index, which is reassigned to v.

void vtkMutableUndirectedGraph::RemoveEdge ( vtkIdType  e)

Removes the edge from the graph.

Note: This invalidates the last edge index, which is reassigned to e.

void vtkMutableUndirectedGraph::RemoveVertices ( vtkIdTypeArray arr)

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

void vtkMutableUndirectedGraph::RemoveEdges ( vtkIdTypeArray arr)

Removes a collection of edges from the graph.

Member Data Documentation

vtkGraphEdge* vtkMutableUndirectedGraph::GraphEdge
protected

Graph edge that is reused of AddGraphEdge calls.

Definition at line 334 of file vtkMutableUndirectedGraph.h.


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