VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericPointIterator Class Referenceabstract

iterator used to traverse points More...

#include <vtkGenericPointIterator.h>

Inheritance diagram for vtkGenericPointIterator:
[legend]
Collaboration diagram for vtkGenericPointIterator:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGenericPointIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Begin ()=0
 
virtual int IsAtEnd ()=0
 
virtual void Next ()=0
 
virtual doubleGetPosition ()=0
 
virtual void GetPosition (double x[3])=0
 
virtual vtkIdType GetId ()=0
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkGenericPointIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGenericPointIterator ()
 
virtual ~vtkGenericPointIterator ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

iterator used to traverse points

This class (and subclasses) are used to iterate over points. Use it only in conjunction with vtkGenericDataSet (i.e., the adaptor framework).

Typical use is:

vtkGenericDataSet *dataset;
vtkGenericPointIterator *it = dataset->NewPointIterator();
for (it->Begin(); !it->IsAtEnd(); it->Next());
  {
  x=it->GetPosition();
  }
Tests:
vtkGenericPointIterator (Tests)

Definition at line 41 of file vtkGenericPointIterator.h.

Member Typedef Documentation

◆ Superclass

Standard VTK construction and type macros.

Definition at line 46 of file vtkGenericPointIterator.h.

Constructor & Destructor Documentation

◆ vtkGenericPointIterator()

vtkGenericPointIterator::vtkGenericPointIterator ( )
protected

Destructor.

◆ ~vtkGenericPointIterator()

virtual vtkGenericPointIterator::~vtkGenericPointIterator ( )
protectedvirtual

Member Function Documentation

◆ IsTypeOf()

static int vtkGenericPointIterator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkGenericPointIterator::IsA ( const char *  name)
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 vtkObject.

Reimplemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ SafeDownCast()

static vtkGenericPointIterator* vtkGenericPointIterator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericPointIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGenericPointIterator* vtkGenericPointIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericPointIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ Begin()

virtual void vtkGenericPointIterator::Begin ( )
pure virtual

Move iterator to first position if any (loop initialization).

Implemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ IsAtEnd()

virtual int vtkGenericPointIterator::IsAtEnd ( )
pure virtual

◆ Next()

virtual void vtkGenericPointIterator::Next ( )
pure virtual

Move the iterator to the next position in the list.

Precondition
not_off: !IsAtEnd()

Implemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ GetPosition() [1/2]

virtual double* vtkGenericPointIterator::GetPosition ( )
pure virtual

Get the coordinates of the point at the current iterator position.

Precondition
not_off: !IsAtEnd()
Postcondition
result_exists: result!=0

Implemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ GetPosition() [2/2]

virtual void vtkGenericPointIterator::GetPosition ( double  x[3])
pure virtual

Get the coordinates of the point at the current iterator position.

Precondition
not_off: !IsAtEnd()
x_exists: x!=0

Implemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.

◆ GetId()

virtual vtkIdType vtkGenericPointIterator::GetId ( )
pure virtual

Return the unique identifier for the point, could be non-contiguous.

Precondition
not_off: !IsAtEnd()

Implemented in vtkBridgePointIteratorOne, vtkBridgePointIteratorOnDataSet, vtkBridgePointIteratorOnCell, and vtkBridgePointIterator.


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