point locator adaptor to perform cell Location using the jump and walk approach More...

#include <vtkJumpAndWalkCellLocator.h>

Inheritance diagram for vtkJumpAndWalkCellLocator:

Collaboration diagram for vtkJumpAndWalkCellLocator:

Public Member Functions
vtkIdType	FindCell (double x[3], double tol2, vtkGenericCell genCell, int &subId, double pcoords[3], double weights) override
	Find the cell containing a given point.

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

void	ShallowCopy (vtkAbstractCellLocator *locator) override
	Shallow copy of a vtkJumpAndWalkCellLocator.

vtkIdType	FindCell (double x[3])
	Returns the Id of the cell containing the point, returns -1 if no cell found.

vtkIdType	FindCell (double x[3], double tol2)
	Returns the Id of the cell containing the point within provided squared tolerance, returns -1 if no cell found.

vtkIdType	FindCell (double x[3], double tol2, vtkGenericCell genCell, double pcoords[3], double weights)
	Find the cell containing a given point.

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell genCell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
	Find the cell containing a given point.

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

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


virtual void	SetPointLocator (vtkAbstractPointLocator *)
	Set/Get the point locator to be used internally.

virtual vtkAbstractPointLocator *	GetPointLocator ()
	Set/Get the point locator to be used internally.


virtual void	SetNumberOfClosestPoints (unsigned int)
	Set/Get the number of closest points to check.

virtual unsigned int	GetNumberOfClosestPoints ()
	Set/Get the number of closest points to check.


void	FreeSearchStructure () override
	Satisfy vtkLocator abstract interface.

void	BuildLocator () override
	Satisfy vtkLocator abstract interface.

void	ForceBuildLocator () override
	Satisfy vtkLocator abstract interface.

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Satisfy vtkLocator abstract interface.

Public Member Functions inherited from vtkAbstractCellLocator
vtkAbstractCellLocator *	NewInstance () const

void	ComputeCellBounds ()
	This function can be used either internally or externally to compute only the cached cell bounds if CacheCellBounds is on.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
	Return intersection point (if any) of finite line with cells contained in cell locator.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId)
	Return intersection point (if any) AND the cell which was intersected by the finite line.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell)
	Return intersection point (if any) AND the cell which was intersected by the finite line.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], vtkPoints points, vtkIdList cellIds)
	Take the passed line segment and intersect it with the data set.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, vtkPoints points, vtkIdList cellIds)
	Take the passed line segment and intersect it with the data set.

virtual int	IntersectWithLine (const double p1[3], const double p2[3], double tol, vtkPoints points, vtkIdList cellIds, vtkGenericCell *cell)
	Take the passed line segment and intersect it with the data set.

virtual void	FindClosestPoint (const double x[3], double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point and the cell which is closest to the point x.

virtual void	FindClosestPoint (const double x[3], double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point and the cell which is closest to the point x.

virtual void	FindCellsWithinBounds (double bbox, vtkIdList cells)
	Return a list of unique cell ids inside of a given bounding box.

void	FindCellsAlongLine (const double p1[3], const double p2[3], double tol, vtkIdList *cells)
	Take the passed line segment and intersect it with the data set.

virtual void	FindCellsAlongPlane (const double o[3], const double n[3], double tol, vtkIdList *cells)
	Given an unbounded plane defined by an origin o[3] and unit normal n[3], return the list of unique cell ids in the buckets containing the plane.

vtkIdType	FindCell (double x[3])
	Returns the Id of the cell containing the point, returns -1 if no cell found.

vtkIdType	FindCell (double x[3], double tol2)
	Returns the Id of the cell containing the point within provided squared tolerance, returns -1 if no cell found.

virtual void	SetNumberOfCellsPerNode (int)
	Specify the preferred/maximum number of cells in each node/bucket.

virtual int	GetNumberOfCellsPerNode ()
	Specify the preferred/maximum number of cells in each node/bucket.

virtual void	SetCacheCellBounds (vtkTypeBool)
	Boolean controls whether the bounds of each cell are computed only once and then saved.

virtual vtkTypeBool	GetCacheCellBounds ()
	Boolean controls whether the bounds of each cell are computed only once and then saved.

virtual void	CacheCellBoundsOn ()
	Boolean controls whether the bounds of each cell are computed only once and then saved.

virtual void	CacheCellBoundsOff ()
	Boolean controls whether the bounds of each cell are computed only once and then saved.

virtual void	SetRetainCellLists (vtkTypeBool)
	Boolean controls whether to maintain list of cells in each node.

virtual vtkTypeBool	GetRetainCellLists ()
	Boolean controls whether to maintain list of cells in each node.

virtual void	RetainCellListsOn ()
	Boolean controls whether to maintain list of cells in each node.

virtual void	RetainCellListsOff ()
	Boolean controls whether to maintain list of cells in each node.

vtkIdType	FindCell (double x[3], double tol2, vtkGenericCell genCell, double pcoords[3], double weights)
	Find the cell containing a given point.

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

Public Member Functions inherited from vtkLocator
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed.

virtual void	Initialize ()
	Initialize locator.

virtual void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset.

virtual vtkDataSet *	GetDataSet ()
	Build the locator from the points/cells defining this dataset.

virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree.

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree.

virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true).

virtual void	SetAutomatic (vtkTypeBool)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual vtkTypeBool	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

void	SetTolerance (double tol)
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

double	GetToleranceMinValue () VTK_FUTURE_CONST
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

double	GetToleranceMaxValue () VTK_FUTURE_CONST
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

double	GetToleranceDefaultValue () VTK_FUTURE_CONST
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOn ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOff ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkMTimeType	GetBuildTime ()
	Return the time of the last data structure build.

bool	UsesGarbageCollector () const override
	Handle the PointSet <-> Locator loop.

vtkLocator *	NewInstance () const
	Standard type and print methods.

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

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 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.

Protected Member Functions
	vtkJumpAndWalkCellLocator ()

	~vtkJumpAndWalkCellLocator () override

void	BuildLocatorInternal () override
	This function is not pure virtual to maintain backwards compatibility.

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkAbstractCellLocator
void	UpdateInternalWeights ()
	To be called in `FindCell(double[3])`.

void	GetCellBounds (vtkIdType cellId, double *&cellBoundsPtr)

	vtkAbstractCellLocator ()
	Find the cell containing a given point.

	~vtkAbstractCellLocator () override
	Find the cell containing a given point.

virtual bool	StoreCellBounds ()
	This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array.

virtual void	FreeCellBounds ()
	Find the cell containing a given point.

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

void	ReportReferences (vtkGarbageCollector *) 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 ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

typedef vtkAbstractCellLocator	Superclass
	Standard methods to instantiate, print and obtain type-related information.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods to instantiate, print and obtain type-related information.

static vtkJumpAndWalkCellLocator *	SafeDownCast (vtkObjectBase *o)
	Standard methods to instantiate, print and obtain type-related information.

static vtkJumpAndWalkCellLocator *	New ()
	Standard methods to instantiate, print and obtain type-related information.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods to instantiate, print and obtain type-related information.

vtkJumpAndWalkCellLocator *	NewInstance () const
	Standard methods to instantiate, print and obtain type-related information.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods to instantiate, print and obtain type-related information.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods to instantiate, print and obtain type-related information.

Additional Inherited Members
Public Types inherited from vtkAbstractCellLocator
typedef vtkLocator	Superclass

typedef vtkObject	Superclass
	Standard type and print methods.

Static Public Member Functions inherited from vtkAbstractCellLocator
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractCellLocator *	SafeDownCast (vtkObjectBase *o)

static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

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 vtkAbstractCellLocator
static bool	IsInBounds (const double bounds[6], const double x[3], double tol=0.0)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkAbstractCellLocator
int	NumberOfCellsPerNode

vtkTypeBool	RetainCellLists

vtkTypeBool	CacheCellBounds

vtkNew< vtkGenericCell >	GenericCell

std::shared_ptr< std::vector< double > >	CellBoundsSharedPtr

double *	CellBounds

vtkTimeStamp	WeightsTime
	This time stamp helps us decide if we want to update internal `Weights` array size.

std::vector< double >	Weights
	This array is resized so that it can fit points from the cell hosting the most in the input data set.

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	UseExistingSearchStructure

vtkTypeBool	Automatic

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

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

point locator adaptor to perform cell Location using the jump and walk approach

vtkJumpAndWalkCellLocator is a point locator adaptor that can accept any point locator, e.g. vtkStaticPointLocator, vtkPointLocator, which in order to find a cell, initially it locates the the closest point in a dataset and "jumps" to it, and then searches/walks to cells attached to this point.

By default, it will attempt to jump only the closest point, and if it fails to find a cell, it will stop. If requested, it can find the N closest points that could be used to jump and walk to cells attached to those points.

Using more points will produce less false positives, i.e. the cell was not found. at the cost of speed.

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(s)). vtkCellLocator, vtkStaticCellLocator, or vtkCellTreeLocator will produce better results at the cost of speed.

vtkJumpAndWalkCellLocator utilizes the following parent class parameters:

CacheCellBounds (default true)
UseExistingSearchStructure (default false)

vtkCellTreeLocator does NOT utilize the following parameters:

NumberOfCellsPerNode
Automatic
Level
MaxLevel
RetainCellLists

Warning: If a point locator adaptor is not provided, then a vtkStaticPointLocator is build. Also, if the dataset is a point set and its Cell Links have not been built, FindCell and FindClosestPointWithinRadius are not thread-safe.

See also: vtkAbstractCellLocator vtkCellLocator vtkStaticCellLocator vtkCellTreeLocator

Tests:: vtkJumpAndWalkCellLocator (Tests)

Definition at line 60 of file vtkJumpAndWalkCellLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractCellLocator vtkJumpAndWalkCellLocator::Superclass

Standard methods to instantiate, print and obtain type-related information.

Definition at line 67 of file vtkJumpAndWalkCellLocator.h.

Constructor & Destructor Documentation

◆ vtkJumpAndWalkCellLocator()

vtkJumpAndWalkCellLocator::vtkJumpAndWalkCellLocator ( )

protected

◆ ~vtkJumpAndWalkCellLocator()

vtkJumpAndWalkCellLocator::~vtkJumpAndWalkCellLocator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods to instantiate, print and obtain type-related information.

◆ IsA()

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

virtual

Standard methods to instantiate, print and obtain type-related information.

Reimplemented from vtkAbstractCellLocator.

◆ SafeDownCast()

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

static

Standard methods to instantiate, print and obtain type-related information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkJumpAndWalkCellLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard methods to instantiate, print and obtain type-related information.

Reimplemented from vtkAbstractCellLocator.

◆ NewInstance()

vtkJumpAndWalkCellLocator * vtkJumpAndWalkCellLocator::NewInstance ( ) const

Standard methods to instantiate, print and obtain type-related information.

◆ PrintSelf()

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

overridevirtual

Standard methods to instantiate, print and obtain type-related information.

Reimplemented from vtkAbstractCellLocator.

◆ New()

static vtkJumpAndWalkCellLocator * vtkJumpAndWalkCellLocator::New ( )

static

Standard methods to instantiate, print and obtain type-related information.

◆ SetPointLocator()

virtual void vtkJumpAndWalkCellLocator::SetPointLocator ( vtkAbstractPointLocator * )

virtual

Set/Get the point locator to be used internally.

Default is vtkStaticPointLocator.

◆ GetPointLocator()

virtual vtkAbstractPointLocator * vtkJumpAndWalkCellLocator::GetPointLocator ( )

virtual

Set/Get the point locator to be used internally.

Default is vtkStaticPointLocator.

◆ SetNumberOfClosestPoints()

virtual void vtkJumpAndWalkCellLocator::SetNumberOfClosestPoints ( unsigned int )

virtual

Set/Get the number of closest points to check.

Default is 1, meaning only the closest point will be used to jump and walk to cells attached to it.

◆ GetNumberOfClosestPoints()

virtual unsigned int vtkJumpAndWalkCellLocator::GetNumberOfClosestPoints ( )

virtual

Set/Get the number of closest points to check.

Default is 1, meaning only the closest point will be used to jump and walk to cells attached to it.

◆ FindCell() [1/5]

vtkIdType vtkJumpAndWalkCellLocator::FindCell	(	double	x[3],
		double	tol2,
		vtkGenericCell *	genCell,
		int &	subId,
		double	pcoords[3],
		double *	weights )

overridevirtual

Find the cell containing a given point.

returns -1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store the information.

For other FindCell signatures, see vtkAbstractCellLocator.

Warning: This method is not thread-safe if the dataset is a point set and its Cell Links have not been built.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [1/3]

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

overridevirtual

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

Warning: This method is not thread-safe if the dataset is a point set and its Cell Links have not been built.

For other FindClosestPointWithinRadius signatures, see vtkAbstractCellLocator.

Reimplemented from vtkAbstractCellLocator.

◆ FreeSearchStructure()

void vtkJumpAndWalkCellLocator::FreeSearchStructure ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ BuildLocator()

void vtkJumpAndWalkCellLocator::BuildLocator ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ ForceBuildLocator()

void vtkJumpAndWalkCellLocator::ForceBuildLocator ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Reimplemented from vtkLocator.

◆ GenerateRepresentation()

void vtkJumpAndWalkCellLocator::GenerateRepresentation	(	int	level,
		vtkPolyData *	pd )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ ShallowCopy()

void vtkJumpAndWalkCellLocator::ShallowCopy ( vtkAbstractCellLocator * locator )

overridevirtual

Shallow copy of a vtkJumpAndWalkCellLocator.

Before you shallow copy, make sure to call SetDataSet()

Reimplemented from vtkAbstractCellLocator.

◆ BuildLocatorInternal()

void vtkJumpAndWalkCellLocator::BuildLocatorInternal ( )

overrideprotectedvirtual

This function is not pure virtual to maintain backwards compatibility.

Reimplemented from vtkLocator.

◆ ReportReferences()

void vtkJumpAndWalkCellLocator::ReportReferences ( vtkGarbageCollector * )

overrideprotectedvirtual

Reimplemented from vtkObjectBase.

◆ FindCell() [2/5]

vtkIdType vtkAbstractCellLocator::FindCell ( double x[3] )

Returns the Id of the cell containing the point, returns -1 if no cell found.

This interface uses a tolerance of zero

THIS FUNCTION IS NOT THREAD SAFE.

◆ FindCell() [3/5]

vtkIdType vtkAbstractCellLocator::FindCell	(	double	x[3],
		double	tol2 )

Returns the Id of the cell containing the point within provided squared tolerance, returns -1 if no cell found.

THIS FUNCTION IS NOT THREAD SAFE.

◆ FindCell() [4/5]

vtkIdType vtkAbstractCellLocator::FindCell	(	double	x[3],
		double	tol2,
		vtkGenericCell *	genCell,
		double	pcoords[3],
		double *	weights )

Find the cell containing a given point.

returns -1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store the information.

THIS FUNCTION IS THREAD SAFE.

◆ FindCell() [5/5]

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

virtual

Find the cell containing a given point.

returns -1 if no cell found the cell parameters are copied into the supplied variables, a cell must be provided to store the information.

If cell and cellId is non-nullptr, then search starts from this cell, to avoid using the actual locator, hoping that a follow-up query is close to the last one.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [2/3]

virtual vtkIdType vtkAbstractCellLocator::FindClosestPointWithinRadius	(	double	x[3],
		double	radius,
		double	closestPoint[3],
		vtkIdType &	cellId,
		int &	subId,
		double &	dist2 )

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 FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [3/3]

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

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.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

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

Common/DataModel/vtkJumpAndWalkCellLocator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkJumpAndWalkCellLocator()

◆ ~vtkJumpAndWalkCellLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetPointLocator()

◆ GetPointLocator()

◆ SetNumberOfClosestPoints()

◆ GetNumberOfClosestPoints()

◆ FindCell() [1/5]

◆ FindClosestPointWithinRadius() [1/3]

◆ FreeSearchStructure()

◆ BuildLocator()

◆ ForceBuildLocator()

◆ GenerateRepresentation()

◆ ShallowCopy()

◆ BuildLocatorInternal()

◆ ReportReferences()

◆ FindCell() [2/5]

◆ FindCell() [3/5]

◆ FindCell() [4/5]

◆ FindCell() [5/5]

◆ FindClosestPointWithinRadius() [2/3]

◆ FindClosestPointWithinRadius() [3/3]