octree-based spatial search object to quickly locate cells More...

#include <vtkCellLocator.h>

Inheritance diagram for vtkCellLocator:

Collaboration diagram for vtkCellLocator:

Public Types
typedef vtkAbstractCellLocator	Superclass

Public Types inherited from vtkAbstractCellLocator
typedef vtkLocator	Superclass

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

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

vtkCellLocator *	NewInstance () const

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

void	SetNumberOfCellsPerBucket (int N)
	Specify the average number of cells in each octant. More...

int	GetNumberOfCellsPerBucket ()

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

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

vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, 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. More...

virtual vtkIdList *	GetCells (int bucket)
	Get the cells in a particular bucket. More...

virtual int	GetNumberOfBuckets (void)
	Return number of buckets available. More...

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

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

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

void	FreeSearchStructure () override
	Satisfy vtkLocator abstract interface. More...

void	BuildLocator () override
	Build the locator from the input dataset. More...

virtual void	BuildLocatorIfNeeded ()

virtual void	ForceBuildLocator ()

virtual void	BuildLocatorInternal ()

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Method to build a representation at a particular level. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual int	GetNumberOfCellsPerNode ()

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

virtual vtkTypeBool	GetCacheCellBounds ()

virtual void	CacheCellBoundsOn ()

virtual void	CacheCellBoundsOff ()

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

virtual vtkTypeBool	GetRetainCellLists ()

virtual void	RetainCellListsOn ()

virtual void	RetainCellListsOff ()

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

virtual vtkTypeBool	GetLazyEvaluation ()

virtual void	LazyEvaluationOn ()

virtual void	LazyEvaluationOff ()

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

virtual vtkTypeBool	GetUseExistingSearchStructure ()

virtual void	UseExistingSearchStructureOn ()

virtual void	UseExistingSearchStructureOff ()

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

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

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

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

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

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

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

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

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

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

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

virtual vtkDataSet *	GetDataSet ()

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

virtual int	GetMaxLevel ()

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

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

virtual vtkTypeBool	GetAutomatic ()

virtual void	AutomaticOn ()

virtual void	AutomaticOff ()

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

virtual double	GetTolerance ()

virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed. More...

virtual void	Initialize ()
	Initialize locator. More...

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

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)

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

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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

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

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

void	SetReferenceCount (int)
	Sets the reference count. More...

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

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

static vtkCellLocator *	SafeDownCast (vtkObjectBase *o)

static vtkCellLocator *	New ()
	Construct with automatic computation of divisions, averaging 25 cells per bucket. More...

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

static vtkAbstractCellLocator *	SafeDownCast (vtkObjectBase *o)

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

static vtkLocator *	SafeDownCast (vtkObjectBase *o)

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

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

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

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

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

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

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCellLocator ()

	~vtkCellLocator () override

void	GetBucketNeighbors (int ijk[3], int ndivs, int level)

void	GetOverlappingBuckets (const double x[3], int ijk[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])

void	ClearCellHasBeenVisited ()

void	ClearCellHasBeenVisited (vtkIdType id)

double	Distance2ToBucket (const double x[3], int nei[3])

double	Distance2ToBounds (const double x[3], double bounds[6])

void	MarkParents (void *, int, int, int, int, int)

void	GetChildren (int idx, int level, int children[8])

int	GenerateIndex (int offset, int numDivs, int i, int j, int k, vtkIdType &idx)

void	GenerateFace (int face, int numDivs, int i, int j, int k, vtkPoints pts, vtkCellArray polys)

void	ComputeOctantBounds (int i, int j, int k)

int	IsInOctantBounds (const double x[3], double tol=0.0)

Protected Member Functions inherited from vtkAbstractCellLocator
	vtkAbstractCellLocator ()

	~vtkAbstractCellLocator () override

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

virtual void	FreeCellBounds ()

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

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfOctants

double	Bounds [6]

int	NumberOfParents

double	H [3]

int	NumberOfDivisions

vtkIdList **	Tree

vtkNeighborCells *	Buckets

unsigned char *	CellHasBeenVisited

unsigned char	QueryNumber

double	OctantBounds [6]

Protected Attributes inherited from vtkAbstractCellLocator
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

octree-based spatial search object to quickly locate cells

vtkCellLocator is a spatial search object to quickly locate cells in 3D. vtkCellLocator uses a uniform-level octree subdivision, where each octant (an octant is also referred to as a bucket) carries an indication of whether it is empty or not, and each leaf octant carries a list of the cells inside of it. (An octant is not empty if it has one or more cells inside of it.) Typical operations are intersection with a line to return candidate cells, or intersection with another vtkCellLocator to return candidate cells.

Warning: Many other types of spatial locators have been developed, such as variable depth octrees and kd-trees. These are often more efficient for the operations described here. vtkCellLocator has been designed for subclassing; so these locators can be derived if necessary.; Most of the methods of this class are not thread-safe. For a thread-safe, more efficient generic implementation, please use vtkStaticCellLocator

See also: vtkLocator vtkPointLocator vtkOBBTree vtkStaticCellLocator

Definition at line 50 of file vtkCellLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractCellLocator vtkCellLocator::Superclass

Definition at line 53 of file vtkCellLocator.h.

Constructor & Destructor Documentation

◆ vtkCellLocator()

vtkCellLocator::vtkCellLocator ( )

protected

◆ ~vtkCellLocator()

vtkCellLocator::~vtkCellLocator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkCellLocator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractCellLocator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellLocator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractCellLocator.

◆ NewInstance()

vtkCellLocator* vtkCellLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkCellLocator::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 vtkAbstractCellLocator.

◆ New()

static vtkCellLocator* vtkCellLocator::New ( )

static

Construct with automatic computation of divisions, averaging 25 cells per bucket.

◆ SetNumberOfCellsPerBucket()

void vtkCellLocator::SetNumberOfCellsPerBucket ( int N )

inline

Specify the average number of cells in each octant.

Definition at line 65 of file vtkCellLocator.h.

◆ GetNumberOfCellsPerBucket()

int vtkCellLocator::GetNumberOfCellsPerBucket ( )

inline

Definition at line 66 of file vtkCellLocator.h.

◆ IntersectWithLine() [1/5]

int vtkCellLocator::IntersectWithLine	(	const double	a0[3],
		const double	a1[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId,
		vtkIdType &	cellId,
		vtkGenericCell *	cell
	)

overridevirtual

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. For other IntersectWithLine signatures, see vtkAbstractCellLocator. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPoint() [1/3]

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

overridevirtual

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

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [1/4]

vtkIdType vtkCellLocator::FindClosestPointWithinRadius	(	double	x[3],
		double	radius,
		double	closestPoint[3],
		vtkGenericCell *	cell,
		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). For other FindClosestPointWithinRadius signatures, see vtkAbstractCellLocator. THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ GetCells()

virtual vtkIdList* vtkCellLocator::GetCells ( int bucket )

virtual

Get the cells in a particular bucket.

◆ GetNumberOfBuckets()

virtual int vtkCellLocator::GetNumberOfBuckets ( void )

virtual

Return number of buckets available.

Ensure that the locator has been built before attempting to access buckets (octants).

◆ FindCell() [1/3]

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

Reimplemented from vtkAbstractCellLocator.

◆ FindCellsWithinBounds()

void vtkCellLocator::FindCellsWithinBounds	(	double *	bbox,
		vtkIdList *	cells
	)

overridevirtual

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

◆ FindCellsAlongLine()

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

overridevirtual

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

Reimplemented from vtkAbstractCellLocator.

◆ FreeSearchStructure()

void vtkCellLocator::FreeSearchStructure ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ BuildLocator()

void vtkCellLocator::BuildLocator ( )

overridevirtual

Build the locator from the input dataset.

Implements vtkLocator.

◆ BuildLocatorIfNeeded()

virtual void vtkCellLocator::BuildLocatorIfNeeded ( )

virtual

◆ ForceBuildLocator()

virtual void vtkCellLocator::ForceBuildLocator ( )

virtual

◆ BuildLocatorInternal()

virtual void vtkCellLocator::BuildLocatorInternal ( )

virtual

◆ GenerateRepresentation()

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

overridevirtual

Method to build a representation at a particular level.

Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.

Implements vtkLocator.

◆ GetBucketNeighbors()

void vtkCellLocator::GetBucketNeighbors	(	int	ijk[3],
		int	ndivs,
		int	level
	)

protected

◆ GetOverlappingBuckets()

void vtkCellLocator::GetOverlappingBuckets	(	const double	x[3],
		int	ijk[3],
		double	dist,
		int	prevMinLevel[3],
		int	prevMaxLevel[3]
	)

protected

◆ ClearCellHasBeenVisited() [1/2]

void vtkCellLocator::ClearCellHasBeenVisited ( )

protected

◆ ClearCellHasBeenVisited() [2/2]

void vtkCellLocator::ClearCellHasBeenVisited ( vtkIdType id )

protected

◆ Distance2ToBucket()

double vtkCellLocator::Distance2ToBucket	(	const double	x[3],
		int	nei[3]
	)

protected

◆ Distance2ToBounds()

double vtkCellLocator::Distance2ToBounds	(	const double	x[3],
		double	bounds[6]
	)

protected

◆ MarkParents()

void vtkCellLocator::MarkParents	(	void *	,
		int	,
		int	,
		int	,
		int	,
		int
	)

protected

◆ GetChildren()

void vtkCellLocator::GetChildren	(	int	idx,
		int	level,
		int	children[8]
	)

protected

◆ GenerateIndex()

int vtkCellLocator::GenerateIndex	(	int	offset,
		int	numDivs,
		int	i,
		int	j,
		int	k,
		vtkIdType &	idx
	)

protected

◆ GenerateFace()

void vtkCellLocator::GenerateFace	(	int	face,
		int	numDivs,
		int	i,
		int	j,
		int	k,
		vtkPoints *	pts,
		vtkCellArray *	polys
	)

protected

◆ ComputeOctantBounds()

void vtkCellLocator::ComputeOctantBounds	(	int	i,
		int	j,
		int	k
	)

protected

◆ IsInOctantBounds()

int vtkCellLocator::IsInOctantBounds	(	const double	x[3],
		double	tol = `0.0`
	)

inlineprotected

Definition at line 202 of file vtkCellLocator.h.

◆ FindCell() [2/3]

virtual vtkIdType vtkAbstractCellLocator::FindCell

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

This interface uses a tolerance of zero

◆ FindCell() [3/3]

virtual vtkIdType vtkAbstractCellLocator::FindCell

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.

◆ FindClosestPoint() [2/3]

virtual void vtkAbstractCellLocator::FindClosestPoint

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.

◆ FindClosestPoint() [3/3]

virtual void vtkAbstractCellLocator::FindClosestPoint

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.

◆ FindClosestPointWithinRadius() [2/4]

virtual vtkIdType vtkAbstractCellLocator::FindClosestPointWithinRadius

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.

◆ FindClosestPointWithinRadius() [3/4]

virtual vtkIdType vtkAbstractCellLocator::FindClosestPointWithinRadius

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.

◆ FindClosestPointWithinRadius() [4/4]

virtual vtkIdType vtkAbstractCellLocator::FindClosestPointWithinRadius

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

◆ IntersectWithLine() [2/5]

virtual int vtkAbstractCellLocator::IntersectWithLine

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

See vtkCell.h parameters documentation.

◆ IntersectWithLine() [3/5]

virtual int vtkAbstractCellLocator::IntersectWithLine

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

◆ IntersectWithLine() [4/5]

virtual int vtkAbstractCellLocator::IntersectWithLine

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.

◆ IntersectWithLine() [5/5]

virtual int vtkAbstractCellLocator::IntersectWithLine

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.

Member Data Documentation

◆ NumberOfOctants

int vtkCellLocator::NumberOfOctants

protected

Definition at line 183 of file vtkCellLocator.h.

◆ Bounds

double vtkCellLocator::Bounds[6]

protected

Definition at line 184 of file vtkCellLocator.h.

◆ NumberOfParents

int vtkCellLocator::NumberOfParents

protected

Definition at line 185 of file vtkCellLocator.h.

◆ H

double vtkCellLocator::H[3]

protected

Definition at line 186 of file vtkCellLocator.h.

◆ NumberOfDivisions

int vtkCellLocator::NumberOfDivisions

protected

Definition at line 187 of file vtkCellLocator.h.

◆ Tree

vtkIdList** vtkCellLocator::Tree

protected

Definition at line 188 of file vtkCellLocator.h.

◆ Buckets

vtkNeighborCells* vtkCellLocator::Buckets

protected

Definition at line 196 of file vtkCellLocator.h.

◆ CellHasBeenVisited

unsigned char* vtkCellLocator::CellHasBeenVisited

protected

Definition at line 197 of file vtkCellLocator.h.

◆ QueryNumber

unsigned char vtkCellLocator::QueryNumber

protected

Definition at line 198 of file vtkCellLocator.h.

◆ OctantBounds

double vtkCellLocator::OctantBounds[6]

protected

Definition at line 201 of file vtkCellLocator.h.

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

Common/DataModel/vtkCellLocator.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

◆ vtkCellLocator()

◆ ~vtkCellLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetNumberOfCellsPerBucket()

◆ GetNumberOfCellsPerBucket()

◆ IntersectWithLine() [1/5]

◆ FindClosestPoint() [1/3]

◆ FindClosestPointWithinRadius() [1/4]

◆ GetCells()

◆ GetNumberOfBuckets()

◆ FindCell() [1/3]

◆ FindCellsWithinBounds()

◆ FindCellsAlongLine()

◆ FreeSearchStructure()

◆ BuildLocator()

◆ BuildLocatorIfNeeded()

◆ ForceBuildLocator()

◆ BuildLocatorInternal()

◆ GenerateRepresentation()

◆ GetBucketNeighbors()

◆ GetOverlappingBuckets()

◆ ClearCellHasBeenVisited() [1/2]

◆ ClearCellHasBeenVisited() [2/2]

◆ Distance2ToBucket()

◆ Distance2ToBounds()

◆ MarkParents()

◆ GetChildren()

◆ GenerateIndex()

◆ GenerateFace()

◆ ComputeOctantBounds()

◆ IsInOctantBounds()

◆ FindCell() [2/3]

◆ FindCell() [3/3]

◆ FindClosestPoint() [2/3]

◆ FindClosestPoint() [3/3]

◆ FindClosestPointWithinRadius() [2/4]

◆ FindClosestPointWithinRadius() [3/4]

◆ FindClosestPointWithinRadius() [4/4]

◆ IntersectWithLine() [2/5]

◆ IntersectWithLine() [3/5]

◆ IntersectWithLine() [4/5]

◆ IntersectWithLine() [5/5]

Member Data Documentation

◆ NumberOfOctants

◆ Bounds

◆ NumberOfParents

◆ H

◆ NumberOfDivisions

◆ Tree

◆ Buckets

◆ CellHasBeenVisited

◆ QueryNumber

◆ OctantBounds