superclass for composite data iterators More...
#include <vtkCompositeDataIterator.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkCompositeDataIterator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | InitTraversal () |
| Begin iterating over the composite dataset structure. More... | |
| virtual void | InitReverseTraversal () |
| Begin iterating over the composite dataset structure in reverse order. More... | |
| virtual void | GoToFirstItem ()=0 |
| Move the iterator to the beginning of the collection. More... | |
| virtual void | GoToNextItem ()=0 |
| Move the iterator to the next item in the collection. More... | |
| virtual int | IsDoneWithTraversal ()=0 |
| Test whether the iterator is finished with the traversal. More... | |
| virtual vtkDataObject * | GetCurrentDataObject ()=0 |
| Returns the current item. More... | |
| virtual vtkInformation * | GetCurrentMetaData ()=0 |
| Returns the meta-data associated with the current item. More... | |
| virtual int | HasCurrentMetaData ()=0 |
| Returns if the a meta-data information object is present for the current item. More... | |
| virtual unsigned int | GetCurrentFlatIndex ()=0 |
| Flat index is an index to identify the data in a composite data structure. More... | |
| virtual void | SetDataSet (vtkCompositeDataSet *ds) |
| Set the composite dataset this iterator is iterating over. More... | |
| virtual vtkCompositeDataSet * | GetDataSet () |
| Set the composite dataset this iterator is iterating over. More... | |
| virtual void | SetSkipEmptyNodes (vtkTypeBool) |
| If SkipEmptyNodes is true, then nullptr datasets will be skipped. More... | |
| virtual vtkTypeBool | GetSkipEmptyNodes () |
| If SkipEmptyNodes is true, then nullptr datasets will be skipped. More... | |
| virtual void | SkipEmptyNodesOn () |
| If SkipEmptyNodes is true, then nullptr datasets will be skipped. More... | |
| virtual void | SkipEmptyNodesOff () |
| If SkipEmptyNodes is true, then nullptr datasets will be skipped. More... | |
| virtual int | GetReverse () |
| Returns if the iteration is in reverse order. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkCompositeDataIterator * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkCompositeDataIterator () | |
| ~vtkCompositeDataIterator () override | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| vtkTypeBool | SkipEmptyNodes |
| int | Reverse |
| vtkCompositeDataSet * | DataSet |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
superclass for composite data iterators
vtkCompositeDataIterator provides an interface for accessing datasets in a collection (vtkCompositeDataIterator).
Definition at line 38 of file vtkCompositeDataIterator.h.
Member Typedef Documentation
Definition at line 41 of file vtkCompositeDataIterator.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and vtkHierarchicalBoxDataIterator.
|
static |
|
protectedvirtual |
Reimplemented in vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and vtkHierarchicalBoxDataIterator.
| vtkCompositeDataIterator* vtkCompositeDataIterator::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkObject.
Reimplemented in vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and vtkHierarchicalBoxDataIterator.
|
virtual |
Set the composite dataset this iterator is iterating over.
Must be set before traversal begins.
|
virtual |
Set the composite dataset this iterator is iterating over.
Must be set before traversal begins.
|
virtual |
Begin iterating over the composite dataset structure.
|
virtual |
Begin iterating over the composite dataset structure in reverse order.
|
pure virtual |
Move the iterator to the beginning of the collection.
Implemented in vtkUniformGridAMRDataIterator, and vtkDataObjectTreeIterator.
|
pure virtual |
Move the iterator to the next item in the collection.
Implemented in vtkUniformGridAMRDataIterator, and vtkDataObjectTreeIterator.
|
pure 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.
Implemented in vtkUniformGridAMRDataIterator, and vtkDataObjectTreeIterator.
|
pure virtual |
Returns the current item.
Valid only when IsDoneWithTraversal() returns 0.
Implemented in vtkDataObjectTreeIterator, and vtkUniformGridAMRDataIterator.
|
pure virtual |
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.
Implemented in vtkDataObjectTreeIterator, and vtkUniformGridAMRDataIterator.
|
pure virtual |
Returns if the a meta-data information object is present for the current item.
Return 1 on success, 0 otherwise.
Implemented in vtkDataObjectTreeIterator, and vtkUniformGridAMRDataIterator.
|
virtual |
If SkipEmptyNodes is true, then nullptr datasets will be skipped.
Default is true.
|
virtual |
If SkipEmptyNodes is true, then nullptr datasets will be skipped.
Default is true.
|
virtual |
If SkipEmptyNodes is true, then nullptr datasets will be skipped.
Default is true.
|
virtual |
If SkipEmptyNodes is true, then nullptr datasets will be skipped.
Default is true.
|
pure virtual |
Flat index is an index to identify the data in a composite data structure.
Implemented in vtkDataObjectTreeIterator, and vtkUniformGridAMRDataIterator.
|
virtual |
Returns if the iteration is in reverse order.
Member Data Documentation
|
protected |
Definition at line 124 of file vtkCompositeDataIterator.h.
|
protected |
Definition at line 125 of file vtkCompositeDataIterator.h.
|
protected |
Definition at line 126 of file vtkCompositeDataIterator.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkCompositeDataIterator.h
