VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkIncrementalOctreePointLocator Class Reference

Incremental octree in support of both point location and point insertion. More...

#include <vtkIncrementalOctreePointLocator.h>

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

Public Types

typedef vtkIncrementalPointLocator Superclass
 
- Public Types inherited from vtkIncrementalPointLocator
typedef vtkAbstractPointLocator Superclass
 
- Public Types inherited from vtkAbstractPointLocator
typedef vtkLocator Superclass
 Standard type and print methods. More...
 
- Public Types inherited from vtkLocator
typedef vtkObject Superclass
 Standard type and print methods. More...
 

Public Member Functions

virtual int IsA (const char *type)
 Standard type and print methods. More...
 
vtkIncrementalOctreePointLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods. More...
 
void Initialize () override
 Delete the octree search structure. More...
 
void FreeSearchStructure () override
 Delete the octree search structure. More...
 
void GetBounds (double *bounds) override
 Get the spatial bounding box of the octree. More...
 
doubleGetBounds () override
 Get the spatial bounding box of the octree. More...
 
int GetNumberOfPoints ()
 Get the number of points maintained by the octree. More...
 
vtkIdType FindClosestInsertedPoint (const double x[3]) override
 Given a point x assumed to be covered by the octree, return the index of the closest in-octree point regardless of the associated minimum squared distance relative to the squared insertion-tolerance distance. More...
 
void GenerateRepresentation (int nodeLevel, vtkPolyData *polysData) override
 Create a polygonal representation of the octree boundary (from the root node to a specified level). More...
 
void BuildLocator () override
 Load points from a dataset to construct an octree for point location. More...
 
vtkIdType FindClosestPoint (const double x[3]) override
 Given a point x, return the id of the closest point. More...
 
virtual vtkIdType FindClosestPoint (double x, double y, double z)
 Given a point (x, y, z), return the id of the closest point. More...
 
virtual vtkIdType FindClosestPoint (const double x[3], double *miniDist2)
 Given a point x, return the id of the closest point and the associated minimum squared distance (via miniDist2). More...
 
virtual vtkIdType FindClosestPoint (double x, double y, double z, double *miniDist2)
 Given a point (x, y, z), return the id of the closest point and the associated minimum squared distance (via miniDist2). More...
 
vtkIdType FindClosestPointWithinRadius (double radius, const double x[3], double &dist2) override
 Given a point x and a radius, return the id of the closest point within the radius and the associated minimum squared distance (via dist2, this returned distance is valid only if the point id is not -1). More...
 
vtkIdType FindClosestPointWithinSquaredRadius (double radius2, const double x[3], double &dist2)
 Given a point x and a squared radius radius2, return the id of the closest point within the radius and the associated minimum squared distance (via dist2, note this returned distance is valid only if the point id is not -1). More...
 
void FindPointsWithinRadius (double R, const double x[3], vtkIdList *result) override
 Find all points within a radius R relative to a given point x. More...
 
void FindPointsWithinSquaredRadius (double R2, const double x[3], vtkIdList *result)
 Find all points within a squared radius R2 relative to a given point x. More...
 
void FindClosestNPoints (int N, const double x[3], vtkIdList *result) override
 Find the closest N points to a given point. More...
 
int InitPointInsertion (vtkPoints *points, const double bounds[6]) override
 Initialize the point insertion process. More...
 
int InitPointInsertion (vtkPoints *points, const double bounds[6], vtkIdType estSize) override
 Initialize the point insertion process. More...
 
vtkIdType IsInsertedPoint (const double x[3]) override
 Determine whether or not a given point has been inserted into the octree. More...
 
vtkIdType IsInsertedPoint (double x, double y, double z) override
 Determine whether or not a given point has been inserted into the octree. More...
 
int InsertUniquePoint (const double point[3], vtkIdType &pntId) override
 Insert a point to the octree unless there has been a duplciate point. More...
 
void InsertPoint (vtkIdType ptId, const double x[3]) override
 Insert a given point into the octree with a specified point index ptId. More...
 
vtkIdType InsertNextPoint (const double x[3]) override
 Insert a given point into the octree and return the point index. More...
 
void InsertPointWithoutChecking (const double point[3], vtkIdType &pntId, int insert)
 "Insert" a point to the octree without any checking. More...
 
virtual void SetMaxPointsPerLeaf (int)
 Set/Get the maximum number of points that a leaf node may maintain. More...
 
virtual int GetMaxPointsPerLeaf ()
 Set/Get the maximum number of points that a leaf node may maintain. More...
 
virtual void SetBuildCubicOctree (int)
 Set/Get whether the search octree is built as a cubic shape or not. More...
 
virtual int GetBuildCubicOctree ()
 Set/Get whether the search octree is built as a cubic shape or not. More...
 
virtual void BuildCubicOctreeOn ()
 Set/Get whether the search octree is built as a cubic shape or not. More...
 
virtual void BuildCubicOctreeOff ()
 Set/Get whether the search octree is built as a cubic shape or not. More...
 
virtual vtkPointsGetLocatorPoints ()
 Get access to the vtkPoints object in which point coordinates are stored for either point location or point insertion. More...
 
- Public Member Functions inherited from vtkIncrementalPointLocator
vtkIncrementalPointLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods. More...
 
- Public Member Functions inherited from vtkAbstractPointLocator
vtkIdType FindClosestPoint (double x, double y, double z)
 Given a position x, return the id of the point closest to it. More...
 
void FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
 Find the closest N points to a position. 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 vtkIdType GetNumberOfBuckets ()
 Return the total number of buckets in the locator. More...
 
vtkAbstractPointLocatorNewInstance () const
 Standard type and print methods. 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 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 (int)
 Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More...
 
virtual int 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 int IsTypeOf (const char *type)
 
static vtkIncrementalOctreePointLocatorSafeDownCast (vtkObjectBase *o)
 
static vtkIncrementalOctreePointLocatorNew ()
 
- Static Public Member Functions inherited from vtkIncrementalPointLocator
static int IsTypeOf (const char *type)
 
static vtkIncrementalPointLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractPointLocator
static int IsTypeOf (const char *type)
 Standard type and print methods. More...
 
static vtkAbstractPointLocatorSafeDownCast (vtkObjectBase *o)
 Standard type and print methods. More...
 
- Static Public Member Functions inherited from vtkLocator
static int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 Standard type and print methods. More...
 
 vtkIncrementalOctreePointLocator ()
 
 ~vtkIncrementalOctreePointLocator () override
 
- Protected Member Functions inherited from vtkIncrementalPointLocator
 vtkIncrementalPointLocator ()
 
 ~vtkIncrementalPointLocator () override
 
- Protected Member Functions inherited from vtkAbstractPointLocator
 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkAbstractPointLocator
double Bounds [6]
 
vtkIdType NumberOfBuckets
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
int 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Incremental octree in support of both point location and point insertion.

As opposed to the uniform bin-based search structure (adopted in class vtkPointLocator) with a fixed spatial resolution, an octree mechanism employs a hierarchy of tree-like sub-division of the 3D data domain. Thus it enables data-aware multi-resolution and accordingly accelerated point location as well as insertion, particularly when handling a radically imbalanced layout of points as not uncommon in datasets defined on adaptive meshes. Compared to a static point locator supporting pure location functionalities through some search structure established from a fixed set of points, an incremental point locator allows for, in addition, point insertion capabilities, with the search structure maintaining a dynamically increasing number of points. Class vtkIncrementalOctreePointLocator is an octree-based accelerated implementation of the functionalities of the uniform bin-based incremental point locator vtkPointLocator. For point location, an octree is built by accessing a vtkDataSet, specifically a vtkPointSet. For point insertion, an empty octree is inited and then incrementally populated as points are inserted. Three increasingly complex point insertion modes, i.e., direct check-free insertion, zero tolerance insertion, and non-zero tolerance insertion, are supported. In fact, the octree used in the point location mode is actually constructed via direct check-free point insertion. This class also provides a polygonal representation of the octree boundary.

See also
vtkAbstractPointLocator, vtkIncrementalPointLocator, vtkPointLocator, vtkMergePoints
Tests:
vtkIncrementalOctreePointLocator (Tests)

Definition at line 63 of file vtkIncrementalOctreePointLocator.h.

Member Typedef Documentation

Definition at line 67 of file vtkIncrementalOctreePointLocator.h.

Constructor & Destructor Documentation

vtkIncrementalOctreePointLocator::vtkIncrementalOctreePointLocator ( )
protected
vtkIncrementalOctreePointLocator::~vtkIncrementalOctreePointLocator ( )
overrideprotected

Member Function Documentation

static int vtkIncrementalOctreePointLocator::IsTypeOf ( const char *  type)
static
virtual int vtkIncrementalOctreePointLocator::IsA ( const char *  type)
virtual

Standard type and print methods.

Reimplemented from vtkIncrementalPointLocator.

static vtkIncrementalOctreePointLocator* vtkIncrementalOctreePointLocator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkIncrementalOctreePointLocator::NewInstanceInternal ( ) const
protectedvirtual

Standard type and print methods.

Reimplemented from vtkIncrementalPointLocator.

vtkIncrementalOctreePointLocator* vtkIncrementalOctreePointLocator::NewInstance ( ) const
void vtkIncrementalOctreePointLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

static vtkIncrementalOctreePointLocator* vtkIncrementalOctreePointLocator::New ( )
static
virtual void vtkIncrementalOctreePointLocator::SetMaxPointsPerLeaf ( int  )
virtual

Set/Get the maximum number of points that a leaf node may maintain.

Note that the actual number of points maintained by a leaf node might exceed this threshold if there is a large number (equal to or greater than the threshold) of exactly duplicate points (with zero distance) to be inserted (e.g., to construct an octree for subsequent point location) in extreme cases. Respecting this threshold in such scenarios would cause endless node sub-division. Thus this threshold is broken, but only in case of such situations.

virtual int vtkIncrementalOctreePointLocator::GetMaxPointsPerLeaf ( )
virtual

Set/Get the maximum number of points that a leaf node may maintain.

Note that the actual number of points maintained by a leaf node might exceed this threshold if there is a large number (equal to or greater than the threshold) of exactly duplicate points (with zero distance) to be inserted (e.g., to construct an octree for subsequent point location) in extreme cases. Respecting this threshold in such scenarios would cause endless node sub-division. Thus this threshold is broken, but only in case of such situations.

virtual void vtkIncrementalOctreePointLocator::SetBuildCubicOctree ( int  )
virtual

Set/Get whether the search octree is built as a cubic shape or not.

virtual int vtkIncrementalOctreePointLocator::GetBuildCubicOctree ( )
virtual

Set/Get whether the search octree is built as a cubic shape or not.

virtual void vtkIncrementalOctreePointLocator::BuildCubicOctreeOn ( )
virtual

Set/Get whether the search octree is built as a cubic shape or not.

virtual void vtkIncrementalOctreePointLocator::BuildCubicOctreeOff ( )
virtual

Set/Get whether the search octree is built as a cubic shape or not.

virtual vtkPoints* vtkIncrementalOctreePointLocator::GetLocatorPoints ( )
virtual

Get access to the vtkPoints object in which point coordinates are stored for either point location or point insertion.

void vtkIncrementalOctreePointLocator::Initialize ( )
inlineoverridevirtual

Delete the octree search structure.

Reimplemented from vtkLocator.

Definition at line 107 of file vtkIncrementalOctreePointLocator.h.

void vtkIncrementalOctreePointLocator::FreeSearchStructure ( )
overridevirtual

Delete the octree search structure.

Implements vtkLocator.

void vtkIncrementalOctreePointLocator::GetBounds ( double bounds)
overridevirtual

Get the spatial bounding box of the octree.

Reimplemented from vtkAbstractPointLocator.

double* vtkIncrementalOctreePointLocator::GetBounds ( )
inlineoverridevirtual

Get the spatial bounding box of the octree.

Reimplemented from vtkAbstractPointLocator.

Definition at line 122 of file vtkIncrementalOctreePointLocator.h.

int vtkIncrementalOctreePointLocator::GetNumberOfPoints ( )

Get the number of points maintained by the octree.

vtkIdType vtkIncrementalOctreePointLocator::FindClosestInsertedPoint ( const double  x[3])
overridevirtual

Given a point x assumed to be covered by the octree, return the index of the closest in-octree point regardless of the associated minimum squared distance relative to the squared insertion-tolerance distance.

This method is used when performing incremental point insertion. Note -1 indicates that no point is found. InitPointInsertion() should have been called in advance.

Implements vtkIncrementalPointLocator.

void vtkIncrementalOctreePointLocator::GenerateRepresentation ( int  nodeLevel,
vtkPolyData polysData 
)
overridevirtual

Create a polygonal representation of the octree boundary (from the root node to a specified level).

Implements vtkLocator.

void vtkIncrementalOctreePointLocator::BuildLocator ( )
overridevirtual

Load points from a dataset to construct an octree for point location.

This function resorts to InitPointInsertion() to fulfill some of the work.

Implements vtkLocator.

vtkIdType vtkIncrementalOctreePointLocator::FindClosestPoint ( const double  x[3])
overridevirtual

Given a point x, return the id of the closest point.

BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual vtkIdType vtkIncrementalOctreePointLocator::FindClosestPoint ( double  x,
double  y,
double  z 
)
virtual

Given a point (x, y, z), return the id of the closest point.

Note that BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

virtual vtkIdType vtkIncrementalOctreePointLocator::FindClosestPoint ( const double  x[3],
double miniDist2 
)
virtual

Given a point x, return the id of the closest point and the associated minimum squared distance (via miniDist2).

Note BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

virtual vtkIdType vtkIncrementalOctreePointLocator::FindClosestPoint ( double  x,
double  y,
double  z,
double miniDist2 
)
virtual

Given a point (x, y, z), return the id of the closest point and the associated minimum squared distance (via miniDist2).

BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

vtkIdType vtkIncrementalOctreePointLocator::FindClosestPointWithinRadius ( double  radius,
const double  x[3],
double dist2 
)
overridevirtual

Given a point x and a radius, return the id of the closest point within the radius and the associated minimum squared distance (via dist2, this returned distance is valid only if the point id is not -1).

Note that BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

vtkIdType vtkIncrementalOctreePointLocator::FindClosestPointWithinSquaredRadius ( double  radius2,
const double  x[3],
double dist2 
)

Given a point x and a squared radius radius2, return the id of the closest point within the radius and the associated minimum squared distance (via dist2, note this returned distance is valid only if the point id is not -1).

BuildLocator() should have been called prior to this function.This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

void vtkIncrementalOctreePointLocator::FindPointsWithinRadius ( double  R,
const double  x[3],
vtkIdList result 
)
overridevirtual

Find all points within a radius R relative to a given point x.

The returned point ids (stored in result) are not sorted in any way. BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

void vtkIncrementalOctreePointLocator::FindPointsWithinSquaredRadius ( double  R2,
const double  x[3],
vtkIdList result 
)

Find all points within a squared radius R2 relative to a given point x.

The returned point ids (stored in result) are not sorted in any way. BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

void vtkIncrementalOctreePointLocator::FindClosestNPoints ( int  N,
const double  x[3],
vtkIdList result 
)
overridevirtual

Find the closest N points to a given point.

The returned point ids (via result) are sorted from closest to farthest. BuildLocator() should have been called prior to this function. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

int vtkIncrementalOctreePointLocator::InitPointInsertion ( vtkPoints points,
const double  bounds[6] 
)
overridevirtual

Initialize the point insertion process.

points is an object, storing 3D point coordinates, to which incremental point insertion put coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall. In fact, an adjusted version of the bounding box is used to build the octree to make sure no any point (to be inserted) falls outside the octree. This function is not thread safe.

Implements vtkIncrementalPointLocator.

int vtkIncrementalOctreePointLocator::InitPointInsertion ( vtkPoints points,
const double  bounds[6],
vtkIdType  estSize 
)
overridevirtual

Initialize the point insertion process.

points is an object, storing 3D point coordinates, to which incremental point insertion put coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall. In fact, an adjusted version of the bounding box is used to build the octree to make sure no any point (to be inserted) falls outside the octree. Argument estSize specifies the initial estimated size of the vtkPoints object. This function is not thread safe.

Implements vtkIncrementalPointLocator.

vtkIdType vtkIncrementalOctreePointLocator::IsInsertedPoint ( const double  x[3])
overridevirtual

Determine whether or not a given point has been inserted into the octree.

Return the id of the already inserted point if true, otherwise return -1. InitPointInsertion() should have been called in advance.

Implements vtkIncrementalPointLocator.

vtkIdType vtkIncrementalOctreePointLocator::IsInsertedPoint ( double  x,
double  y,
double  z 
)
overridevirtual

Determine whether or not a given point has been inserted into the octree.

Return the id of the already inserted point if true, otherwise return -1. InitPointInsertion() should have been called in advance.

Implements vtkIncrementalPointLocator.

int vtkIncrementalOctreePointLocator::InsertUniquePoint ( const double  point[3],
vtkIdType pntId 
)
overridevirtual

Insert a point to the octree unless there has been a duplciate point.

Whether the point is actually inserted (return 1) or not (return 0 upon a rejection by an existing duplicate), the index of the point (either new or the duplicate) is returned via pntId. Note that InitPointInsertion() should have been called prior to this function. vtkPoints::InsertNextPoint() is invoked. This method is not thread safe.

Implements vtkIncrementalPointLocator.

void vtkIncrementalOctreePointLocator::InsertPoint ( vtkIdType  ptId,
const double  x[3] 
)
overridevirtual

Insert a given point into the octree with a specified point index ptId.

InitPointInsertion() should have been called prior to this function. In addition, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed (Note that in this case, this function involves a repeated leaf container location). vtkPoints::InsertPoint() is invoked.

Implements vtkIncrementalPointLocator.

vtkIdType vtkIncrementalOctreePointLocator::InsertNextPoint ( const double  x[3])
overridevirtual

Insert a given point into the octree and return the point index.

Note that InitPointInsertion() should have been called prior to this function. In addition, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed (in this case, this function invovles a repeated leaf container location). vtkPoints::InsertNextPoint() is invoked.

Implements vtkIncrementalPointLocator.

void vtkIncrementalOctreePointLocator::InsertPointWithoutChecking ( const double  point[3],
vtkIdType pntId,
int  insert 
)

"Insert" a point to the octree without any checking.

Argument insert means whether vtkPoints::InsertNextPoint() upon 1 is called or the point itself is not inserted to the vtkPoints at all but instead only the point index is inserted to a vtkIdList upon 0. For case 0, the point index needs to be specified via pntId. For case 1, the actual point index is returned via pntId. InitPointInsertion() should have been called.


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