iterator used to traverse points More...

#include <vtkGenericPointIterator.h>

Inheritance diagram for vtkGenericPointIterator:

Collaboration diagram for vtkGenericPointIterator:

Public Member Functions
virtual void	Begin ()=0
	Move iterator to first position if any (loop initialization).

virtual vtkTypeBool	IsAtEnd ()=0
	Is the iterator at the end of traversal?

virtual void	Next ()=0
	Move the iterator to the next position in the list.

virtual double *	GetPosition ()=0
	Get the coordinates of the point at the current iterator position.

virtual void	GetPosition (double x[3])=0
	Get the coordinates of the point at the current iterator position.

virtual vtkIdType	GetId ()=0
	Return the unique identifier for the point, could be non-contiguous.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

typedef vtkObject	Superclass
	Standard VTK construction and type macros.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard VTK construction and type macros.

static vtkGenericPointIterator *	SafeDownCast (vtkObjectBase *o)
	Standard VTK construction and type macros.

virtual vtkTypeBool	IsA (const char *type)
	Standard VTK construction and type macros.

vtkGenericPointIterator *	NewInstance () const
	Standard VTK construction and type macros.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard VTK construction and type macros.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK construction and type macros.

Additional Inherited Members
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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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 31 of file vtkGenericPointIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGenericPointIterator::Superclass

Standard VTK construction and type macros.

Definition at line 38 of file vtkGenericPointIterator.h.

Constructor & Destructor Documentation

◆ vtkGenericPointIterator()

vtkGenericPointIterator::vtkGenericPointIterator ( )

protected

Destructor.

◆ ~vtkGenericPointIterator()

vtkGenericPointIterator::~vtkGenericPointIterator ( )

overrideprotected

Destructor.

Member Function Documentation

◆ IsTypeOf()

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

static

Standard VTK construction and type macros.

◆ IsA()

virtual vtkTypeBool vtkGenericPointIterator::IsA ( const char * type )

virtual

Standard VTK construction and type macros.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

Standard VTK construction and type macros.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGenericPointIterator::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK construction and type macros.

◆ NewInstance()

vtkGenericPointIterator * vtkGenericPointIterator::NewInstance ( ) const

Standard VTK construction and type macros.

◆ PrintSelf()

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

overridevirtual

Standard VTK construction and type macros.

Reimplemented from vtkObjectBase.

◆ Begin()

virtual void vtkGenericPointIterator::Begin ( )

pure virtual

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

◆ IsAtEnd()

virtual vtkTypeBool vtkGenericPointIterator::IsAtEnd ( )

pure virtual

Is the iterator at the end of traversal?

◆ Next()

virtual void vtkGenericPointIterator::Next ( )

pure virtual

Move the iterator to the next position in the list.

Precondition: not_off: !IsAtEnd()

◆ 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

◆ 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

◆ GetId()

virtual vtkIdType vtkGenericPointIterator::GetId ( )

pure virtual

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

Precondition: not_off: !IsAtEnd()

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

Common/DataModel/vtkGenericPointIterator.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGenericPointIterator()

◆ ~vtkGenericPointIterator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Begin()

◆ IsAtEnd()

◆ Next()

◆ GetPosition() [1/2]

◆ GetPosition() [2/2]

◆ GetId()