helper class to manage the vtkPointSet::FindCell() method More...

#include <vtkFindCellStrategy.h>

Inheritance diagram for vtkFindCellStrategy:

Collaboration diagram for vtkFindCellStrategy:

Public Member Functions
virtual int	Initialize (vtkPointSet *ps)
	All subclasses of this class must provide an initialize method.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
	Virtual method for finding a cell.

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside)=0
	Return the closest point within a specified radius and the cell which is closest to the point x.

virtual bool	InsideCellBounds (double x[3], vtkIdType cellId)=0
	Quickly test if a point is inside the bounds of a particular cell.

virtual void	CopyParameters (vtkFindCellStrategy *from)
	Copy essential parameters between instances of this class.

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
	vtkFindCellStrategy ()

	~vtkFindCellStrategy () 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.

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 &)

Protected Attributes
bool	OwnsLocator

bool	IsACopy

vtkPointSet *	PointSet

double	Bounds [6]

vtkTimeStamp	InitializeTime

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

typedef vtkObject	Superclass
	Standard methods for type information and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.

static vtkFindCellStrategy *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.

vtkFindCellStrategy *	NewInstance () const
	Standard methods for type information and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing.

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 ()

Detailed Description

helper class to manage the vtkPointSet::FindCell() method

vtkFindCellStrategy is a helper class to manage the use of locators for locating cells containing a query point x[3], the so-called FindCell() method. The use of vtkDataSet::FindCell() is a common operation in applications such as streamline generation and probing. However, in some dataset types FindCell() can be implemented very simply (e.g., vtkImageData) while in other datasets it is a complex operation requiring supplemental objects like locators to perform efficiently. In particular, vtkPointSet and its subclasses (like vtkUnstructuredGrid) require complex strategies to efficiently implement the FindCell() operation. Subclasses of the abstract vtkFindCellStrategy implement several of these strategies.

The are two key methods to this class and subclasses. The Initialize() method negotiates with an input dataset to define the locator to use: either a locator associated with the input dataset, or possibly an alternative locator defined by the strategy (subclasses of vtkFindCellStrategy do this). The second important method, FindCell() mimics vtkDataSet::FindCell() and can be used in place of it.

Note that vtkFindCellStrategy is in general not thread-safe as the strategies contain state used to accelerate the search process. Hence if multiple threads are attempting to invoke FindCell(), each thread needs to have its own instance of the vtkFindCellStrategy.

See also: vtkPointSet vtkPolyData vtkStructuredGrid vtkUnstructuredGrid vtkAbstractInterpolatedVelocityField vtkClosetPointStrategy vtkCellLocatorStrategy vtkClosestNPointsStrategy

Definition at line 47 of file vtkFindCellStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkFindCellStrategy::Superclass

Standard methods for type information and printing.

Definition at line 54 of file vtkFindCellStrategy.h.

Constructor & Destructor Documentation

◆ vtkFindCellStrategy()

vtkFindCellStrategy::vtkFindCellStrategy ( )

protected

◆ ~vtkFindCellStrategy()

vtkFindCellStrategy::~vtkFindCellStrategy ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

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

virtual

Standard methods for type information and printing.

Reimplemented from vtkObjectBase.

Reimplemented in vtkCellLocatorStrategy, vtkClosestNPointsStrategy, and vtkClosestPointStrategy.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkFindCellStrategy::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented in vtkCellLocatorStrategy, vtkClosestNPointsStrategy, and vtkClosestPointStrategy.

◆ NewInstance()

vtkFindCellStrategy * vtkFindCellStrategy::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkObjectBase.

◆ Initialize()

virtual int vtkFindCellStrategy::Initialize ( vtkPointSet * ps )

virtual

All subclasses of this class must provide an initialize method.

This method performs handshaking and setup between the vtkPointSet dataset and associated locator(s). A return value==0 means the initialization process failed. The initialization is set up in such a way as to prevent multiple locators from being built.

Reimplemented in vtkCellLocatorStrategy, vtkClosestNPointsStrategy, and vtkClosestPointStrategy.

◆ FindCell()

virtual vtkIdType vtkFindCellStrategy::FindCell	(	double	x[3],
		vtkCell *	cell,
		vtkGenericCell *	gencell,
		vtkIdType	cellId,
		double	tol2,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

pure virtual

Virtual method for finding a cell.

Subclasses must satisfy this API. This method is of the same signature as vtkDataSet::FindCell(). This method is not thread safe: separate instances of vtkFindCellStrategy should be created for each thread invoking FindCell(). This is done for performance reasons to reduce the number of objects created/destroyed on each FindCell() invocation.

Implemented in vtkCellLocatorStrategy, vtkClosestNPointsStrategy, and vtkClosestPointStrategy.

◆ FindClosestPointWithinRadius()

virtual vtkIdType vtkFindCellStrategy::FindClosestPointWithinRadius	(	double	x[3],
		double	radius,
		double	closestPoint[3],
		vtkGenericCell *	cell,
		vtkIdType &	cellId,
		int &	subId,
		double &	dist2,
		int &	inside
	)

pure virtual

Return the closest point within a specified radius and the cell which is closest to the point x.

The closest point is somewhere on a cell, it need not be one of the vertices of the cell. This method returns 1 if a point is found within the specified radius. If there are no cells within the specified radius, the method returns 0 and the values of closestPoint, cellId, subId, and dist2 are undefined. This version takes in a vtkGenericCell to avoid allocating and deallocating the cell. This is much faster than the version which does not take a *cell, especially when this function is called many times in a row such as by a for loop, where the allocation and dealloction can be done only once outside the for loop. If a closest point is found, "cell" contains the points and ptIds for the cell "cellId" upon exit. If a closest point is found, inside returns the return value of the EvaluatePosition call to the closest cell; inside(=1) or outside(=0).

Implemented in vtkCellLocatorStrategy, and vtkClosestPointStrategy.

◆ InsideCellBounds()

virtual bool vtkFindCellStrategy::InsideCellBounds	(	double	x[3],
		vtkIdType	cellId
	)

pure virtual

Quickly test if a point is inside the bounds of a particular cell.

Implemented in vtkCellLocatorStrategy, and vtkClosestPointStrategy.

◆ CopyParameters()

virtual void vtkFindCellStrategy::CopyParameters ( vtkFindCellStrategy * from )

virtual

Copy essential parameters between instances of this class.

This generally is used to copy from instance prototype to another, or to copy strategies between thread instances. Sub-classes can contribute to the parameter copying process via chaining.

Note: CopyParameters should ALWAYS be called BEFORE Initialize.

Reimplemented in vtkCellLocatorStrategy, vtkClosestNPointsStrategy, and vtkClosestPointStrategy.

Member Data Documentation

◆ OwnsLocator

bool vtkFindCellStrategy::OwnsLocator

protected

Definition at line 120 of file vtkFindCellStrategy.h.

◆ IsACopy

bool vtkFindCellStrategy::IsACopy

protected

Definition at line 123 of file vtkFindCellStrategy.h.

◆ PointSet

vtkPointSet* vtkFindCellStrategy::PointSet

protected

Definition at line 124 of file vtkFindCellStrategy.h.

◆ Bounds

double vtkFindCellStrategy::Bounds[6]

protected

Definition at line 125 of file vtkFindCellStrategy.h.

◆ InitializeTime

vtkTimeStamp vtkFindCellStrategy::InitializeTime

protected

Definition at line 127 of file vtkFindCellStrategy.h.

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

Common/DataModel/vtkFindCellStrategy.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkFindCellStrategy()

◆ ~vtkFindCellStrategy()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ FindCell()

◆ FindClosestPointWithinRadius()

◆ InsideCellBounds()

◆ CopyParameters()

Member Data Documentation

◆ OwnsLocator

◆ IsACopy

◆ PointSet

◆ Bounds

◆ InitializeTime