An editable directed graph. More...

#include <vtkMutableDirectedGraph.h>

Inheritance diagram for vtkMutableDirectedGraph:

Collaboration diagram for vtkMutableDirectedGraph:

Public Types
typedef vtkDirectedGraph	Superclass

Public Types inherited from vtkDirectedGraph
typedef vtkGraph	Superclass

Public Types inherited from vtkGraph
typedef vtkDataObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkIdType	SetNumberOfVertices (vtkIdType numVerts)

vtkIdType	AddVertex ()

vtkIdType	AddVertex (vtkVariantArray *propertyArr)

vtkIdType	AddVertex (const vtkVariant &pedigreeId)

void	LazyAddVertex ()

void	LazyAddVertex (vtkVariantArray *propertyArr)

void	LazyAddVertex (const vtkVariant &pedigreeId)

void	LazyAddEdge (vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr=0)

vtkGraphEdge *	AddGraphEdge (vtkIdType u, vtkIdType v)

void	RemoveVertex (vtkIdType v)

void	RemoveEdge (vtkIdType e)

void	RemoveVertices (vtkIdTypeArray *arr)

void	RemoveEdges (vtkIdTypeArray *arr)


vtkEdgeType	AddEdge (vtkIdType u, vtkIdType v)


vtkEdgeType	AddEdge (vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr)


vtkEdgeType	AddEdge (const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=0)


vtkEdgeType	AddEdge (vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=0)


vtkEdgeType	AddEdge (const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=0)


void	LazyAddEdge (const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=0)


void	LazyAddEdge (vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=0)


void	LazyAddEdge (const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=0)


vtkIdType	AddChild (vtkIdType parent, vtkVariantArray *propertyArr)

vtkIdType	AddChild (vtkIdType parent)

Public Member Functions inherited from vtkDirectedGraph
void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetDataObjectType ()

virtual bool	IsStructureValid (vtkGraph *g)

Public Member Functions inherited from vtkGraph
void	PrintSelf (ostream &os, vtkIndent indent)

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	GetInEdges (vtkIdType v, vtkInEdgeIterator *it)

virtual vtkIdType	GetInDegree (vtkIdType v)

virtual void	GetInEdge (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)

double *	GetEdgePoint (vtkIdType e, vtkIdType i)

void	ClearEdgePoints (vtkIdType e)

vtkGraphInternals *	GetGraphInternals (bool modifying)

void	GetInducedEdges (vtkIdTypeArray verts, vtkIdTypeArray edges)

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual vtkIdType	GetNumberOfElements (int type)

void	Dump ()

vtkIdType	GetEdgeId (vtkIdType a, vtkIdType b)

bool	ToDirectedGraph (vtkDirectedGraph *g)

bool	ToUndirectedGraph (vtkUndirectedGraph *g)

virtual vtkDataSetAttributes *	GetVertexData ()

virtual vtkDataSetAttributes *	GetEdgeData ()

double *	GetPoint (vtkIdType ptId)

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

vtkPoints *	GetPoints ()

virtual void	SetPoints (vtkPoints *points)

double *	GetBounds ()

void	GetBounds (double bounds[6])

virtual vtkOutEdgeType	GetOutEdge (vtkIdType v, vtkIdType index)

virtual vtkInEdgeType	GetInEdge (vtkIdType v, vtkIdType index)

vtkDistributedGraphHelper *	GetDistributedGraphHelper ()

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)

Static Public Member Functions
static vtkMutableDirectedGraph *	New ()

static int	IsTypeOf (const char *type)

static vtkMutableDirectedGraph *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkDirectedGraph *	SafeDownCast (vtkObject *o)

static vtkDirectedGraph *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkGraph
static int	IsTypeOf (const char *type)

static vtkGraph *	SafeDownCast (vtkObject *o)

static vtkGraph *	GetData (vtkInformation *info)

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

Protected Member Functions
	vtkMutableDirectedGraph ()

	~vtkMutableDirectedGraph ()

Protected Member Functions inherited from vtkDirectedGraph
	vtkDirectedGraph ()

	~vtkDirectedGraph ()

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 void	GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)

virtual vtkIdTypeArray *	GetEdgeList ()

virtual void	SetEdgeList (vtkIdTypeArray *list)

Protected Attributes
vtkGraphEdge *	GraphEdge

Protected Attributes inherited from vtkGraph
vtkGraphInternals *	Internals

vtkDistributedGraphHelper *	DistributedHelper

vtkGraphEdgePoints *	EdgePoints

double	Bounds [6]

vtkTimeStamp	ComputeTime

vtkDataSetAttributes *	VertexData

vtkDataSetAttributes *	EdgeData

vtkPoints *	Points

vtkIdTypeArray *	EdgeList

Detailed Description

An editable directed graph.

vtkMutableDirectedGraph is a directed graph which has additional methods for adding edges and vertices. AddChild() is a convenience method for constructing trees. ShallowCopy(), DeepCopy(), CheckedShallowCopy() and CheckedDeepCopy() will succeed for instances of vtkDirectedGraph, vtkMutableDirectedGraph and vtkTree.

See Also: vtkDirectedGraph vtkGraph vtkTree

Examples:: vtkMutableDirectedGraph (Examples)

Tests:: vtkMutableDirectedGraph (Tests)

Definition at line 49 of file vtkMutableDirectedGraph.h.

Member Typedef Documentation

typedef vtkDirectedGraph vtkMutableDirectedGraph::Superclass

Definition at line 53 of file vtkMutableDirectedGraph.h.

Constructor & Destructor Documentation

vtkMutableDirectedGraph::vtkMutableDirectedGraph ( )

protected

vtkMutableDirectedGraph::~vtkMutableDirectedGraph ( )

protected

Member Function Documentation

static vtkMutableDirectedGraph* vtkMutableDirectedGraph::New ( )

static

virtual const char* vtkMutableDirectedGraph::GetClassName ( )

virtual

Reimplemented from vtkDirectedGraph.

static int vtkMutableDirectedGraph::IsTypeOf ( const char * type )

static

virtual int vtkMutableDirectedGraph::IsA ( const char * type )

virtual

Reimplemented from vtkDirectedGraph.

static vtkMutableDirectedGraph* vtkMutableDirectedGraph::SafeDownCast ( vtkObject * o )

static

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

virtual vtkIdType vtkMutableDirectedGraph::SetNumberOfVertices ( vtkIdType numVerts )

virtual

Allocates space for the specified number of vertices in the graph's internal data structures. 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-NULL DistributedGraphHelper will generate an error message and no allocation will be performed.

vtkIdType vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::AddEdge	(	vtkIdType	u,
		vtkIdType	v
	)

Adds a directed 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 vtkMutableDirectedGraph::AddEdge	(	vtkIdType	u,
		vtkIdType	v,
		vtkVariantArray *	propertyArr
	)

Adds a directed 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 vtkMutableDirectedGraph::AddEdge	(	const vtkVariant &	u,
		vtkIdType	v,
		vtkVariantArray *	propertyArr = `0`
	)

Adds a directed 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 vtkMutableDirectedGraph::AddEdge	(	vtkIdType	u,
		const vtkVariant &	v,
		vtkVariantArray *	propertyArr = `0`
	)

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 vtkMutableDirectedGraph::AddEdge	(	const vtkVariant &	u,
		const vtkVariant &	v,
		vtkVariantArray *	propertyArr = `0`
	)

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 vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::LazyAddEdge	(	vtkIdType	u,
		vtkIdType	v,
		vtkVariantArray *	propertyArr = `0`
	)

Adds a directed edge from u to v, where u and v are vertex indices. 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 vtkMutableDirectedGraph::LazyAddEdge	(	const vtkVariant &	u,
		vtkIdType	v,
		vtkVariantArray *	propertyArr = `0`
	)

Adds a directed 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 vtkMutableDirectedGraph::LazyAddEdge	(	vtkIdType	u,
		const vtkVariant &	v,
		vtkVariantArray *	propertyArr = `0`
	)

Adds a directed 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 vtkMutableDirectedGraph::LazyAddEdge	(	const vtkVariant &	u,
		const vtkVariant &	v,
		vtkVariantArray *	propertyArr = `0`
	)

Adds a directed 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* vtkMutableDirectedGraph::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().

vtkIdType vtkMutableDirectedGraph::AddChild	(	vtkIdType	parent,
		vtkVariantArray *	propertyArr
	)

Convenience method for creating trees. Returns the newly created vertex id. Shortcut for

vtkIdType v = g->AddVertex();

g->AddEdge(parent, v);

If non-null, propertyArr provides edge properties for the newly-created edge. The values in propertyArr must match up with the arrays in the edge data returned by GetEdgeData().

vtkIdType vtkMutableDirectedGraph::AddChild ( vtkIdType parent )

inline

Convenience method for creating trees. Returns the newly created vertex id. Shortcut for

vtkIdType v = g->AddVertex();

g->AddEdge(parent, v);

If non-null, propertyArr provides edge properties for the newly-created edge. The values in propertyArr must match up with the arrays in the edge data returned by GetEdgeData().

Definition at line 244 of file vtkMutableDirectedGraph.h.

void vtkMutableDirectedGraph::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 vtkMutableDirectedGraph::RemoveEdge ( vtkIdType e )

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

void vtkMutableDirectedGraph::RemoveVertices ( vtkIdTypeArray * arr )

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

void vtkMutableDirectedGraph::RemoveEdges ( vtkIdTypeArray * arr )

Removes a collection of edges from the graph.

Member Data Documentation

vtkGraphEdge* vtkMutableDirectedGraph::GraphEdge

protected

Graph edge that is reused of AddGraphEdge calls.

Definition at line 269 of file vtkMutableDirectedGraph.h.

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

dox/Filtering/vtkMutableDirectedGraph.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation