VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkStaticCellLocator Class Reference

perform fast cell location operations More...

#include <vtkStaticCellLocator.h>

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

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...
 
vtkStaticCellLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetDivisions (int, int, int)
 Set the number of divisions in x-y-z directions. More...
 
virtual void SetDivisions (int[3])
 
virtual intGetDivisions ()
 
virtual void GetDivisions (int data[3])
 
vtkIdType FindCell (double pos[3], double vtkNotUsed, vtkGenericCell *cell, double pcoords[3], double *weights) override
 Test a point to find if it is inside a cell. More...
 
vtkIdType FindCell (double x[3]) override
 Reimplemented from vtkAbstractCellLocator to support bad compilers. 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 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...
 
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...
 
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...
 
int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
 Reimplemented from vtkAbstractCellLocator to support bad compilers. More...
 
int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId) override
 Reimplemented from vtkAbstractCellLocator to support bad compilers. More...
 
int IntersectWithLine (const double p1[3], const double p2[3], vtkPoints *points, vtkIdList *cellIds) override
 Reimplemented from vtkAbstractCellLocator to support bad compilers. More...
 
void GenerateRepresentation (int level, vtkPolyData *pd) override
 Satisfy vtkLocator abstract interface. More...
 
void FreeSearchStructure () override
 Free the memory required for the spatial data structure. More...
 
void BuildLocator () override
 Build the locator from the input dataset. More...
 
virtual void SetMaxNumberOfBuckets (vtkIdType)
 Set the maximum number of buckets in the locator. More...
 
virtual vtkIdType GetMaxNumberOfBuckets ()
 
bool GetLargeIds ()
 Inform the user as to whether large ids are being used. 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...
 
- Public Member Functions inherited from vtkAbstractCellLocator
vtkAbstractCellLocatorNewInstance () 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 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 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
vtkLocatorNewInstance () const
 
virtual void SetDataSet (vtkDataSet *)
 Build the locator from the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 
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)
 
vtkCommandGetCommand (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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkStaticCellLocatorNew ()
 Standard methods to instantiate, print and obtain type-related information. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStaticCellLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractCellLocator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractCellLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLocator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLocatorSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStaticCellLocator ()
 
 ~vtkStaticCellLocator () override
 
- 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Bounds [6]
 
int Divisions [3]
 
double H [3]
 
vtkIdType MaxNumberOfBuckets
 
bool LargeIds
 
vtkCellBinnerBinner
 
vtkCellProcessorProcessor
 
unsigned char * CellHasBeenVisited
 
unsigned char QueryNumber
 
- Protected Attributes inherited from vtkAbstractCellLocator
int NumberOfCellsPerNode
 
vtkTypeBool RetainCellLists
 
vtkTypeBool CacheCellBounds
 
vtkTypeBool LazyEvaluation
 
vtkTypeBool UseExistingSearchStructure
 
vtkGenericCellGenericCell
 
double(* CellBounds )[6]
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
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
 

Friends

struct vtkCellBinner
 
struct vtkCellProcessor
 

Detailed Description

perform fast cell location operations

vtkStaticCellLocator is a type of vtkAbstractCellLocator that accelerates certain operations when performing spatial operations on cells. These operations include finding a point that contains a cell, and intersecting cells with a line.

vtkStaticCellLocator is an accelerated version of vtkCellLocator. It is threaded (via vtkSMPTools), and supports one-time static construction (i.e., incremental cell insertion is not supported).

Warning
This class is templated. It may run slower than serial execution if the code is not optimized during compilation. Build in Release or ReleaseWithDebugInfo.
This class always caches cell bounds.
See also
vtkLocator vakAbstractCellLocator vtkCellLocator vtkCellTreeLocator vtkModifiedBSPTree

Definition at line 52 of file vtkStaticCellLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 62 of file vtkStaticCellLocator.h.

Constructor & Destructor Documentation

◆ vtkStaticCellLocator()

vtkStaticCellLocator::vtkStaticCellLocator ( )
protected

◆ ~vtkStaticCellLocator()

vtkStaticCellLocator::~vtkStaticCellLocator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkStaticCellLocator* vtkStaticCellLocator::New ( )
static

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

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkStaticCellLocator::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 vtkStaticCellLocator* vtkStaticCellLocator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStaticCellLocator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractCellLocator.

◆ NewInstance()

vtkStaticCellLocator* vtkStaticCellLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkStaticCellLocator::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.

◆ SetDivisions() [1/2]

virtual void vtkStaticCellLocator::SetDivisions ( int  ,
int  ,
int   
)
virtual

Set the number of divisions in x-y-z directions.

If the Automatic data member is enabled, the Divisions are set according to the NumberOfCellsPerNode and MaxNumberOfBuckets data members. The number of divisions must be >= 1 in each direction.

◆ SetDivisions() [2/2]

virtual void vtkStaticCellLocator::SetDivisions ( int  [3])
virtual

◆ GetDivisions() [1/2]

virtual int* vtkStaticCellLocator::GetDivisions ( )
virtual

◆ GetDivisions() [2/2]

virtual void vtkStaticCellLocator::GetDivisions ( int  data[3])
virtual

◆ FindCell() [1/2]

vtkIdType vtkStaticCellLocator::FindCell ( double  pos[3],
double  vtkNotUsed,
vtkGenericCell cell,
double  pcoords[3],
double weights 
)
overridevirtual

Test a point to find if it is inside a cell.

Returns the cellId if inside or -1 if not.

Reimplemented from vtkAbstractCellLocator.

◆ FindCell() [2/2]

vtkIdType vtkStaticCellLocator::FindCell ( double  x[3])
inlineoverridevirtual

Reimplemented from vtkAbstractCellLocator to support bad compilers.

Reimplemented from vtkAbstractCellLocator.

Definition at line 90 of file vtkStaticCellLocator.h.

◆ FindCellsWithinBounds()

void vtkStaticCellLocator::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 vtkStaticCellLocator::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 cell list to populate. This method returns data only after the locator has been built.

Reimplemented from vtkAbstractCellLocator.

◆ FindCellsAlongPlane()

void vtkStaticCellLocator::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.

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.

◆ FindClosestPoint() [1/3]

void vtkStaticCellLocator::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.

Reimplemented from vtkAbstractCellLocator.

◆ FindClosestPointWithinRadius() [1/4]

vtkIdType vtkStaticCellLocator::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).

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [1/4]

int vtkStaticCellLocator::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.

Reimplemented from vtkAbstractCellLocator.

◆ IntersectWithLine() [2/4]

int vtkStaticCellLocator::IntersectWithLine ( const double  p1[3],
const double  p2[3],
double  tol,
double t,
double  x[3],
double  pcoords[3],
int subId 
)
inlineoverridevirtual

Reimplemented from vtkAbstractCellLocator to support bad compilers.

Reimplemented from vtkAbstractCellLocator.

Definition at line 169 of file vtkStaticCellLocator.h.

◆ IntersectWithLine() [3/4]

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

Reimplemented from vtkAbstractCellLocator to support bad compilers.

Reimplemented from vtkAbstractCellLocator.

Definition at line 178 of file vtkStaticCellLocator.h.

◆ IntersectWithLine() [4/4]

int vtkStaticCellLocator::IntersectWithLine ( const double  p1[3],
const double  p2[3],
vtkPoints points,
vtkIdList cellIds 
)
inlineoverridevirtual

Reimplemented from vtkAbstractCellLocator to support bad compilers.

Reimplemented from vtkAbstractCellLocator.

Definition at line 188 of file vtkStaticCellLocator.h.

◆ GenerateRepresentation()

void vtkStaticCellLocator::GenerateRepresentation ( int  level,
vtkPolyData pd 
)
overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ FreeSearchStructure()

void vtkStaticCellLocator::FreeSearchStructure ( )
overridevirtual

Free the memory required for the spatial data structure.

Implements vtkLocator.

◆ BuildLocator()

void vtkStaticCellLocator::BuildLocator ( )
overridevirtual

Build the locator from the input dataset.

Implements vtkLocator.

◆ SetMaxNumberOfBuckets()

virtual void vtkStaticCellLocator::SetMaxNumberOfBuckets ( vtkIdType  )
virtual

Set the maximum number of buckets in the locator.

By default the value is set to VTK_INT_MAX. Note that there are significant performance implications at work here. If the number of buckets is set very large (meaning > VTK_INT_MAX) then internal sorting may be performed using 64-bit integers (which is much slower than using a 32-bit int). Of course, memory requirements may dramatically increase as well. It is recommended that the default value be used; but for extremely large data it may be desired to create a locator with an exceptionally large number of buckets. Note also that during initialization of the locator if the MaxNumberOfBuckets threshold is exceeded, the Divisions are scaled down in such a way as not to exceed the MaxNumberOfBuckets proportionally to the size of the bounding box in the x-y-z directions.

◆ GetMaxNumberOfBuckets()

virtual vtkIdType vtkStaticCellLocator::GetMaxNumberOfBuckets ( )
virtual

◆ GetLargeIds()

bool vtkStaticCellLocator::GetLargeIds ( )
inline

Inform the user as to whether large ids are being used.

This flag only has meaning after the locator has been built. Large ids are used when the number of binned points, or the number of bins, is >= the maximum number of buckets (specified by the user). Note that LargeIds are only available on 64-bit architectures.

Definition at line 229 of file vtkStaticCellLocator.h.

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

Friends And Related Function Documentation

◆ vtkCellBinner

friend struct vtkCellBinner
friend

Definition at line 54 of file vtkStaticCellLocator.h.

◆ vtkCellProcessor

friend struct vtkCellProcessor
friend

Definition at line 55 of file vtkStaticCellLocator.h.

Member Data Documentation

◆ Bounds

double vtkStaticCellLocator::Bounds[6]
protected

Definition at line 235 of file vtkStaticCellLocator.h.

◆ Divisions

int vtkStaticCellLocator::Divisions[3]
protected

Definition at line 236 of file vtkStaticCellLocator.h.

◆ H

double vtkStaticCellLocator::H[3]
protected

Definition at line 237 of file vtkStaticCellLocator.h.

◆ MaxNumberOfBuckets

vtkIdType vtkStaticCellLocator::MaxNumberOfBuckets
protected

Definition at line 239 of file vtkStaticCellLocator.h.

◆ LargeIds

bool vtkStaticCellLocator::LargeIds
protected

Definition at line 240 of file vtkStaticCellLocator.h.

◆ Binner

vtkCellBinner* vtkStaticCellLocator::Binner
protected

Definition at line 243 of file vtkStaticCellLocator.h.

◆ Processor

vtkCellProcessor* vtkStaticCellLocator::Processor
protected

Definition at line 244 of file vtkStaticCellLocator.h.

◆ CellHasBeenVisited

unsigned char* vtkStaticCellLocator::CellHasBeenVisited
protected

Definition at line 247 of file vtkStaticCellLocator.h.

◆ QueryNumber

unsigned char vtkStaticCellLocator::QueryNumber
protected

Definition at line 248 of file vtkStaticCellLocator.h.


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