VTK  9.1.20211115
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractPointLocator Class Referenceabstract

abstract class to quickly locate points in 3-space More...

#include <vtkAbstractPointLocator.h>

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

Public Member Functions

virtual vtkIdType FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)=0
 Given a position x and a radius r, return the id of the point closest to the point in that radius. More...
 
virtual vtkIdType FindClosestPoint (const double x[3])=0
 Given a position x, return the id of the point closest to it. More...
 
vtkIdType FindClosestPoint (double x, double y, double z)
 Given a position x, return the id of the point closest to it. More...
 
virtual void FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0
 Find the closest N points to a position. More...
 
void FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
 Find the closest N points to a position. More...
 
virtual void FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0
 Find all points within a specified radius R of position x. More...
 
void FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
 Find all points within a specified radius R of position x. More...
 
virtual double * GetBounds ()
 Provide an accessor to the bounds. More...
 
virtual void GetBounds (double *)
 Provide an accessor to the bounds. More...
 
virtual vtkIdType GetNumberOfBuckets ()
 Return the total number of buckets in the locator. 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 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 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
 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)
 
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...
 
- 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...
 
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...
 

Protected Member Functions

 vtkAbstractPointLocator ()
 
 ~vtkAbstractPointLocator () override
 
- 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 ()
 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 &)
 

Protected Attributes

double Bounds [6]
 
vtkIdType NumberOfBuckets
 
- 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
 
typedef vtkLocator Superclass
 Standard type and print methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard type and print methods. More...
 
static vtkAbstractPointLocatorSafeDownCast (vtkObjectBase *o)
 Standard type and print methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard type and print methods. More...
 
vtkAbstractPointLocatorNewInstance () const
 Standard type and print methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard type and print methods. More...
 

Additional Inherited Members

- Public Types inherited from vtkLocator
typedef vtkObject Superclass
 Standard type and print methods. More...
 
- 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...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

abstract class to quickly locate points in 3-space

vtkAbstractPointLocator is an abstract spatial search object to quickly locate points in 3D. vtkAbstractPointLocator works by dividing a specified region of space into "rectangular" buckets, and then keeping a list of points that lie in each bucket. Typical operation involves giving a position in 3D and finding the closest point. The points are provided from the specified dataset input.

See also
vtkPointLocator vtkStaticPointLocator vtkMergePoints

Definition at line 38 of file vtkAbstractPointLocator.h.

Member Typedef Documentation

◆ Superclass

Standard type and print methods.

Definition at line 45 of file vtkAbstractPointLocator.h.

Constructor & Destructor Documentation

◆ vtkAbstractPointLocator()

vtkAbstractPointLocator::vtkAbstractPointLocator ( )
protected

◆ ~vtkAbstractPointLocator()

vtkAbstractPointLocator::~vtkAbstractPointLocator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

Standard type and print methods.

◆ IsA()

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

◆ SafeDownCast()

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

Standard type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractPointLocator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractPointLocator* vtkAbstractPointLocator::NewInstance ( ) const

Standard type and print methods.

◆ PrintSelf()

void vtkAbstractPointLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ FindClosestPoint() [1/2]

virtual vtkIdType vtkAbstractPointLocator::FindClosestPoint ( const double  x[3])
pure virtual

Given a position x, return the id of the point closest to it.

Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, and vtkIncrementalOctreePointLocator.

◆ FindClosestPoint() [2/2]

vtkIdType vtkAbstractPointLocator::FindClosestPoint ( double  x,
double  y,
double  z 
)

Given a position x, return the id of the point closest to it.

Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

◆ FindClosestPointWithinRadius()

virtual vtkIdType vtkAbstractPointLocator::FindClosestPointWithinRadius ( double  radius,
const double  x[3],
double &  dist2 
)
pure virtual

Given a position x and a radius r, return the id of the point closest to the point in that radius.

dist2 returns the squared distance to the point.

Implemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, and vtkIncrementalOctreePointLocator.

◆ FindClosestNPoints() [1/2]

virtual void vtkAbstractPointLocator::FindClosestNPoints ( int  N,
const double  x[3],
vtkIdList result 
)
pure virtual

Find the closest N points to a position.

This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, vtkOctreePointLocator, vtkKdTreePointLocator, and vtkIncrementalOctreePointLocator.

◆ FindClosestNPoints() [2/2]

void vtkAbstractPointLocator::FindClosestNPoints ( int  N,
double  x,
double  y,
double  z,
vtkIdList result 
)

Find the closest N points to a position.

This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

◆ FindPointsWithinRadius() [1/2]

virtual void vtkAbstractPointLocator::FindPointsWithinRadius ( double  R,
const double  x[3],
vtkIdList result 
)
pure virtual

Find all points within a specified radius R of position x.

The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implemented in vtkOctreePointLocator, vtkStaticPointLocator2D, vtkStaticPointLocator, vtkPointLocator, vtkKdTreePointLocator, and vtkIncrementalOctreePointLocator.

◆ FindPointsWithinRadius() [2/2]

void vtkAbstractPointLocator::FindPointsWithinRadius ( double  R,
double  x,
double  y,
double  z,
vtkIdList result 
)

Find all points within a specified radius R of position x.

The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

◆ GetBounds() [1/2]

virtual double* vtkAbstractPointLocator::GetBounds ( )
inlinevirtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented in vtkStaticPointLocator2D, vtkStaticPointLocator, vtkOctreePointLocator, vtkIncrementalOctreePointLocator, vtkStaticPointLocator2D, and vtkStaticPointLocator.

Definition at line 96 of file vtkAbstractPointLocator.h.

◆ GetBounds() [2/2]

virtual void vtkAbstractPointLocator::GetBounds ( double *  )
virtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented in vtkStaticPointLocator2D, vtkOctreePointLocator, and vtkIncrementalOctreePointLocator.

◆ GetNumberOfBuckets()

virtual vtkIdType vtkAbstractPointLocator::GetNumberOfBuckets ( )
virtual

Return the total number of buckets in the locator.

This has meaning only after the locator is constructed.

Reimplemented in vtkSMPMergePoints.

Member Data Documentation

◆ Bounds

double vtkAbstractPointLocator::Bounds[6]
protected

Definition at line 112 of file vtkAbstractPointLocator.h.

◆ NumberOfBuckets

vtkIdType vtkAbstractPointLocator::NumberOfBuckets
protected

Definition at line 113 of file vtkAbstractPointLocator.h.


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