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

vtkHierarchicalBoxDataIterator - subclass of vtkCompositeDataIterator with API to get current level and dataset index. More...

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

List of all members.

Public Member Functions

 vtkHierarchicalBoxDataIterator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHierarchicalBoxDataIterator ()
 *Undocumented Block
uint GetCurrentIndex ()
 Returns the dataset index for the current data object. Valid only if the current data is a leaf node i.e. no a composite dataset.
uint GetCurrentLevel ()
 Returns the level for the current dataset.
override int IsA (string type)
 *Undocumented Block
new vtkHierarchicalBoxDataIterator NewInstance ()
 *Undocumented Block
- Public Member Functions inherited from Kitware.VTK.vtkCompositeDataIterator
 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.
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.
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.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new
vtkHierarchicalBoxDataIterator 
New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new
vtkHierarchicalBoxDataIterator 
SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkHierarchicalBoxDataIterator"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkCompositeDataIterator
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "30vtkHierarchicalBoxDataIterator"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkCompositeDataIterator
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkHierarchicalBoxDataIterator ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHierarchicalBoxDataIterator - subclass of vtkCompositeDataIterator with API to get current level and dataset index.

Description


Constructor & Destructor Documentation

static Kitware.VTK.vtkHierarchicalBoxDataIterator.vtkHierarchicalBoxDataIterator ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkHierarchicalBoxDataIterator.vtkHierarchicalBoxDataIterator ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkHierarchicalBoxDataIterator.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.vtkCompositeDataIterator.

uint Kitware.VTK.vtkHierarchicalBoxDataIterator.GetCurrentIndex ( )

Returns the dataset index for the current data object. Valid only if the current data is a leaf node i.e. no a composite dataset.

uint Kitware.VTK.vtkHierarchicalBoxDataIterator.GetCurrentLevel ( )

Returns the level for the current dataset.

override int Kitware.VTK.vtkHierarchicalBoxDataIterator.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

static new int Kitware.VTK.vtkHierarchicalBoxDataIterator.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

static new vtkHierarchicalBoxDataIterator Kitware.VTK.vtkHierarchicalBoxDataIterator.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

new vtkHierarchicalBoxDataIterator Kitware.VTK.vtkHierarchicalBoxDataIterator.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

static new vtkHierarchicalBoxDataIterator Kitware.VTK.vtkHierarchicalBoxDataIterator.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

Here is the call graph for this function:


Member Data Documentation

new readonly string Kitware.VTK.vtkHierarchicalBoxDataIterator.MRClassNameKey = "30vtkHierarchicalBoxDataIterator"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkCompositeDataIterator.


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