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

A rooted tree data structure. More...

#include <vtkTree.h>

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

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
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 const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetDataObjectType ()
vtkIdType GetChild (vtkIdType v, vtkIdType i)
vtkIdType GetParent (vtkIdType v)
vtkIdType GetLevel (vtkIdType v)
bool IsLeaf (vtkIdType vertex)
virtual void ReorderChildren (vtkIdType parent, vtkIdTypeArray *children)
virtual vtkIdType GetRoot ()
vtkIdType GetNumberOfChildren (vtkIdType v)
void GetChildren (vtkIdType v, vtkAdjacentVertexIterator *it)
vtkEdgeType GetParentEdge (vtkIdType v)

Static Public Member Functions

static vtkTreeNew ()
static int IsTypeOf (const char *type)
static vtkTreeSafeDownCast (vtkObject *o)
static vtkTreeGetData (vtkInformation *info)
static vtkTreeGetData (vtkInformationVector *v, int i=0)
- Static Public Member Functions inherited from vtkDataObject
static const char * GetAssociationTypeAsString (int associationType)
static vtkInformationStringKeyDATA_TYPE_NAME ()
static
vtkInformationDataObjectKey
DATA_OBJECT ()
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKeyDATA_RESOLUTION ()
static
vtkInformationDoubleVectorKey
DATA_TIME_STEPS ()
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
EDGE_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
vtkInformationDoubleVectorKey
FIELD_RANGE ()
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
static vtkInformationStringKeyFIELD_NAME ()
static
vtkInformationDoubleVectorKey
ORIGIN ()
static
vtkInformationDoubleVectorKey
SPACING ()
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
static
vtkInformationDataObjectKey
SIL ()
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 void SetGlobalReleaseDataFlag (int val)
static int GetGlobalReleaseDataFlag ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkTree ()
 ~vtkTree ()
virtual bool IsStructureValid (vtkGraph *g)
- Protected Member Functions inherited from vtkDirectedAcyclicGraph
 vtkDirectedAcyclicGraph ()
 ~vtkDirectedAcyclicGraph ()
- 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 vtkIdTypeArrayGetEdgeList ()
virtual void SetEdgeList (vtkIdTypeArray *list)
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 ~vtkDataObject ()
vtkExecutiveGetExecutive ()
int GetPortNumber ()
virtual void ReportReferences (vtkGarbageCollector *)
vtkStreamingDemandDrivenPipelineTrySDDP (const char *method)
- 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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkIdType Root

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
- Static Protected Attributes inherited from vtkGraph
static double DefaultPoint [3]
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]

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 58 of file vtkTree.h.

Member Typedef Documentation

Definition at line 62 of file vtkTree.h.

Constructor & Destructor Documentation

vtkTree::vtkTree ( )
protected
vtkTree::~vtkTree ( )
protected

Member Function Documentation

static vtkTree* vtkTree::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDirectedAcyclicGraph.

virtual const char* vtkTree::GetClassName ( )
virtual

Reimplemented from vtkDirectedAcyclicGraph.

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

Return 1 if this class type 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.

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 ( vtkObject o)
static

Reimplemented from vtkDirectedAcyclicGraph.

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

virtual int vtkTree::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDirectedAcyclicGraph.

Definition at line 66 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 75 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 85 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.

Reimplemented from vtkDirectedAcyclicGraph.

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

Retrieve a graph from an information vector.

Reimplemented from vtkDirectedAcyclicGraph.

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.

virtual bool vtkTree::IsStructureValid ( vtkGraph g)
protectedvirtual

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 128 of file vtkTree.h.


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