an abstract base class for locators which find cells More...

#include <vtkAbstractCellLocator.h>

Inheritance diagram for vtkAbstractCellLocator:

Collaboration diagram for vtkAbstractCellLocator:

Public Types
typedef vtkLocator	Superclass

Public Types inherited from vtkLocator
typedef vtkObject	Superclass
	Standard type and print methods.

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkAbstractCellLocator *	NewInstance () const

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

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 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 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 vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside)
	Return the closest point within a specified radius 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.

virtual void	FindCellsAlongLine (const double p1[3], const double p2[3], double tolerance, vtkIdList *cells)
	Given a finite line defined by the two points (p1,p2), return the list of unique cell ids in the buckets containing the line.

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

virtual 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)
	Quickly test if a point is inside the bounds of a particular cell.


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.


virtual void	SetLazyEvaluation (vtkTypeBool)
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

virtual vtkTypeBool	GetLazyEvaluation ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

virtual void	LazyEvaluationOn ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

virtual void	LazyEvaluationOff ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.


virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

virtual void	UseExistingSearchStructureOn ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

virtual void	UseExistingSearchStructureOff ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

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	BuildLocator ()=0
	Build the locator from the input dataset.

virtual void	FreeSearchStructure ()=0
	Free the memory required for the spatial data structure.

virtual void	GenerateRepresentation (int level, vtkPolyData *pd)=0
	Method to build a representation at a particular level.

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.

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

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

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

void	Register (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop.

void	UnRegister (vtkObjectBase *o) 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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

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

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

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

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.

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

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

static vtkAbstractCellLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkLocator
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 (int 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 int	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
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

	vtkAbstractCellLocator ()

	~vtkAbstractCellLocator () override


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

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

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

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfCellsPerNode

vtkTypeBool	RetainCellLists

vtkTypeBool	CacheCellBounds

vtkTypeBool	LazyEvaluation

vtkTypeBool	UseExistingSearchStructure

vtkGenericCell *	GenericCell

double(*	CellBounds )[6]

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

an abstract base class for locators which find cells

vtkAbstractCellLocator is a spatial search object to quickly locate cells in 3D. vtkAbstractCellLocator supplies a basic interface which concrete subclasses should implement.

Warning

When deriving a class from vtkAbstractCellLocator, one should include the 'hidden' member functions by the following construct in the derived class

*  using vtkAbstractCellLocator::IntersectWithLine;
*  using vtkAbstractCellLocator::FindClosestPoint;
*  using vtkAbstractCellLocator::FindClosestPointWithinRadius;
*

See also: vtkLocator vtkPointLocator vtkOBBTree vtkCellLocator

Definition at line 48 of file vtkAbstractCellLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkLocator vtkAbstractCellLocator::Superclass

Definition at line 51 of file vtkAbstractCellLocator.h.

Constructor & Destructor Documentation

◆ vtkAbstractCellLocator()

vtkAbstractCellLocator::vtkAbstractCellLocator ( )

protected

◆ ~vtkAbstractCellLocator()

vtkAbstractCellLocator::~vtkAbstractCellLocator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Standard type and print methods.

Reimplemented from vtkLocator.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, vtkModifiedBSPTree, vtkCellTreeLocator, and vtkOBBTree.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractCellLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkLocator.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, vtkModifiedBSPTree, vtkCellTreeLocator, and vtkOBBTree.

◆ NewInstance()

vtkAbstractCellLocator * vtkAbstractCellLocator::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 vtkCellLocator, vtkStaticCellLocator, vtkModifiedBSPTree, vtkCellTreeLocator, and vtkOBBTree.

◆ SetNumberOfCellsPerNode()

virtual void vtkAbstractCellLocator::SetNumberOfCellsPerNode ( int )

virtual

Specify the preferred/maximum number of cells in each node/bucket.

Default 32. Locators generally operate by subdividing space into smaller regions until the number of cells in each region (or node) reaches the desired level.

◆ GetNumberOfCellsPerNode()

virtual int vtkAbstractCellLocator::GetNumberOfCellsPerNode ( )

virtual

Specify the preferred/maximum number of cells in each node/bucket.

Default 32. Locators generally operate by subdividing space into smaller regions until the number of cells in each region (or node) reaches the desired level.

◆ SetCacheCellBounds()

virtual void vtkAbstractCellLocator::SetCacheCellBounds ( vtkTypeBool )

virtual

Boolean controls whether the bounds of each cell are computed only once and then saved.

Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and the extra memory won't cause disk caching (24 extra bytes per cell are required to save the bounds).

◆ GetCacheCellBounds()

virtual vtkTypeBool vtkAbstractCellLocator::GetCacheCellBounds ( )

virtual

Boolean controls whether the bounds of each cell are computed only once and then saved.

Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and the extra memory won't cause disk caching (24 extra bytes per cell are required to save the bounds).

◆ CacheCellBoundsOn()

virtual void vtkAbstractCellLocator::CacheCellBoundsOn ( )

virtual

Boolean controls whether the bounds of each cell are computed only once and then saved.

Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and the extra memory won't cause disk caching (24 extra bytes per cell are required to save the bounds).

◆ CacheCellBoundsOff()

virtual void vtkAbstractCellLocator::CacheCellBoundsOff ( )

virtual

Boolean controls whether the bounds of each cell are computed only once and then saved.

Should be 10 to 20% faster if repeatedly calling any of the Intersect/Find routines and the extra memory won't cause disk caching (24 extra bytes per cell are required to save the bounds).

◆ SetRetainCellLists()

virtual void vtkAbstractCellLocator::SetRetainCellLists ( vtkTypeBool )

virtual

Boolean controls whether to maintain list of cells in each node.

not applicable to all implementations, but if the locator is being used as a geometry simplification technique, there is no need to keep them.

◆ GetRetainCellLists()

virtual vtkTypeBool vtkAbstractCellLocator::GetRetainCellLists ( )

virtual

Boolean controls whether to maintain list of cells in each node.

not applicable to all implementations, but if the locator is being used as a geometry simplification technique, there is no need to keep them.

◆ RetainCellListsOn()

virtual void vtkAbstractCellLocator::RetainCellListsOn ( )

virtual

Boolean controls whether to maintain list of cells in each node.

not applicable to all implementations, but if the locator is being used as a geometry simplification technique, there is no need to keep them.

◆ RetainCellListsOff()

virtual void vtkAbstractCellLocator::RetainCellListsOff ( )

virtual

Boolean controls whether to maintain list of cells in each node.

not applicable to all implementations, but if the locator is being used as a geometry simplification technique, there is no need to keep them.

◆ SetLazyEvaluation()

virtual void vtkAbstractCellLocator::SetLazyEvaluation ( vtkTypeBool )

virtual

Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

If LazyEvaluation is supported, this turns on/off the feature. if not supported, it is ignored.

◆ GetLazyEvaluation()

virtual vtkTypeBool vtkAbstractCellLocator::GetLazyEvaluation ( )

virtual

Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

If LazyEvaluation is supported, this turns on/off the feature. if not supported, it is ignored.

◆ LazyEvaluationOn()

virtual void vtkAbstractCellLocator::LazyEvaluationOn ( )

virtual

Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

If LazyEvaluation is supported, this turns on/off the feature. if not supported, it is ignored.

◆ LazyEvaluationOff()

virtual void vtkAbstractCellLocator::LazyEvaluationOff ( )

virtual

Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed.

If LazyEvaluation is supported, this turns on/off the feature. if not supported, it is ignored.

◆ SetUseExistingSearchStructure()

virtual void vtkAbstractCellLocator::SetUseExistingSearchStructure ( vtkTypeBool )

virtual

Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

◆ GetUseExistingSearchStructure()

virtual vtkTypeBool vtkAbstractCellLocator::GetUseExistingSearchStructure ( )

virtual

Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

◆ UseExistingSearchStructureOn()

virtual void vtkAbstractCellLocator::UseExistingSearchStructureOn ( )

virtual

Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

◆ UseExistingSearchStructureOff()

virtual void vtkAbstractCellLocator::UseExistingSearchStructureOff ( )

virtual

Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase.

◆ IntersectWithLine() [1/4]

virtual int vtkAbstractCellLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId
	)

virtual

Return intersection point (if any) of finite line with cells contained in cell locator.

See vtkCell.h parameters documentation.

Reimplemented in vtkCellLocator, vtkModifiedBSPTree, vtkOBBTree, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ IntersectWithLine() [2/4]

virtual int vtkAbstractCellLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId,
		vtkIdType &	cellId
	)

virtual

Return intersection point (if any) AND the cell which was intersected by the finite line.

Reimplemented in vtkCellLocator, vtkModifiedBSPTree, vtkOBBTree, vtkStaticCellLocator, vtkModifiedBSPTree, and vtkCellTreeLocator.

◆ IntersectWithLine() [3/4]

virtual int vtkAbstractCellLocator::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
	)

virtual

Return intersection point (if any) AND the cell which was intersected by the finite line.

The cell is returned as a cell id and as a generic cell.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, vtkCellTreeLocator, vtkOBBTree, vtkCellLocator, vtkModifiedBSPTree, vtkOBBTree, and vtkModifiedBSPTree.

◆ IntersectWithLine() [4/4]

virtual int vtkAbstractCellLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		vtkPoints *	points,
		vtkIdList *	cellIds
	)

virtual

Take the passed line segment and intersect it with the data set.

This method assumes that the data set is a vtkPolyData that describes a closed surface, and the intersection points that are returned in 'points' alternate between entrance points and exit points. The return value of the function is 0 if no intersections were found, -1 if point 'a0' lies inside the closed surface, or +1 if point 'a0' lies outside the closed surface. Either 'points' or 'cellIds' can be set to nullptr if you don't want to receive that information. This method is currently only implemented in vtkOBBTree.

Reimplemented in vtkOBBTree, vtkCellLocator, vtkModifiedBSPTree, vtkOBBTree, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ FindClosestPoint() [1/2]

virtual void vtkAbstractCellLocator::FindClosestPoint	(	const double	x[3],
		double	closestPoint[3],
		vtkIdType &	cellId,
		int &	subId,
		double &	dist2
	)

virtual

Return the closest point 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.

Reimplemented in vtkCellLocator, and vtkStaticCellLocator.

◆ FindClosestPoint() [2/2]

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

virtual

Return the closest point 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 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 deallocation can be done only once outside the for loop. If a cell is found, "cell" contains the points and ptIds for the cell "cellId" upon exit.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, vtkCellLocator, and vtkStaticCellLocator.

◆ FindClosestPointWithinRadius() [1/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.

Reimplemented in vtkCellLocator, and vtkStaticCellLocator.

◆ FindClosestPointWithinRadius() [2/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 deallocation 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.

Reimplemented in vtkCellLocator, and vtkStaticCellLocator.

◆ FindClosestPointWithinRadius() [3/3]

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

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

Reimplemented in vtkCellLocator, vtkStaticCellLocator, vtkCellLocator, and vtkStaticCellLocator.

◆ FindCellsWithinBounds()

virtual void vtkAbstractCellLocator::FindCellsWithinBounds	(	double *	bbox,
		vtkIdList *	cells
	)

virtual

Return a list of unique cell ids inside of a given bounding box.

The user must provide the vtkIdList to populate. This method returns data only after the locator has been built.

Reimplemented in vtkCellLocator, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ FindCellsAlongLine()

virtual void vtkAbstractCellLocator::FindCellsAlongLine	(	const double	p1[3],
		const double	p2[3],
		double	tolerance,
		vtkIdList *	cells
	)

virtual

Given a finite line defined by the two points (p1,p2), return the list of unique cell ids in the buckets containing the line.

It is possible that an empty cell list is returned. The user must provide the vtkIdList to populate. This method returns data only after the locator has been built.

Reimplemented in vtkCellLocator, and vtkStaticCellLocator.

◆ FindCell() [1/2]

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

virtual

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

This interface uses a tolerance of zero

Reimplemented in vtkCellLocator, vtkModifiedBSPTree, vtkStaticCellLocator, and vtkCellTreeLocator.

◆ FindCell() [2/2]

virtual vtkIdType vtkAbstractCellLocator::FindCell	(	double	x[3],
		double	tol2,
		vtkGenericCell *	GenCell,
		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.

Reimplemented in vtkCellLocator, vtkModifiedBSPTree, vtkCellLocator, and vtkModifiedBSPTree.

◆ InsideCellBounds()

virtual bool vtkAbstractCellLocator::InsideCellBounds	(	double	x[3],
		vtkIdType	cell_ID
	)

virtual

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

Some locators cache cell bounds and this function can make use of fast access to the data.

Reimplemented in vtkModifiedBSPTree.

◆ StoreCellBounds()

virtual bool vtkAbstractCellLocator::StoreCellBounds ( )

protectedvirtual

This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array.

Subsequent calls to InsideCellBounds(...) can make use of the data A valid dataset must be present for this to work. Returns true if bounds wre copied, false otherwise.

◆ FreeCellBounds()

virtual void vtkAbstractCellLocator::FreeCellBounds ( )

protectedvirtual

This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array.

Subsequent calls to InsideCellBounds(...) can make use of the data A valid dataset must be present for this to work. Returns true if bounds wre copied, false otherwise.

Member Data Documentation

◆ NumberOfCellsPerNode

int vtkAbstractCellLocator::NumberOfCellsPerNode

protected

Definition at line 274 of file vtkAbstractCellLocator.h.

◆ RetainCellLists

vtkTypeBool vtkAbstractCellLocator::RetainCellLists

protected

Definition at line 275 of file vtkAbstractCellLocator.h.

◆ CacheCellBounds

vtkTypeBool vtkAbstractCellLocator::CacheCellBounds

protected

Definition at line 276 of file vtkAbstractCellLocator.h.

◆ LazyEvaluation

vtkTypeBool vtkAbstractCellLocator::LazyEvaluation

protected

Definition at line 277 of file vtkAbstractCellLocator.h.

◆ UseExistingSearchStructure

vtkTypeBool vtkAbstractCellLocator::UseExistingSearchStructure

protected

Definition at line 278 of file vtkAbstractCellLocator.h.

◆ GenericCell

vtkGenericCell* vtkAbstractCellLocator::GenericCell

protected

Definition at line 279 of file vtkAbstractCellLocator.h.

◆ CellBounds

double(* vtkAbstractCellLocator::CellBounds)[6]

protected

Definition at line 280 of file vtkAbstractCellLocator.h.

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

Common/DataModel/vtkAbstractCellLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractCellLocator()

◆ ~vtkAbstractCellLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetNumberOfCellsPerNode()

◆ GetNumberOfCellsPerNode()

◆ SetCacheCellBounds()

◆ GetCacheCellBounds()

◆ CacheCellBoundsOn()

◆ CacheCellBoundsOff()

◆ SetRetainCellLists()

◆ GetRetainCellLists()

◆ RetainCellListsOn()

◆ RetainCellListsOff()

◆ SetLazyEvaluation()

◆ GetLazyEvaluation()

◆ LazyEvaluationOn()

◆ LazyEvaluationOff()

◆ SetUseExistingSearchStructure()

◆ GetUseExistingSearchStructure()

◆ UseExistingSearchStructureOn()

◆ UseExistingSearchStructureOff()

◆ IntersectWithLine() [1/4]

◆ IntersectWithLine() [2/4]

◆ IntersectWithLine() [3/4]

◆ IntersectWithLine() [4/4]

◆ FindClosestPoint() [1/2]

◆ FindClosestPoint() [2/2]

◆ FindClosestPointWithinRadius() [1/3]

◆ FindClosestPointWithinRadius() [2/3]

◆ FindClosestPointWithinRadius() [3/3]

◆ FindCellsWithinBounds()

◆ FindCellsAlongLine()

◆ FindCell() [1/2]

◆ FindCell() [2/2]

◆ InsideCellBounds()

◆ StoreCellBounds()

◆ FreeCellBounds()

Member Data Documentation

◆ NumberOfCellsPerNode

◆ RetainCellLists

◆ CacheCellBounds

◆ LazyEvaluation

◆ UseExistingSearchStructure

◆ GenericCell

◆ CellBounds