ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkCompositeDataIterator Class Reference

vtkCompositeDataIterator - superclass for composite data iterators More...

Inheritance diagram for Kitware.VTK.vtkCompositeDataIterator:
[legend]
Collaboration diagram for Kitware.VTK.vtkCompositeDataIterator:
[legend]

List of all members.

Public Member Functions

 vtkCompositeDataIterator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCompositeDataIterator ()
 Undocumented Block.
virtual vtkDataObject GetCurrentDataObject ()
 Returns the current item. Valid only when IsDoneWithTraversal() returns 0.
uint GetCurrentFlatIndex ()
 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 vtkInformation GetCurrentMetaData ()
 Returns the meta-data associated with the current item. This will allocate a new vtkInformation object is none is already present. Use HasCurrentMetaData to avoid unnecessary creation of vtkInformation objects.
virtual vtkCompositeDataSet GetDataSet ()
 Set the composite dataset this iterator is iterating over. Must be set before traversal begins.
virtual int GetReverse ()
 Returns if the iteration is in reverse order.
virtual int GetSkipEmptyNodes ()
 If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.
virtual int GetTraverseSubTree ()
 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 GetVisitOnlyLeaves ()
 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 GoToFirstItem ()
 Move the iterator to the beginning of the collection.
virtual void GoToNextItem ()
 Move the iterator to the next item in the collection.
virtual int HasCurrentMetaData ()
 Returns if the a meta-data information object is present for the current item. Return 1 on success, 0 otherwise.
virtual void InitReverseTraversal ()
 Begin iterating over the composite dataset structure in reverse order.
virtual void InitTraversal ()
 Begin iterating over the composite dataset structure.
override int IsA (string type)
 Undocumented Block.
virtual int IsDoneWithTraversal ()
 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.
new vtkCompositeDataIterator NewInstance ()
 Undocumented Block.
virtual void SetDataSet (vtkCompositeDataSet ds)
 Set the composite dataset this iterator is iterating over. Must be set before traversal begins.
virtual void SetSkipEmptyNodes (int _arg)
 If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.
virtual void SetTraverseSubTree (int _arg)
 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 SetVisitOnlyLeaves (int _arg)
 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 SkipEmptyNodesOff ()
 If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.
virtual void SkipEmptyNodesOn ()
 If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.
virtual void TraverseSubTreeOff ()
 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 TraverseSubTreeOn ()
 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 VisitOnlyLeavesOff ()
 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 VisitOnlyLeavesOn ()
 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.

Static Public Member Functions

static new vtkCompositeDataIterator New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkCompositeDataIterator SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCompositeDataIterator"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkCompositeDataIterator"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkCompositeDataIterator_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCompositeDataIterator_GetCurrentDataObject_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkCompositeDataIterator_GetCurrentFlatIndex_02 (HandleRef pThis)
static internal IntPtr vtkCompositeDataIterator_GetCurrentMetaData_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCompositeDataIterator_GetDataSet_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCompositeDataIterator_GetReverse_05 (HandleRef pThis)
static internal int vtkCompositeDataIterator_GetSkipEmptyNodes_06 (HandleRef pThis)
static internal int vtkCompositeDataIterator_GetTraverseSubTree_07 (HandleRef pThis)
static internal int vtkCompositeDataIterator_GetVisitOnlyLeaves_08 (HandleRef pThis)
static internal void vtkCompositeDataIterator_GoToFirstItem_09 (HandleRef pThis)
static internal void vtkCompositeDataIterator_GoToNextItem_10 (HandleRef pThis)
static internal int vtkCompositeDataIterator_HasCurrentMetaData_11 (HandleRef pThis)
static internal void vtkCompositeDataIterator_InitReverseTraversal_12 (HandleRef pThis)
static internal void vtkCompositeDataIterator_InitTraversal_13 (HandleRef pThis)
static internal int vtkCompositeDataIterator_IsA_14 (HandleRef pThis, string type)
static internal int vtkCompositeDataIterator_IsDoneWithTraversal_15 (HandleRef pThis)
static internal int vtkCompositeDataIterator_IsTypeOf_16 (string type)
static internal IntPtr vtkCompositeDataIterator_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCompositeDataIterator_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCompositeDataIterator_SetDataSet_20 (HandleRef pThis, HandleRef ds)
static internal void vtkCompositeDataIterator_SetSkipEmptyNodes_21 (HandleRef pThis, int _arg)
static internal void vtkCompositeDataIterator_SetTraverseSubTree_22 (HandleRef pThis, int _arg)
static internal void vtkCompositeDataIterator_SetVisitOnlyLeaves_23 (HandleRef pThis, int _arg)
static internal void vtkCompositeDataIterator_SkipEmptyNodesOff_24 (HandleRef pThis)
static internal void vtkCompositeDataIterator_SkipEmptyNodesOn_25 (HandleRef pThis)
static internal void vtkCompositeDataIterator_TraverseSubTreeOff_26 (HandleRef pThis)
static internal void vtkCompositeDataIterator_TraverseSubTreeOn_27 (HandleRef pThis)
static internal void vtkCompositeDataIterator_VisitOnlyLeavesOff_28 (HandleRef pThis)
static internal void vtkCompositeDataIterator_VisitOnlyLeavesOn_29 (HandleRef pThis)

Static Private Member Functions

static vtkCompositeDataIterator ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCompositeDataIterator - superclass for composite data iterators

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


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkCompositeDataIterator.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

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

Here is the call graph for this function:

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.

Returns the meta-data associated with the current item. This will allocate a new vtkInformation object is none is already present. Use HasCurrentMetaData to avoid unnecessary creation of vtkInformation objects.

Here is the call graph for this function:

Set the composite dataset this iterator is iterating over. Must be set before traversal begins.

Here is the call graph for this function:

Returns if the iteration is in reverse order.

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

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.

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.

Move the iterator to the beginning of the collection.

Move the iterator to the next item in the collection.

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

Begin iterating over the composite dataset structure in reverse order.

Begin iterating over the composite dataset structure.

override int Kitware.VTK.vtkCompositeDataIterator.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

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.

static new int Kitware.VTK.vtkCompositeDataIterator.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

Here is the call graph for this function:

Set the composite dataset this iterator is iterating over. Must be set before traversal begins.

virtual void Kitware.VTK.vtkCompositeDataIterator.SetSkipEmptyNodes ( int  _arg) [virtual]

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

virtual void Kitware.VTK.vtkCompositeDataIterator.SetTraverseSubTree ( int  _arg) [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 Kitware.VTK.vtkCompositeDataIterator.SetVisitOnlyLeaves ( int  _arg) [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.

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

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.

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.

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.

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.

static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GetCurrentDataObject_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GetCurrentMetaData_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GetDataSet_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GetReverse_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GoToFirstItem_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_GoToNextItem_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_InitTraversal_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SetDataSet_20 ( HandleRef  pThis,
HandleRef  ds 
) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SetSkipEmptyNodes_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SetTraverseSubTree_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SetVisitOnlyLeaves_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCompositeDataIterator.vtkCompositeDataIterator_SkipEmptyNodesOn_25 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCompositeDataIterator.MRClassNameKey = "24vtkCompositeDataIterator" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.

new const string Kitware.VTK.vtkCompositeDataIterator.MRFullTypeName = "Kitware.VTK.vtkCompositeDataIterator"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkHierarchicalBoxDataIterator.


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