VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkDataObjectTreeIterator Class Reference

superclass for composite data iterators More...

#include <vtkDataObjectTreeIterator.h>

Inherits vtkCompositeDataIterator.

Public Types

typedef vtkCompositeDataIterator Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataObjectTreeIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GoToFirstItem ()
 
virtual void GoToNextItem ()
 
virtual int IsDoneWithTraversal ()
 
virtual vtkDataObjectGetCurrentDataObject ()
 
virtual vtkInformationGetCurrentMetaData ()
 
virtual int HasCurrentMetaData ()
 
virtual unsigned int GetCurrentFlatIndex ()
 
virtual void SetVisitOnlyLeaves (int)
 
virtual int GetVisitOnlyLeaves ()
 
virtual void VisitOnlyLeavesOn ()
 
virtual void VisitOnlyLeavesOff ()
 
virtual void SetTraverseSubTree (int)
 
virtual int GetTraverseSubTree ()
 
virtual void TraverseSubTreeOn ()
 
virtual void TraverseSubTreeOff ()
 

Static Public Member Functions

static vtkDataObjectTreeIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectTreeIteratorSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObjectTreeIterator ()
 
virtual ~vtkDataObjectTreeIterator ()
 
void NextInternal ()
 
vtkDataObjectTreeIndex GetCurrentIndex ()
 

Protected Attributes

unsigned int CurrentFlatIndex
 

Friends

class vtkDataObjectTree
 
class vtkMultiDataSetInternal
 
class vtkInternals
 

Detailed Description

superclass for composite data iterators

vtkDataObjectTreeIterator provides an interface for accessing datasets in a collection (vtkDataObjectTreeIterator).

Tests:
vtkDataObjectTreeIterator (Tests)

Definition at line 38 of file vtkDataObjectTreeIterator.h.

Member Typedef Documentation

typedef vtkCompositeDataIterator vtkDataObjectTreeIterator::Superclass

Definition at line 42 of file vtkDataObjectTreeIterator.h.

Constructor & Destructor Documentation

vtkDataObjectTreeIterator::vtkDataObjectTreeIterator ( )
protected
virtual vtkDataObjectTreeIterator::~vtkDataObjectTreeIterator ( )
protectedvirtual

Member Function Documentation

static vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::New ( )
static
static int vtkDataObjectTreeIterator::IsTypeOf ( const char *  type)
static
virtual int vtkDataObjectTreeIterator::IsA ( const char *  type)
virtual
static vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataObjectTreeIterator::NewInstanceInternal ( ) const
protectedvirtual
vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::NewInstance ( ) const
void vtkDataObjectTreeIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkDataObjectTreeIterator::GoToFirstItem ( )
virtual

Move the iterator to the beginning of the collection.

virtual void vtkDataObjectTreeIterator::GoToNextItem ( )
virtual

Move the iterator to the next item in the collection.

virtual int vtkDataObjectTreeIterator::IsDoneWithTraversal ( )
virtual

Test whether the iterator is finished with the traversal. Returns 1 for yes, and 0 for no. It is safe to call any of the GetCurrent...() methods only when IsDoneWithTraversal() returns 0.

virtual vtkDataObject* vtkDataObjectTreeIterator::GetCurrentDataObject ( )
virtual

Returns the current item. Valid only when IsDoneWithTraversal() returns 0.

virtual vtkInformation* vtkDataObjectTreeIterator::GetCurrentMetaData ( )
virtual

Returns the meta-data associated with the current item. Note that, depending on iterator implementation, the returned information is not necessarily stored on the current object. So modifying the information is forbidden.

virtual int vtkDataObjectTreeIterator::HasCurrentMetaData ( )
virtual

Returns if the a meta-data information object is present for the current item. Return 1 on success, 0 otherwise.

virtual unsigned int vtkDataObjectTreeIterator::GetCurrentFlatIndex ( )
virtual

Flat index is an index obtained by traversing the tree in preorder. This can be used to uniquely identify nodes in the tree. Not valid if IsDoneWithTraversal() returns true.

virtual void vtkDataObjectTreeIterator::SetVisitOnlyLeaves ( int  )
virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual int vtkDataObjectTreeIterator::GetVisitOnlyLeaves ( )
virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::VisitOnlyLeavesOn ( )
virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::VisitOnlyLeavesOff ( )
virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::SetTraverseSubTree ( int  )
virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual int vtkDataObjectTreeIterator::GetTraverseSubTree ( )
virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkDataObjectTreeIterator::TraverseSubTreeOn ( )
virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkDataObjectTreeIterator::TraverseSubTreeOff ( )
virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

void vtkDataObjectTreeIterator::NextInternal ( )
protected
vtkDataObjectTreeIndex vtkDataObjectTreeIterator::GetCurrentIndex ( )
protected

Returns the index for the current data object.

Friends And Related Function Documentation

friend class vtkDataObjectTree
friend

Definition at line 115 of file vtkDataObjectTreeIterator.h.

friend class vtkMultiDataSetInternal
friend

Definition at line 116 of file vtkDataObjectTreeIterator.h.

friend class vtkInternals
friend

Definition at line 126 of file vtkDataObjectTreeIterator.h.

Member Data Documentation

unsigned int vtkDataObjectTreeIterator::CurrentFlatIndex
protected

Definition at line 118 of file vtkDataObjectTreeIterator.h.


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