VTK
|
quickly locate points in 3-space More...
#include <vtkPointLocator.h>
Public Types | |
typedef vtkIncrementalPointLocator | Superclass |
Standard methods for type management and printing. More... | |
![]() | |
typedef vtkAbstractPointLocator | Superclass |
![]() | |
typedef vtkLocator | Superclass |
Standard type and print methods. More... | |
![]() | |
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... | |
vtkPointLocator * | NewInstance () 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 int * | GetDivisions () |
virtual void | GetDivisions (int data[3]) |
virtual void | SetNumberOfPointsPerBucket (int) |
Specify the average number of points in each bucket. More... | |
virtual int | GetNumberOfPointsPerBucket () |
vtkIdType | FindClosestPoint (const double x[3]) override |
Given a position x, return the id of the point closest to it. More... | |
vtkIdType | FindClosestPointWithinRadius (double radius, const double x[3], double &dist2) override |
Given a position x and a radius r, return the id of the point closest to the point in that radius. More... | |
virtual vtkIdType | FindClosestPointWithinRadius (double radius, const double x[3], double inputDataLength, double &dist2) |
int | InitPointInsertion (vtkPoints *newPts, const double bounds[6]) override |
Initialize the point insertion process. More... | |
int | InitPointInsertion (vtkPoints *newPts, const double bounds[6], vtkIdType estSize) override |
Initialize the point insertion process. More... | |
void | InsertPoint (vtkIdType ptId, const double x[3]) override |
Incrementally insert a point into search structure with a particular index value. More... | |
vtkIdType | InsertNextPoint (const double x[3]) override |
Incrementally insert a point into search structure. More... | |
vtkIdType | IsInsertedPoint (double x, double y, double z) override |
Determine whether point given by x[3] has been inserted into points list. More... | |
vtkIdType | IsInsertedPoint (const double x[3]) override |
Determine whether or not a given point has been inserted. More... | |
int | InsertUniquePoint (const double x[3], vtkIdType &ptId) override |
Determine whether point given by x[3] has been inserted into points list. More... | |
vtkIdType | FindClosestInsertedPoint (const double x[3]) override |
Given a position x, return the id of the point closest to it. More... | |
void | FindClosestNPoints (int N, const double x[3], vtkIdList *result) override |
Find the closest N points to a position. More... | |
virtual void | FindDistributedPoints (int N, const double x[3], vtkIdList *result, int M) |
Find the closest points to a position such that each octant of space around the position contains at least N points. More... | |
virtual void | FindDistributedPoints (int N, double x, double y, double z, vtkIdList *result, int M) |
void | FindPointsWithinRadius (double R, const double x[3], vtkIdList *result) override |
Find all points within a specified radius R of position x. More... | |
virtual vtkIdList * | GetPointsInBucket (const double x[3], int ijk[3]) |
Given a position x, return the list of points in the bucket that contains the point. More... | |
virtual vtkPoints * | GetPoints () |
Provide an accessor to the points. More... | |
void | Initialize () override |
See vtkLocator interface documentation. 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... | |
void | GenerateRepresentation (int level, vtkPolyData *pd) override |
Method to build a representation at a particular level. 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) |
![]() | |
vtkIncrementalPointLocator * | NewInstance () const |
![]() | |
vtkAbstractPointLocator * | NewInstance () const |
vtkIdType | FindClosestPoint (double x, double y, double z) |
void | FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result) |
void | FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result) |
virtual double * | GetBounds () |
Provide an accessor to the bounds. More... | |
virtual void | GetBounds (double *) |
virtual vtkIdType | GetNumberOfBuckets () |
Return the total number of buckets in the locator. More... | |
![]() | |
vtkLocator * | NewInstance () const |
virtual void | SetDataSet (vtkDataSet *) |
Build the locator from the points/cells defining this dataset. More... | |
virtual vtkDataSet * | GetDataSet () |
virtual void | SetMaxLevel (int) |
Set the maximum allowable level for the tree. More... | |
virtual int | GetMaxLevel () |
virtual int | GetLevel () |
Get the level of the locator (determined automatically if Automatic is true). More... | |
virtual void | SetAutomatic (vtkTypeBool) |
Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More... | |
virtual vtkTypeBool | GetAutomatic () |
virtual void | AutomaticOn () |
virtual void | AutomaticOff () |
virtual void | SetTolerance (double) |
Specify absolute tolerance (in world coordinates) for performing geometric operations. More... | |
virtual double | GetTolerance () |
virtual void | Update () |
Cause the locator to rebuild itself if it or its input dataset has changed. More... | |
virtual 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... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
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 vtkPointLocator * | New () |
Construct with automatic computation of divisions, averaging 25 points per bucket. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkPointLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkIncrementalPointLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractPointLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkPointLocator () | |
~vtkPointLocator () override | |
void | GetBucketNeighbors (vtkNeighborPoints *buckets, const int ijk[3], const int ndivs[3], int level) |
void | GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], const int ijk[3], double dist, int level) |
void | GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3]) |
void | GenerateFace (int face, int i, int j, int k, vtkPoints *pts, vtkCellArray *polys) |
double | Distance2ToBucket (const double x[3], const int nei[3]) |
double | Distance2ToBounds (const double x[3], const double bounds[6]) |
void | GetBucketIndices (const double *x, int ijk[3]) const |
vtkIdType | GetBucketIndex (const double *x) const |
void | ComputePerformanceFactors () |
![]() | |
vtkIncrementalPointLocator () | |
~vtkIncrementalPointLocator () override | |
![]() | |
vtkAbstractPointLocator () | |
~vtkAbstractPointLocator () override | |
![]() | |
vtkLocator () | |
~vtkLocator () override | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkPoints * | Points |
int | Divisions [3] |
int | NumberOfPointsPerBucket |
vtkIdList ** | HashTable |
double | H [3] |
double | InsertionTol2 |
vtkIdType | InsertionPointId |
double | InsertionLevel |
double | HX |
double | HY |
double | HZ |
double | FX |
double | FY |
double | FZ |
double | BX |
double | BY |
double | BZ |
vtkIdType | XD |
vtkIdType | YD |
vtkIdType | ZD |
vtkIdType | SliceSize |
![]() | |
double | Bounds [6] |
vtkIdType | NumberOfBuckets |
![]() | |
vtkDataSet * | DataSet |
vtkTypeBool | Automatic |
double | Tolerance |
int | MaxLevel |
int | Level |
vtkTimeStamp | BuildTime |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
quickly locate points in 3-space
vtkPointLocator is a spatial search object to quickly locate points in 3D. vtkPointLocator works by dividing a specified region of space into a regular array of "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.
vtkPointLocator has two distinct methods of interaction. In the first method, you supply it with a dataset, and it operates on the points in the dataset. In the second method, you supply it with an array of points, and the object operates on the array.
Definition at line 53 of file vtkPointLocator.h.
Standard methods for type management and printing.
Definition at line 66 of file vtkPointLocator.h.
|
protected |
|
overrideprotected |
|
static |
Construct with automatic computation of divisions, averaging 25 points per bucket.
|
static |
|
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 vtkIncrementalPointLocator.
Reimplemented in vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.
|
static |
|
protectedvirtual |
Reimplemented from vtkIncrementalPointLocator.
Reimplemented in vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.
vtkPointLocator* vtkPointLocator::NewInstance | ( | ) | const |
|
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 vtkIncrementalPointLocator.
Reimplemented in vtkSMPMergePoints.
Set the number of divisions in x-y-z directions.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Specify the average number of points in each bucket.
|
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.
Implements vtkAbstractPointLocator.
|
overridevirtual |
Given a position x and a radius r, return the id of the point closest to the point in that radius.
These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first. dist2 returns the squared distance to the point.
Implements vtkAbstractPointLocator.
|
virtual |
|
overridevirtual |
Initialize the point insertion process.
The newPts is an object representing point coordinates into which incremental insertion methods place their data. Bounds are the box that the points lie in. Not thread safe.
Implements vtkIncrementalPointLocator.
|
overridevirtual |
Initialize the point insertion process.
The newPts is an object representing point coordinates into which incremental insertion methods place their data. Bounds are the box that the points lie in. Not thread safe.
Implements vtkIncrementalPointLocator.
Incrementally insert a point into search structure with a particular index value.
You should use the method IsInsertedPoint() to see whether this point has already been inserted (that is, if you desire to prevent duplicate points). Before using this method you must make sure that newPts have been supplied, the bounds has been set properly, and that divs are properly set. (See InitPointInsertion().) Not thread safe.
Implements vtkIncrementalPointLocator.
Incrementally insert a point into search structure.
The method returns the insertion location (i.e., point id). You should use the method IsInsertedPoint() to see whether this point has already been inserted (that is, if you desire to prevent duplicate points). Before using this method you must make sure that newPts have been supplied, the bounds has been set properly, and that divs are properly set. (See InitPointInsertion().) Not thread safe.
Implements vtkIncrementalPointLocator.
Determine whether point given by x[3] has been inserted into points list.
Return id of previously inserted point if this is true, otherwise return -1. This method is thread safe.
Implements vtkIncrementalPointLocator.
Definition at line 159 of file vtkPointLocator.h.
Determine whether or not a given point has been inserted.
Return the id of the already inserted point if true, else return -1. InitPointInsertion() should have been called in advance.
Implements vtkIncrementalPointLocator.
Determine whether point given by x[3] has been inserted into points list.
Return 0 if point was already in the list, otherwise return 1. If the point was not in the list, it will be ADDED. In either case, the id of the point (newly inserted or not) is returned in the ptId argument. Note this combines the functionality of IsInsertedPoint() followed by a call to InsertNextPoint(). This method is not thread safe.
Implements vtkIncrementalPointLocator.
Given a position x, return the id of the point closest to it.
This method is used when performing incremental point insertion. Note that -1 indicates that no point was found. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.
Implements vtkIncrementalPointLocator.
|
overridevirtual |
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.
Implements vtkAbstractPointLocator.
|
virtual |
Find the closest points to a position such that each octant of space around the position contains at least N points.
Loosely limit the search to a maximum number of points evaluated, M. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
|
virtual |
|
overridevirtual |
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.
Implements vtkAbstractPointLocator.
Given a position x, return the list of points in the bucket that contains the point.
It is possible that nullptr is returned. The user provides an ijk array that is the indices into the locator. This method is thread safe.
|
virtual |
Provide an accessor to the points.
|
overridevirtual |
See vtkLocator interface documentation.
These methods are not thread safe.
Reimplemented from vtkLocator.
|
overridevirtual |
Free the memory required for the spatial data structure.
Implements vtkLocator.
|
overridevirtual |
Build the locator from the input dataset.
Implements vtkLocator.
|
overridevirtual |
Method to build a representation at a particular level.
Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.
Implements vtkLocator.
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 282 of file vtkPointLocator.h.
Definition at line 294 of file vtkPointLocator.h.
|
protected |
virtual vtkIdType vtkAbstractPointLocator::FindClosestPoint |
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.
vtkIdType vtkAbstractPointLocator::FindClosestPoint |
|
protected |
Definition at line 267 of file vtkPointLocator.h.
|
protected |
Definition at line 268 of file vtkPointLocator.h.
|
protected |
Definition at line 269 of file vtkPointLocator.h.
|
protected |
Definition at line 270 of file vtkPointLocator.h.
|
protected |
Definition at line 271 of file vtkPointLocator.h.
|
protected |
Definition at line 273 of file vtkPointLocator.h.
|
protected |
Definition at line 274 of file vtkPointLocator.h.
|
protected |
Definition at line 275 of file vtkPointLocator.h.
|
protected |
Definition at line 278 of file vtkPointLocator.h.
|
protected |
Definition at line 278 of file vtkPointLocator.h.
|
protected |
Definition at line 278 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 279 of file vtkPointLocator.h.
|
protected |
Definition at line 280 of file vtkPointLocator.h.
|
protected |
Definition at line 280 of file vtkPointLocator.h.
|
protected |
Definition at line 280 of file vtkPointLocator.h.
|
protected |
Definition at line 280 of file vtkPointLocator.h.