VTK  9.2.20220807
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkAbstractCellLocator Class Reference

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

#include <vtkAbstractCellLocator.h>

Inheritance diagram for vtkAbstractCellLocator:
[legend]
Collaboration diagram for vtkAbstractCellLocator:
[legend]

Public Types

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)
 Standard type and print methods. More...
 
vtkAbstractCellLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ComputeCellBounds ()
 This function can be used either internally or externally to compute only the cached cell bounds if CacheCellBounds is on. 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...
 
virtual int IntersectWithLine (const double p1[3], const double p2[3], const double tol, vtkPoints *points, vtkIdList *cellIds)
 Take the passed line segment and intersect it with the data set. More...
 
virtual int IntersectWithLine (const double p1[3], const double p2[3], const double tol, vtkPoints *points, vtkIdList *cellIds, vtkGenericCell *cell)
 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 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 void FindCellsWithinBounds (double *bbox, vtkIdList *cells)
 Return a list of unique cell ids inside of a given bounding box. More...
 
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. More...
 
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. 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...
 
virtual void ShallowCopy (vtkAbstractCellLocator *)
 Shallow copy of a vtkAbstractCellLocator. More...
 
virtual void SetNumberOfCellsPerNode (int)
 Specify the preferred/maximum number of cells in each node/bucket. More...
 
virtual int GetNumberOfCellsPerNode ()
 Specify the preferred/maximum number of cells in each node/bucket. More...
 
virtual void SetCacheCellBounds (vtkTypeBool)
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual vtkTypeBool GetCacheCellBounds ()
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual void CacheCellBoundsOn ()
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual void CacheCellBoundsOff ()
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual void SetRetainCellLists (vtkTypeBool)
 Boolean controls whether to maintain list of cells in each node. More...
 
virtual vtkTypeBool GetRetainCellLists ()
 Boolean controls whether to maintain list of cells in each node. More...
 
virtual void RetainCellListsOn ()
 Boolean controls whether to maintain list of cells in each node. More...
 
virtual void RetainCellListsOff ()
 Boolean controls whether to maintain list of cells in each node. More...
 
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 ()
 Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...
 
virtual void LazyEvaluationOn ()
 Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...
 
virtual void LazyEvaluationOff ()
 Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. 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 vtkIdType FindCell (double x[3], double tol2, vtkGenericCell *GenCell, int &subId, double pcoords[3], double *weights)
 Find the cell containing a given point. More...
 
- Public Member Functions inherited from vtkLocator
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 void BuildLocator ()=0
 Build the locator from the input dataset. More...
 
virtual void ForceBuildLocator ()
 Build the locator from the input dataset (even if UseExistingSearchStructure is on). More...
 
virtual void FreeSearchStructure ()=0
 Free the memory required for the spatial data structure. More...
 
virtual void GenerateRepresentation (int level, vtkPolyData *pd)=0
 Method to build a representation at a particular level. More...
 
virtual void SetDataSet (vtkDataSet *)
 Build the locator from the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 Build the locator from the points/cells defining this dataset. More...
 
virtual void SetMaxLevel (int)
 Set the maximum allowable level for the tree. More...
 
virtual int GetMaxLevel ()
 Set the maximum allowable level for the tree. More...
 
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 ()
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual void AutomaticOn ()
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual void AutomaticOff ()
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual void SetTolerance (double)
 Specify absolute tolerance (in world coordinates) for performing geometric operations. More...
 
virtual double GetTolerance ()
 Specify absolute tolerance (in world coordinates) for performing geometric operations. More...
 
virtual void SetUseExistingSearchStructure (vtkTypeBool)
 Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again. More...
 
virtual vtkTypeBool GetUseExistingSearchStructure ()
 Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again. More...
 
virtual void UseExistingSearchStructureOn ()
 Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again. More...
 
virtual void UseExistingSearchStructureOff ()
 Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again. More...
 
virtual vtkMTimeType GetBuildTime ()
 Return the time of the last data structure build. More...
 
bool UsesGarbageCollector () const override
 Handle the PointSet <-> Locator loop. More...
 
vtkLocatorNewInstance () const
 Standard type and print methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods. 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...
 
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)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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 Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractCellLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLocator
static vtkTypeBool IsTypeOf (const char *type)
 Standard type and print methods. More...
 
static vtkLocatorSafeDownCast (vtkObjectBase *o)
 Standard type and print methods. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 Standard type and print methods. More...
 
 vtkAbstractCellLocator ()
 
 ~vtkAbstractCellLocator () override
 
void UpdateInternalWeights ()
 To be called in FindCell(double[3]). More...
 
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. More...
 
virtual void FreeCellBounds ()
 This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array. More...
 
- Protected Member Functions inherited from vtkLocator
 vtkLocator ()
 
 ~vtkLocator () override
 
virtual void BuildLocatorInternal ()
 This function is not pure virtual to maintain backwards compatibility. More...
 
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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static bool IsInBounds (const double bounds[6], const double x[3], const double tol=0.0)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

int NumberOfCellsPerNode
 
vtkTypeBool RetainCellLists
 
vtkTypeBool CacheCellBounds
 
vtkNew< vtkGenericCellGenericCell
 
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. More...
 
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. More...
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
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
 

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;
*  using vtkAbstractCellLocator::FindCell;
* 
See also
vtkLocator vtkCellLocator vtkStaticCellLocator vtkCellTreeLocator vtkModifiedBSPTree vtkOBBTree
Tests:
vtkAbstractCellLocator (Tests)

Definition at line 56 of file vtkAbstractCellLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 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 vtkOBBTree, vtkModifiedBSPTree, vtkLinearTransformCellLocator, vtkStaticCellLocator, vtkCellTreeLocator, and vtkCellLocator.

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

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

◆ 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 (48 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 (48 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 (48 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 (48 extra bytes per cell are required to save the bounds).

◆ ComputeCellBounds()

void vtkAbstractCellLocator::ComputeCellBounds ( )

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

◆ 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  )
inlinevirtual

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.

Definition at line 111 of file vtkAbstractCellLocator.h.

◆ GetLazyEvaluation()

virtual vtkTypeBool vtkAbstractCellLocator::GetLazyEvaluation ( )
inlinevirtual

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.

Definition at line 113 of file vtkAbstractCellLocator.h.

◆ LazyEvaluationOn()

virtual void vtkAbstractCellLocator::LazyEvaluationOn ( )
inlinevirtual

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.

Definition at line 115 of file vtkAbstractCellLocator.h.

◆ LazyEvaluationOff()

virtual void vtkAbstractCellLocator::LazyEvaluationOff ( )
inlinevirtual

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.

Definition at line 117 of file vtkAbstractCellLocator.h.

◆ IntersectWithLine() [1/6]

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.

◆ IntersectWithLine() [2/6]

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.

◆ IntersectWithLine() [3/6]

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

◆ IntersectWithLine() [4/6]

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

◆ IntersectWithLine() [5/6]

virtual int vtkAbstractCellLocator::IntersectWithLine ( const double  p1[3],
const double  p2[3],
const 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.

◆ IntersectWithLine() [6/6]

virtual int vtkAbstractCellLocator::IntersectWithLine ( const double  p1[3],
const double  p2[3],
const 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 in vtkModifiedBSPTree, vtkLinearTransformCellLocator, vtkStaticCellLocator, vtkCellTreeLocator, and vtkCellLocator.

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

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

THIS FUNCTION IS NOT THREAD SAFE.

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

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 in vtkLinearTransformCellLocator, vtkStaticCellLocator, and vtkCellLocator.

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

THIS FUNCTION IS NOT THREAD SAFE.

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

THIS FUNCTION IS THREAD SAFE.

◆ 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. 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 in vtkLinearTransformCellLocator, vtkStaticCellLocator, and vtkCellLocator.

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

Reimplemented in vtkLinearTransformCellLocator, vtkStaticCellLocator, vtkCellTreeLocator, and vtkCellLocator.

◆ FindCellsAlongLine()

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

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.

A vtkAbstractCellLocator subclass needs to implement IntersectWithLine that takes cells ids, which is used internally to implement FindCellsAlongLine.

THIS FUNCTION IS THREAD SAFE.

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

◆ FindCellsAlongPlane()

virtual void vtkAbstractCellLocator::FindCellsAlongPlane ( const double  o[3],
const double  n[3],
double  tolerance,
vtkIdList cells 
)
virtual

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.

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

THIS FUNCTION IS THREAD SAFE.

Reimplemented in vtkLinearTransformCellLocator, and vtkStaticCellLocator.

◆ FindCell() [1/3]

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.

◆ FindCell() [2/3]

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.

◆ FindCell() [3/3]

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.

◆ 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. This function should be used ONLY after the locator is built.

Reimplemented in vtkLinearTransformCellLocator, and vtkStaticCellLocator.

◆ ShallowCopy()

virtual void vtkAbstractCellLocator::ShallowCopy ( vtkAbstractCellLocator )
inlinevirtual

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

◆ UpdateInternalWeights()

void vtkAbstractCellLocator::UpdateInternalWeights ( )
protected

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

If need be, the internal Weights array size is updated to be able to host all points of the largest cell of the input data set.

◆ IsInBounds()

static bool vtkAbstractCellLocator::IsInBounds ( const double  bounds[6],
const double  x[3],
const double  tol = 0.0 
)
staticprotected

◆ GetCellBounds()

void vtkAbstractCellLocator::GetCellBounds ( vtkIdType  cellId,
double *&  cellBoundsPtr 
)
protected

Member Data Documentation

◆ NumberOfCellsPerNode

int vtkAbstractCellLocator::NumberOfCellsPerNode
protected

Definition at line 356 of file vtkAbstractCellLocator.h.

◆ RetainCellLists

vtkTypeBool vtkAbstractCellLocator::RetainCellLists
protected

Definition at line 357 of file vtkAbstractCellLocator.h.

◆ CacheCellBounds

vtkTypeBool vtkAbstractCellLocator::CacheCellBounds
protected

Definition at line 358 of file vtkAbstractCellLocator.h.

◆ GenericCell

vtkNew<vtkGenericCell> vtkAbstractCellLocator::GenericCell
protected

Definition at line 359 of file vtkAbstractCellLocator.h.

◆ CellBoundsSharedPtr

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

Definition at line 360 of file vtkAbstractCellLocator.h.

◆ CellBounds

double* vtkAbstractCellLocator::CellBounds
protected

Definition at line 361 of file vtkAbstractCellLocator.h.

◆ WeightsTime

vtkTimeStamp vtkAbstractCellLocator::WeightsTime
protected

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

Definition at line 366 of file vtkAbstractCellLocator.h.

◆ Weights

std::vector<double> vtkAbstractCellLocator::Weights
protected

This array is resized so that it can fit points from the cell hosting the most in the input data set.

Resizing is done in UpdateInternalWeights.

Note
This array needs resized in FindCell(double[3]).

Definition at line 382 of file vtkAbstractCellLocator.h.


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