implement a specific vtkPointSet::FindCell() strategy based on closest point More...

#include <vtkClosestPointStrategy.h>

Inheritance diagram for vtkClosestPointStrategy:

Collaboration diagram for vtkClosestPointStrategy:

Public Member Functions
int	Initialize (vtkPointSet *ps) override
	Provide the necessary initialization method (see superclass for more information).

vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
	Implement the specific strategy.

vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside) override
	Implement the specific strategy.

bool	InsideCellBounds (double x[3], vtkIdType cellId) override
	Implement the specific strategy.

vtkCell *	SelectCell (vtkPointSet self, vtkIdType cellId, vtkCell cell, vtkGenericCell *gencell)
	Subclasses use this method to select the current cell.

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


virtual void	SetPointLocator (vtkAbstractPointLocator *)
	Set / get an instance of vtkAbstractPointLocator which is used to implement the strategy for FindCell().

virtual vtkAbstractPointLocator *	GetPointLocator ()
	Set / get an instance of vtkAbstractPointLocator which is used to implement the strategy for FindCell().

Public Member Functions inherited from vtkFindCellStrategy
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.

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

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

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.

Static Public Member Functions
static vtkClosestPointStrategy *	New ()
	Construct a vtkFindCellStrategy subclass.

Static Public Member Functions inherited from vtkFindCellStrategy
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.

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.

Protected Member Functions
	vtkClosestPointStrategy ()

	~vtkClosestPointStrategy () override

Protected Member Functions inherited from vtkFindCellStrategy
	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
std::vector< unsigned char >	VisitedCells

vtkNew< vtkIdList >	VisitedCellIds

vtkNew< vtkIdList >	PointIds

vtkNew< vtkIdList >	Neighbors

vtkNew< vtkIdList >	CellIds

vtkNew< vtkIdList >	NearPointIds

std::vector< double >	Weights

vtkAbstractPointLocator *	PointLocator

Protected Attributes inherited from vtkFindCellStrategy
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 vtkFindCellStrategy	Superclass
	Standard methods for type information and printing.

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

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

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

vtkClosestPointStrategy *	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
Public Types inherited from vtkFindCellStrategy
typedef vtkObject	Superclass
	Standard methods for type information and printing.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

implement a specific vtkPointSet::FindCell() strategy based on closest point

vtkClosestPointStrategy is implements a FindCell() strategy based on locating the closest point in a dataset, and then searching the attached cells. While relatively fast, it does not always return the correct result (it may not find a cell, since the closest cell may not be connected to the closest point). vtkCellLocatorStrategy or vtkClosestNPointsStrategy will produce better results at the cost of speed.

See also: vtkFindCellStrategy vtkPointSet vtkCellLocatorStrategy vtkClosestNPointsStrategy

Definition at line 35 of file vtkClosestPointStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkFindCellStrategy vtkClosestPointStrategy::Superclass

Standard methods for type information and printing.

Definition at line 47 of file vtkClosestPointStrategy.h.

Constructor & Destructor Documentation

◆ vtkClosestPointStrategy()

vtkClosestPointStrategy::vtkClosestPointStrategy ( )

protected

◆ ~vtkClosestPointStrategy()

vtkClosestPointStrategy::~vtkClosestPointStrategy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkClosestPointStrategy * vtkClosestPointStrategy::New ( )

static

Construct a vtkFindCellStrategy subclass.

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

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

virtual

Standard methods for type information and printing.

Reimplemented from vtkFindCellStrategy.

Reimplemented in vtkClosestNPointsStrategy.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkClosestPointStrategy::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkFindCellStrategy.

Reimplemented in vtkClosestNPointsStrategy.

◆ NewInstance()

vtkClosestPointStrategy * vtkClosestPointStrategy::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkObjectBase.

◆ Initialize()

int vtkClosestPointStrategy::Initialize ( vtkPointSet * ps )

overridevirtual

Provide the necessary initialization method (see superclass for more information).

This method sets up the point locator, vtkPointSet relationship. It will use the vtkPointSet's default locator if not defined by SetPointLocator() below.

Reimplemented from vtkFindCellStrategy.

◆ FindCell()

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

overridevirtual

Implement the specific strategy.

This method should only be called after the Initialize() method has been invoked.

Implements vtkFindCellStrategy.

◆ FindClosestPointWithinRadius()

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

overridevirtual

Implement the specific strategy.

This method should only be called after the Initialize() method has been invoked.

Implements vtkFindCellStrategy.

◆ InsideCellBounds()

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

overridevirtual

Implement the specific strategy.

Implements vtkFindCellStrategy.

◆ SetPointLocator()

virtual void vtkClosestPointStrategy::SetPointLocator ( vtkAbstractPointLocator * )

virtual

Set / get an instance of vtkAbstractPointLocator which is used to implement the strategy for FindCell().

Note if a locator is not specified, then the default locator instantiated by the vtkPointSet provided in the Initialize() method is used.

◆ GetPointLocator()

virtual vtkAbstractPointLocator * vtkClosestPointStrategy::GetPointLocator ( )

virtual

Set / get an instance of vtkAbstractPointLocator which is used to implement the strategy for FindCell().

Note if a locator is not specified, then the default locator instantiated by the vtkPointSet provided in the Initialize() method is used.

◆ SelectCell()

vtkCell * vtkClosestPointStrategy::SelectCell	(	vtkPointSet *	self,
		vtkIdType	cellId,
		vtkCell *	cell,
		vtkGenericCell *	gencell
	)

inline

Subclasses use this method to select the current cell.

Definition at line 122 of file vtkClosestPointStrategy.h.

◆ CopyParameters()

void vtkClosestPointStrategy::CopyParameters ( vtkFindCellStrategy * from )

overridevirtual

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.

Reimplemented from vtkFindCellStrategy.

Member Data Documentation

◆ VisitedCells

std::vector<unsigned char> vtkClosestPointStrategy::VisitedCells

protected

Definition at line 106 of file vtkClosestPointStrategy.h.

◆ VisitedCellIds

vtkNew<vtkIdList> vtkClosestPointStrategy::VisitedCellIds

protected

Definition at line 107 of file vtkClosestPointStrategy.h.

◆ PointIds

vtkNew<vtkIdList> vtkClosestPointStrategy::PointIds

protected

Definition at line 108 of file vtkClosestPointStrategy.h.

◆ Neighbors

vtkNew<vtkIdList> vtkClosestPointStrategy::Neighbors

protected

Definition at line 109 of file vtkClosestPointStrategy.h.

◆ CellIds

vtkNew<vtkIdList> vtkClosestPointStrategy::CellIds

protected

Definition at line 110 of file vtkClosestPointStrategy.h.

◆ NearPointIds

vtkNew<vtkIdList> vtkClosestPointStrategy::NearPointIds

protected

Definition at line 111 of file vtkClosestPointStrategy.h.

◆ Weights

std::vector<double> vtkClosestPointStrategy::Weights

protected

Definition at line 112 of file vtkClosestPointStrategy.h.

◆ PointLocator

vtkAbstractPointLocator* vtkClosestPointStrategy::PointLocator

protected

Definition at line 114 of file vtkClosestPointStrategy.h.

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

Common/DataModel/vtkClosestPointStrategy.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkClosestPointStrategy()

◆ ~vtkClosestPointStrategy()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ FindCell()

◆ FindClosestPointWithinRadius()

◆ InsideCellBounds()

◆ SetPointLocator()

◆ GetPointLocator()

◆ SelectCell()

◆ CopyParameters()

Member Data Documentation

◆ VisitedCells

◆ VisitedCellIds

◆ PointIds

◆ Neighbors

◆ CellIds

◆ NearPointIds

◆ Weights

◆ PointLocator