A rooted tree data structure. More...

#include <vtkTree.h>

Inheritance diagram for vtkTree:

Collaboration diagram for vtkTree:

Public Types
typedef vtkDirectedAcyclicGraph	Superclass

Public Types inherited from vtkDirectedAcyclicGraph
typedef vtkDirectedGraph	Superclass

Public Types inherited from vtkDirectedGraph
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...

vtkTree *	NewInstance () 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	GetNumberOfChildren (vtkIdType v)
	Get the number of children of a vertex. More...

vtkIdType	GetChild (vtkIdType v, vtkIdType i)
	Get the i-th child of a parent vertex. More...

void	GetChildren (vtkIdType v, vtkAdjacentVertexIterator *it)
	Get the child vertices of a vertex. More...

vtkIdType	GetParent (vtkIdType v)
	Get the parent of a vertex. More...

vtkEdgeType	GetParentEdge (vtkIdType v)
	Get the edge connecting the vertex to its parent. More...

vtkIdType	GetLevel (vtkIdType v)
	Get the level of the vertex in the tree. More...

bool	IsLeaf (vtkIdType vertex)
	Return whether the vertex is a leaf (i.e. More...

virtual void	ReorderChildren (vtkIdType parent, vtkIdTypeArray *children)
	Reorder the children of a parent vertex. More...


virtual vtkIdType	GetRoot ()
	Get the root vertex of the tree. More...

Public Member Functions inherited from vtkDirectedAcyclicGraph
vtkDirectedAcyclicGraph *	NewInstance () const

Public Member Functions inherited from vtkDirectedGraph
vtkDirectedGraph *	NewInstance () const

Public Member Functions inherited from vtkGraph
vtkGraph *	NewInstance () 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	GetInEdges (vtkIdType v, vtkInEdgeIterator *it)
	Initializes the in edge iterator to iterate over all incoming edges to vertex v. More...

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

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

virtual void	GetInEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
	Random-access method for retrieving incoming edges to 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...

vtkDistributedGraphHelper *	GetDistributedGraphHelper ()
	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...

double *	GetEdgePoint (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)

vtkGraphInternals *	GetGraphInternals (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...

vtkFieldData *	GetAttributesAsFieldData (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 vtkDataSetAttributes *	GetVertexData ()
	Get the vertex or edge data. More...

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

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

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

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

double *	GetBounds ()
	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
vtkDataObject *	NewInstance () 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 vtkDataSetAttributes *	GetAttributes (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 vtkInformation *	GetInformation ()
	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 vtkFieldData *	GetFieldData ()
	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...

vtkCommand *	GetCommand (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 vtkTree *	New ()

static int	IsTypeOf (const char *type)

static vtkTree *	SafeDownCast (vtkObjectBase *o)


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

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

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

static int	IsTypeOf (const char *type)

static vtkDirectedAcyclicGraph *	SafeDownCast (vtkObjectBase *o)

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

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

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

static int	IsTypeOf (const char *type)

static vtkDirectedGraph *	SafeDownCast (vtkObjectBase *o)

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

static vtkDirectedGraph *	GetData (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 vtkGraph *	SafeDownCast (vtkObjectBase *o)

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

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

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

static int	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) More...

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

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

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). 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 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 *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

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

static vtkDataObject *	GetData (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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTree ()

	~vtkTree () override

bool	IsStructureValid (vtkGraph *g) override
	Check the storage, and accept it if it is a valid tree. More...

Protected Member Functions inherited from vtkDirectedAcyclicGraph
	vtkDirectedAcyclicGraph ()

	~vtkDirectedAcyclicGraph () override

Protected Member Functions inherited from vtkDirectedGraph
	vtkDirectedGraph ()

	~vtkDirectedGraph () override

Protected Member Functions inherited from vtkGraph
	vtkGraph ()

	~vtkGraph () override

void	AddVertexInternal (vtkVariantArray propertyArr=0, vtkIdType vertex=0)
	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 void	GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
	Fast access functions for iterators. More...

virtual vtkIdTypeArray *	GetEdgeList ()
	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=NULL)
	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
vtkIdType	Root
	The root of the tree. More...

Protected Attributes inherited from vtkGraph
vtkGraphInternals *	Internals
	The adjacency list internals of this graph. More...

vtkDistributedGraphHelper *	DistributedHelper
	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...

vtkDataSetAttributes *	VertexData
	The vertex and edge data. More...

vtkDataSetAttributes *	EdgeData
	The vertex and edge data. More...

vtkPoints *	Points
	The vertex locations. More...

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

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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

A rooted tree data structure.

vtkTree is a connected directed graph with no cycles. A tree is a type of directed graph, so works with all graph algorithms.

vtkTree is a read-only data structure. To construct a tree, create an instance of vtkMutableDirectedGraph. Add vertices and edges with AddVertex() and AddEdge(). You may alternately start by adding a single vertex as the root then call graph->AddChild(parent) which adds a new vertex and connects the parent to the child. The tree MUST have all edges in the proper direction, from parent to child. After building the tree, call tree->CheckedShallowCopy(graph) to copy the structure into a vtkTree. This method will return false if the graph is an invalid tree.

vtkTree provides some convenience methods for obtaining the parent and children of a vertex, for finding the root, and determining if a vertex is a leaf (a vertex with no children).

See also: vtkDirectedGraph vtkMutableDirectedGraph vtkGraph

Examples:: vtkTree (Examples)

Tests:: vtkTree (Tests)

Definition at line 60 of file vtkTree.h.

Member Typedef Documentation

typedef vtkDirectedAcyclicGraph vtkTree::Superclass

Definition at line 64 of file vtkTree.h.

Constructor & Destructor Documentation

vtkTree::vtkTree ( )

protected

vtkTree::~vtkTree ( )

overrideprotected

Member Function Documentation

static vtkTree* vtkTree::New ( )

static

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

static

virtual int vtkTree::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 vtkDirectedAcyclicGraph.

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

static

virtual vtkObjectBase* vtkTree::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDirectedAcyclicGraph.

vtkTree* vtkTree::NewInstance ( ) const

void vtkTree::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 vtkDirectedAcyclicGraph.

int vtkTree::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDirectedAcyclicGraph.

Definition at line 70 of file vtkTree.h.

virtual vtkIdType vtkTree::GetRoot ( )

virtual

Get the root vertex of the tree.

vtkIdType vtkTree::GetNumberOfChildren ( vtkIdType v )

inline

Get the number of children of a vertex.

Definition at line 82 of file vtkTree.h.

vtkIdType vtkTree::GetChild	(	vtkIdType	v,
		vtkIdType	i
	)

Get the i-th child of a parent vertex.

void vtkTree::GetChildren	(	vtkIdType	v,
		vtkAdjacentVertexIterator *	it
	)

inline

Get the child vertices of a vertex.

This is a convenience method that functions exactly like GetAdjacentVertices.

Definition at line 95 of file vtkTree.h.

vtkIdType vtkTree::GetParent ( vtkIdType v )

Get the parent of a vertex.

vtkEdgeType vtkTree::GetParentEdge ( vtkIdType v )

Get the edge connecting the vertex to its parent.

vtkIdType vtkTree::GetLevel ( vtkIdType v )

Get the level of the vertex in the tree.

The root vertex has level 0. Returns -1 if the vertex id is < 0 or greater than the number of vertices in the tree.

bool vtkTree::IsLeaf ( vtkIdType vertex )

Return whether the vertex is a leaf (i.e.

it has no children).

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

static

Retrieve a graph from an information vector.

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

static

Retrieve a graph from an information vector.

virtual void vtkTree::ReorderChildren	(	vtkIdType	parent,
		vtkIdTypeArray *	children
	)

virtual

Reorder the children of a parent vertex.

The children array must contain all the children of parent, just in a different order. This does not change the topology of the tree.

bool vtkTree::IsStructureValid ( vtkGraph * g )

overrideprotectedvirtual

Check the storage, and accept it if it is a valid tree.

Reimplemented from vtkDirectedAcyclicGraph.

Member Data Documentation

vtkIdType vtkTree::Root

protected

The root of the tree.

Definition at line 149 of file vtkTree.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/DataModel/vtkTree.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation