superclass for composite data iterators
More...
#include <vtkDataObjectTreeIterator.h>
Inherits vtkCompositeDataIterator.
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.
vtkDataObjectTreeIterator::vtkDataObjectTreeIterator |
( |
| ) |
|
|
protected |
virtual vtkDataObjectTreeIterator::~vtkDataObjectTreeIterator |
( |
| ) |
|
|
protectedvirtual |
static int vtkDataObjectTreeIterator::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
virtual int vtkDataObjectTreeIterator::IsA |
( |
const char * |
type | ) |
|
|
virtual |
virtual vtkObjectBase* vtkDataObjectTreeIterator::NewInstanceInternal |
( |
| ) |
const |
|
protectedvirtual |
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 |
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.
friend class vtkDataObjectTree |
|
friend |
friend class vtkMultiDataSetInternal |
|
friend |
friend class vtkInternals |
|
friend |
unsigned int vtkDataObjectTreeIterator::CurrentFlatIndex |
|
protected |
The documentation for this class was generated from the following file: