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

An undirected graph. More...

#include <vtkUndirectedGraph.h>

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

Public Types

typedef vtkGraph Superclass
 
- Public Types inherited from vtkGraph
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
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
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkUndirectedGraphNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetDataObjectType ()
 
virtual vtkIdType GetInDegree (vtkIdType v)
 
virtual bool IsStructureValid (vtkGraph *g)
 
virtual vtkInEdgeType GetInEdge (vtkIdType v, vtkIdType i)
 
virtual void GetInEdge (vtkIdType v, vtkIdType i, vtkGraphEdge *e)
 
virtual void GetInEdges (vtkIdType v, vtkInEdgeIterator *it)
 
- Public Member Functions inherited from vtkGraph
vtkGraphNewInstance () const
 
virtual void Initialize ()
 
void ComputeBounds ()
 
unsigned long int GetMTime ()
 
virtual void GetOutEdges (vtkIdType v, vtkOutEdgeIterator *it)
 
virtual vtkIdType GetDegree (vtkIdType v)
 
virtual vtkIdType GetOutDegree (vtkIdType v)
 
virtual void GetOutEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
 
virtual void GetAdjacentVertices (vtkIdType v, vtkAdjacentVertexIterator *it)
 
virtual void GetEdges (vtkEdgeListIterator *it)
 
virtual vtkIdType GetNumberOfEdges ()
 
virtual void GetVertices (vtkVertexListIterator *it)
 
virtual vtkIdType GetNumberOfVertices ()
 
void SetDistributedGraphHelper (vtkDistributedGraphHelper *helper)
 
vtkIdType FindVertex (const vtkVariant &pedigreeID)
 
virtual void ShallowCopy (vtkDataObject *obj)
 
virtual void DeepCopy (vtkDataObject *obj)
 
virtual void CopyStructure (vtkGraph *g)
 
virtual bool CheckedShallowCopy (vtkGraph *g)
 
virtual bool CheckedDeepCopy (vtkGraph *g)
 
virtual void Squeeze ()
 
void ReorderOutVertices (vtkIdType v, vtkIdTypeArray *vertices)
 
bool IsSameStructure (vtkGraph *other)
 
vtkIdType GetNumberOfEdgePoints (vtkIdType e)
 
doubleGetEdgePoint (vtkIdType e, vtkIdType i)
 
void ClearEdgePoints (vtkIdType e)
 
vtkGraphInternalsGetGraphInternals (bool modifying)
 
void GetInducedEdges (vtkIdTypeArray *verts, vtkIdTypeArray *edges)
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 
virtual vtkIdType GetNumberOfElements (int type)
 
void Dump ()
 
vtkIdType GetEdgeId (vtkIdType a, vtkIdType b)
 
bool ToDirectedGraph (vtkDirectedGraph *g)
 
bool ToUndirectedGraph (vtkUndirectedGraph *g)
 
virtual vtkDataSetAttributesGetVertexData ()
 
virtual vtkDataSetAttributesGetEdgeData ()
 
doubleGetPoint (vtkIdType ptId)
 
void GetPoint (vtkIdType ptId, double x[3])
 
vtkPointsGetPoints ()
 
virtual void SetPoints (vtkPoints *points)
 
doubleGetBounds ()
 
void GetBounds (double bounds[6])
 
virtual vtkOutEdgeType GetOutEdge (vtkIdType v, vtkIdType index)
 
vtkDistributedGraphHelperGetDistributedGraphHelper ()
 
vtkIdType GetSourceVertex (vtkIdType e)
 
vtkIdType GetTargetVertex (vtkIdType e)
 
void SetEdgePoints (vtkIdType e, vtkIdType npts, double *pts)
 
void GetEdgePoints (vtkIdType e, vtkIdType &npts, double *&pts)
 
void SetEdgePoint (vtkIdType e, vtkIdType i, double x[3])
 
void SetEdgePoint (vtkIdType e, vtkIdType i, double x, double y, double z)
 
void AddEdgePoint (vtkIdType e, double x[3])
 
void AddEdgePoint (vtkIdType e, double x, double y, double z)
 
void ShallowCopyEdgePoints (vtkGraph *g)
 
void DeepCopyEdgePoints (vtkGraph *g)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributesGetAttributes (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldDataGetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkUndirectedGraphNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUndirectedGraphSafeDownCast (vtkObjectBase *o)
 
static vtkUndirectedGraphGetData (vtkInformation *info)
 
static vtkUndirectedGraphGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkGraph
static int IsTypeOf (const char *type)
 
static vtkGraphSafeDownCast (vtkObjectBase *o)
 
static vtkGraphGetData (vtkInformation *info)
 
static vtkGraphGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
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 vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUndirectedGraph ()
 
 ~vtkUndirectedGraph ()
 
virtual void GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
 
- Protected Member Functions inherited from vtkGraph
 vtkGraph ()
 
 ~vtkGraph ()
 
void AddVertexInternal (const vtkVariant &pedigree, vtkIdType *vertex)
 
void RemoveVertexInternal (vtkIdType v, bool directed)
 
void RemoveEdgeInternal (vtkIdType e, bool directed)
 
void RemoveVerticesInternal (vtkIdTypeArray *arr, bool directed)
 
virtual void CopyInternal (vtkGraph *g, bool deep)
 
void SetInternals (vtkGraphInternals *internals)
 
void SetEdgePoints (vtkGraphEdgePoints *edgePoints)
 
void ForceOwnership ()
 
void BuildEdgeList ()
 
void AddVertexInternal (vtkVariantArray *propertyArr=0, vtkIdType *vertex=0)
 
void AddEdgeInternal (vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 
void AddEdgeInternal (const vtkVariant &uPedigree, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 
void AddEdgeInternal (vtkIdType u, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 
void AddEdgeInternal (const vtkVariant &uPedigree, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 
void RemoveEdgesInternal (vtkIdTypeArray *arr, bool directed)
 
virtual void GetOutEdges (vtkIdType v, const vtkOutEdgeType *&edges, vtkIdType &nedges)
 
virtual vtkIdTypeArrayGetEdgeList ()
 
virtual void SetEdgeList (vtkIdTypeArray *list)
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkGraph
vtkGraphInternalsInternals
 
vtkDistributedGraphHelperDistributedHelper
 
vtkGraphEdgePoints * EdgePoints
 
double Bounds [6]
 
vtkTimeStamp ComputeTime
 
vtkDataSetAttributesVertexData
 
vtkDataSetAttributesEdgeData
 
vtkPointsPoints
 
vtkIdTypeArrayEdgeList
 
- 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
 
- Static Protected Attributes inherited from vtkGraph
static double DefaultPoint [3]
 

Detailed Description

An undirected graph.

vtkUndirectedGraph is a collection of vertices along with a collection of undirected edges (they connect two vertices in no particular order). ShallowCopy(), DeepCopy(), CheckedShallowCopy(), CheckedDeepCopy() accept instances of vtkUndirectedGraph and vtkMutableUndirectedGraph. GetOutEdges(v, it) and GetInEdges(v, it) return the same list of edges, which is the list of all edges which have a v as an endpoint. GetInDegree(v), GetOutDegree(v) and GetDegree(v) all return the full degree of vertex v.

vtkUndirectedGraph is read-only. To create an undirected graph, use an instance of vtkMutableUndirectedGraph, then you may set the structure to a vtkUndirectedGraph using ShallowCopy().

See also
vtkGraph vtkMutableUndirectedGraph
Examples:
vtkUndirectedGraph (Examples)
Tests:
vtkUndirectedGraph (Tests)

Definition at line 53 of file vtkUndirectedGraph.h.

Member Typedef Documentation

Definition at line 57 of file vtkUndirectedGraph.h.

Constructor & Destructor Documentation

vtkUndirectedGraph::vtkUndirectedGraph ( )
protected
vtkUndirectedGraph::~vtkUndirectedGraph ( )
protected

Member Function Documentation

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

Reimplemented in vtkMolecule, and vtkMutableUndirectedGraph.

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

Reimplemented from vtkGraph.

Reimplemented in vtkMolecule, and vtkMutableUndirectedGraph.

vtkUndirectedGraph* vtkUndirectedGraph::NewInstance ( ) const
void vtkUndirectedGraph::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 int vtkUndirectedGraph::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkGraph.

Reimplemented in vtkMolecule.

Definition at line 61 of file vtkUndirectedGraph.h.

virtual vtkIdType vtkUndirectedGraph::GetInDegree ( vtkIdType  v)
virtual

Returns the full degree of the vertex.

Reimplemented from vtkGraph.

virtual vtkInEdgeType vtkUndirectedGraph::GetInEdge ( vtkIdType  v,
vtkIdType  i 
)
virtual

Random-access method for retrieving the in edges of a vertex. For an undirected graph, this is the same as the out edges.

Reimplemented from vtkGraph.

virtual void vtkUndirectedGraph::GetInEdge ( vtkIdType  v,
vtkIdType  i,
vtkGraphEdge e 
)
inlinevirtual

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

Definition at line 79 of file vtkUndirectedGraph.h.

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

Retrieve a graph from an information vector.

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

Retrieve a graph from an information vector.

virtual void vtkUndirectedGraph::GetInEdges ( vtkIdType  v,
vtkInEdgeIterator it 
)
inlinevirtual

Initialize the iterator to get the incoming edges to a vertex. For an undirected graph, this is all incident edges.

Reimplemented from vtkGraph.

Definition at line 94 of file vtkUndirectedGraph.h.

virtual bool vtkUndirectedGraph::IsStructureValid ( vtkGraph g)
virtual

Check the structure, and accept it if it is a valid undirected graph. This is public to allow the ToDirected/UndirectedGraph to work.

Implements vtkGraph.

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

For iterators, returns the same edge list as GetOutEdges().

Reimplemented from vtkGraph.


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