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

#include <vtkCellLocator.h>

Inheritance diagram for vtkCellLocator:

Collaboration diagram for vtkCellLocator:

Classes
class	vtkNeighborCells

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

int	GetNumberOfCellsPerBucket ()

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) override
	Return intersection point (if any) AND the cell which was intersected by the finite line.

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

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.

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.

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

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

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

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

virtual int	GetNumberOfBuckets ()
	Return number of buckets available.

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

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 vtkIdType	FindCell (double x[3], double tol2, vtkGenericCell GenCell, int &subId, double pcoords[3], double weights)
	Find the cell containing a given point.

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


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

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 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)
	Take the passed line segment and intersect it with the data set.

virtual void	FindCellsAlongPlane (const double o[3], const double n[3], double tolerance, 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.

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

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

virtual void	ShallowCopy (vtkAbstractCellLocator *)
	Shallow copy of a vtkAbstractCellLocator.

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.

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	ForceBuildLocator ()
	Build the locator from the input dataset (even if UseExistingSearchStructure is on).

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 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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Static Public Member Functions
static vtkCellLocator *	New ()
	Construct with automatic computation of divisions, averaging 25 cells per bucket.

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

Protected Member Functions
	vtkCellLocator ()

	~vtkCellLocator () override

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

void	GetOverlappingBuckets (vtkNeighborCells &buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])

void	GetBucketIndices (const double x[3], int ijk[3])

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

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

void	MarkParents (const vtkSmartPointer< vtkIdList > &, int, int, int, int, int)

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 (double octantBounds[6], int i, int j, int k)

Protected Member Functions inherited from vtkAbstractCellLocator
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

	vtkAbstractCellLocator ()

	~vtkAbstractCellLocator () override

void	UpdateInternalWeights ()
	To be called in `FindCell(double[3])`.

void	GetCellBounds (vtkIdType cellId, double *&cellBoundsPtr)

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

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

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

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfOctants

double	Bounds [6]

double	H [3]

int	NumberOfDivisions

std::shared_ptr< std::vector< vtkSmartPointer< vtkIdList > > >	TreeSharedPtr

vtkSmartPointer< vtkIdList > *	Tree

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

double	Tolerance

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

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from vtkAbstractCellLocator
typedef vtkLocator	Superclass

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

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

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

vtkCellLocator utilizes the following parent class parameters:

Automatic (default true)
Level (default 8)
MaxLevel (default 8)
NumberOfCellsPerNode (default 25)
CacheCellBounds (default true)
UseExistingSearchStructure (default false)

vtkCellLocator does NOT utilize the following parameters:

Tolerance
RetainCellLists

See also: vtkAbstractCellLocator vtkStaticCellLocator vtkCellTreeLocator vtkModifiedBSPTree vtkOBBTree

Online Examples:

CellLocator

CellLocatorVisualization

ExtractOutsideSurface

InterpolateTerrain

RemoveOutsideSurface

ResampleAppendedPolyData

FindCellIntersections

Tests:: vtkCellLocator (Tests)

Definition at line 125 of file vtkCellLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractCellLocator vtkCellLocator::Superclass

Standard methods to print and obtain type-related information.

Definition at line 132 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

Standard methods to print and obtain type-related information.

◆ IsA()

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

virtual

Standard methods to print and obtain type-related information.

Reimplemented from vtkAbstractCellLocator.

◆ SafeDownCast()

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

static

Standard methods to print and obtain type-related information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard methods to print and obtain type-related information.

Reimplemented from vtkAbstractCellLocator.

◆ NewInstance()

vtkCellLocator * vtkCellLocator::NewInstance ( ) const

Standard methods to print and obtain type-related information.

◆ PrintSelf()

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

overridevirtual

Standard methods to print and obtain type-related information.

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 145 of file vtkCellLocator.h.

◆ GetNumberOfCellsPerBucket()

int vtkCellLocator::GetNumberOfCellsPerBucket ( )

inline

Definition at line 146 of file vtkCellLocator.h.

◆ IntersectWithLine() [1/8]

int vtkCellLocator::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
	)

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.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [2/8]

int vtkCellLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		double	tol,
		vtkPoints *	points,
		vtkIdList *	cellIds,
		vtkGenericCell *	cell
	)

overridevirtual

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

The return value of the function is 0 if no intersections were found. For each intersection with the bounds of a cell or with a cell (if a cell is provided), the points and cellIds have the relevant information added sorted by t. If points or cellIds are nullptr pointers, then no information is generated for that list.

For other IntersectWithLine signatures, see vtkAbstractCellLocator.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPoint() [1/3]

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

inlineoverridevirtual

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 from vtkAbstractCellLocator to showcase that it's a supported function.

For other FindClosestPoint signatures, see vtkAbstractCellLocator.

Reimplemented from vtkAbstractCellLocator.

Definition at line 184 of file vtkCellLocator.h.

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

Reimplemented from vtkAbstractCellLocator.

◆ FindCell() [1/4]

vtkIdType vtkCellLocator::FindCell	(	double	x[3],
		double	vtkNotUsedtol2,
		vtkGenericCell *	GenCell,
		int &	subId,
		double	pcoords[3],
		double *	weights
	)

override

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.

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

Reimplemented from vtkAbstractCellLocator.

◆ FindCellsAlongLine()

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

inlineoverridevirtual

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

For each intersection with the bounds of a cell, the cellIds have the relevant information added sort by t. If cellIds is nullptr pointer, then no information is generated for that list.

Reimplemented from vtkAbstractCellLocator to showcase that it's a supported function.

Reimplemented from vtkAbstractCellLocator.

Definition at line 229 of file vtkCellLocator.h.

◆ FreeSearchStructure()

void vtkCellLocator::FreeSearchStructure ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ BuildLocator()

void vtkCellLocator::BuildLocator ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ ForceBuildLocator()

void vtkCellLocator::ForceBuildLocator ( )

overridevirtual

Satisfy vtkLocator abstract interface.

Reimplemented from vtkLocator.

◆ GenerateRepresentation()

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

overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ GetCells()

virtual vtkIdList * vtkCellLocator::GetCells ( int bucket )

virtual

Get the cells in a particular bucket.

◆ GetNumberOfBuckets()

virtual int vtkCellLocator::GetNumberOfBuckets ( )

virtual

Return number of buckets available.

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

◆ ShallowCopy()

void vtkCellLocator::ShallowCopy ( vtkAbstractCellLocator * locator )

overridevirtual

Shallow copy of a vtkCellLocator.

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

Reimplemented from vtkAbstractCellLocator.

◆ BuildLocatorInternal()

void vtkCellLocator::BuildLocatorInternal ( )

overrideprotectedvirtual

This function is not pure virtual to maintain backwards compatibility.

Reimplemented from vtkLocator.

◆ GetOverlappingBuckets()

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

protected

◆ GetBucketIndices()

void vtkCellLocator::GetBucketIndices	(	const double	x[3],
		int	ijk[3]
	)

inlineprotected

◆ 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	(	const vtkSmartPointer< vtkIdList > &	,
		int	,
		int	,
		int	,
		int	,
		int
	)

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	(	double	octantBounds[6],
		int	i,
		int	j,
		int	k
	)

protected

◆ FindCell() [2/4]

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

THIS FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindCell() [3/4]

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.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindCell() [4/4]

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

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPoint() [2/3]

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.

A vtkAbstractCellLocator subclass needs to implement FindClosestPointWithinRadius which is used internally to implement FindClosestPoint.

THIS FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPoint() [3/3]

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.

A vtkAbstractCellLocator subclass needs to implement FindClosestPointWithinRadius which is used internally to implement FindClosestPoint.

This function takes in a vtkGenericCell to avoid using the internal vtkGenericCell.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [2/4]

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/4]

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 function takes in a vtkGenericCell to avoid using the internal vtkGenericCell.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [4/4]

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. If a closest point is found, inside returns the return value of the EvaluatePosition call to the closest cell; inside(=1) or outside(=0).

This function takes in a vtkGenericCell to avoid using the internal vtkGenericCell.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [3/8]

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.

THIS FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [4/8]

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.

THIS FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [5/8]

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.

This function takes in a vtkGenericCell to avoid using the internal vtkGenericCell.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [6/8]

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.

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

Either 'points' or 'cellIds' can be set to nullptr if you don't want to receive that information.

This method is only implemented in vtkOBBTree.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [7/8]

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

virtual

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

The return value of the function is 0 if no intersections were found. For each intersection with a cell, the points and cellIds have the relevant information added sorted by t. If points or cellIds are nullptr pointers, then no information is generated for that list.

THIS FUNCTION IS NOT THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [8/8]

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

virtual

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

The return value of the function is 0 if no intersections were found. For each intersection with the bounds of a cell or with a cell (if a cell is provided), the points and cellIds have the relevant information added sorted by t. If points or cellIds are nullptr pointers, then no information is generated for that list.

This function takes in a vtkGenericCell to avoid using the internal vtkGenericCell.

THIS FUNCTION IS THREAD SAFE.

Reimplemented from vtkAbstractCellLocator.

Member Data Documentation

◆ NumberOfOctants

int vtkCellLocator::NumberOfOctants

protected

Definition at line 295 of file vtkCellLocator.h.

◆ Bounds

double vtkCellLocator::Bounds[6]

protected

Definition at line 296 of file vtkCellLocator.h.

◆ H

double vtkCellLocator::H[3]

protected

Definition at line 297 of file vtkCellLocator.h.

◆ NumberOfDivisions

int vtkCellLocator::NumberOfDivisions

protected

Definition at line 298 of file vtkCellLocator.h.

◆ TreeSharedPtr

std::shared_ptr<std::vector<vtkSmartPointer<vtkIdList> > > vtkCellLocator::TreeSharedPtr

protected

Definition at line 299 of file vtkCellLocator.h.

◆ Tree

vtkSmartPointer<vtkIdList>* vtkCellLocator::Tree

protected

Definition at line 300 of file vtkCellLocator.h.

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

Common/DataModel/vtkCellLocator.h

Classes

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/8]

◆ IntersectWithLine() [2/8]

◆ FindClosestPoint() [1/3]

◆ FindClosestPointWithinRadius() [1/4]

◆ FindCell() [1/4]

◆ FindCellsWithinBounds()

◆ FindCellsAlongLine()

◆ FreeSearchStructure()

◆ BuildLocator()

◆ ForceBuildLocator()

◆ GenerateRepresentation()

◆ GetCells()

◆ GetNumberOfBuckets()

◆ ShallowCopy()

◆ BuildLocatorInternal()

◆ GetOverlappingBuckets()

◆ GetBucketIndices()

◆ Distance2ToBucket()

◆ Distance2ToBounds()

◆ MarkParents()

◆ GenerateIndex()

◆ GenerateFace()

◆ ComputeOctantBounds()

◆ FindCell() [2/4]

◆ FindCell() [3/4]

◆ FindCell() [4/4]

◆ FindClosestPoint() [2/3]

◆ FindClosestPoint() [3/3]

◆ FindClosestPointWithinRadius() [2/4]

◆ FindClosestPointWithinRadius() [3/4]

◆ FindClosestPointWithinRadius() [4/4]

◆ IntersectWithLine() [3/8]

◆ IntersectWithLine() [4/8]

◆ IntersectWithLine() [5/8]

◆ IntersectWithLine() [6/8]

◆ IntersectWithLine() [7/8]

◆ IntersectWithLine() [8/8]

Member Data Documentation

◆ NumberOfOctants

◆ Bounds

◆ H

◆ NumberOfDivisions

◆ TreeSharedPtr

◆ Tree