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

#include <vtkIncrementalOctreePointLocator.h>

Inheritance diagram for vtkIncrementalOctreePointLocator:

Collaboration diagram for vtkIncrementalOctreePointLocator:

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.

Public Types inherited from vtkLocator
typedef vtkObject	Superclass
	Standard type and print methods.

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkIncrementalOctreePointLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

void	Initialize () override
	Delete the octree search structure.

void	FreeSearchStructure () override
	Delete the octree search structure.

void	GetBounds (double *bounds) override
	Get the spatial bounding box of the octree.

double *	GetBounds () override
	Get the spatial bounding box of the octree.

int	GetNumberOfPoints ()
	Get the number of points maintained by the octree.

virtual int	GetNumberOfNodes ()
	Get number of nodes in the tree.

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.

void	BuildLocator () override
	Load points from a dataset to construct an octree for point location.

void	ForceBuildLocator () override
	Build the locator from the input dataset (even if UseExistingSearchStructure is on).

vtkIdType	FindClosestPoint (const double x[3]) override
	Given a point x, return the id of the closest point.

virtual vtkIdType	FindClosestPoint (double x, double y, double z)
	Given a point (x, y, z), return the id of the closest point.

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

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

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

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

void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result) override
	Find all points within a radius R relative to a given point x.

void	FindPointsWithinSquaredRadius (double R2, const double x[3], vtkIdList *result)
	Find all points within a squared radius R2 relative to a given point x.

void	FindClosestNPoints (int N, const double x[3], vtkIdList *result) override
	Find the closest N points to a given point.

int	InitPointInsertion (vtkPoints *points, const double bounds[6]) override
	Initialize the point insertion process.

int	InitPointInsertion (vtkPoints *points, const double bounds[6], vtkIdType estSize) override
	Initialize the point insertion process.

vtkIdType	IsInsertedPoint (const double x[3]) override
	Determine whether or not a given point has been inserted into the octree.

vtkIdType	IsInsertedPoint (double x, double y, double z) override
	Determine whether or not a given point has been inserted into the octree.

int	InsertUniquePoint (const double point[3], vtkIdType &pntId) override
	Insert a point to the octree unless there has been a duplicate point.

void	InsertPoint (vtkIdType ptId, const double x[3]) override
	Insert a given point into the octree with a specified point index ptId.

vtkIdType	InsertNextPoint (const double x[3]) override
	Insert a given point into the octree and return the point index.

void	InsertPointWithoutChecking (const double point[3], vtkIdType &pntId, int insert)
	"Insert" a point to the octree without any checking.

vtkIncrementalOctreeNode *	GetRoot () const

int	GetNumberOfLevels ()
	Returns the maximum level of the tree.


virtual void	SetMaxPointsPerLeaf (int)
	Set/Get the maximum number of points that a leaf node may maintain.

virtual int	GetMaxPointsPerLeaf ()
	Set/Get the maximum number of points that a leaf node may maintain.


virtual void	SetBuildCubicOctree (vtkTypeBool)
	Set/Get whether the search octree is built as a cubic shape or not.

virtual vtkTypeBool	GetBuildCubicOctree ()
	Set/Get whether the search octree is built as a cubic shape or not.

virtual void	BuildCubicOctreeOn ()
	Set/Get whether the search octree is built as a cubic shape or not.

virtual void	BuildCubicOctreeOff ()
	Set/Get whether the search octree is built as a cubic shape or not.


virtual vtkPoints *	GetLocatorPoints ()
	Get access to the vtkPoints object in which point coordinates are stored for either point location or point insertion.


void	GenerateRepresentation (int level, vtkPolyData *polysData) override
	Create a polygonal representation of the octree 'level': for each node on the specified level we generate six faces for the bounding box of the node.

void	GenerateRepresentation (int level, vtkPolyData polysData, bool(UserGetBounds)(void data, vtkIncrementalOctreeNode node, double bounds), void data)
	Create a polygonal representation of the octree 'level': for each node on the specified level we generate six faces for the bounding box of the node.

Public Member Functions inherited from vtkIncrementalPointLocator
virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkIncrementalPointLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

virtual vtkIdType	FindClosestInsertedPoint (const double x[3])=0
	Given a point x assumed to be covered by the search structure, return the index of the closest point (already inserted to the search structure) regardless of the associated minimum squared distance relative to the squared insertion-tolerance distance.

virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6])=0
	Initialize the point insertion process.

virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6], vtkIdType estSize)=0
	Initialize the point insertion process.

virtual vtkIdType	IsInsertedPoint (double x, double y, double z)=0
	Determine whether or not a given point has been inserted.

virtual vtkIdType	IsInsertedPoint (const double x[3])=0
	Determine whether or not a given point has been inserted.

virtual int	InsertUniquePoint (const double x[3], vtkIdType &ptId)=0
	Insert a point unless there has been a duplicate in the search structure.

virtual void	InsertPoint (vtkIdType ptId, const double x[3])=0
	Insert a given point with a specified point index ptId.

virtual vtkIdType	InsertNextPoint (const double x[3])=0
	Insert a given point and return the point index.

Public Member Functions inherited from vtkAbstractPointLocator
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.

vtkIdType	FindClosestPoint (double x, double y, double z)
	Given a position x, return the id of the point closest to it.

void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
	Find the closest N points to a position.

void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
	Find all points within a specified radius R of position x.

virtual vtkIdType	GetNumberOfBuckets ()
	Return the total number of buckets in the locator.

vtkAbstractPointLocator *	NewInstance () const
	Standard type and print methods.

Public Member Functions inherited from vtkLocator
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed.

virtual void	Initialize ()
	Initialize locator.

virtual void	BuildLocator ()=0
	Build the locator from the input dataset.

virtual void	ForceBuildLocator ()
	Build the locator from the input dataset (even if UseExistingSearchStructure is on).

virtual void	FreeSearchStructure ()=0
	Free the memory required for the spatial data structure.

virtual void	GenerateRepresentation (int level, vtkPolyData *pd)=0
	Method to build a representation at a particular level.

virtual void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset.

virtual vtkDataSet *	GetDataSet ()
	Build the locator from the points/cells defining this dataset.

virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree.

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree.

virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true).

virtual void	SetAutomatic (vtkTypeBool)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual vtkTypeBool	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	SetTolerance (double)
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOn ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOff ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkMTimeType	GetBuildTime ()
	Return the time of the last data structure build.

bool	UsesGarbageCollector () const override
	Handle the PointSet <-> Locator loop.

vtkLocator *	NewInstance () const
	Standard type and print methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkIncrementalOctreePointLocator *	SafeDownCast (vtkObjectBase *o)

static vtkIncrementalOctreePointLocator *	New ()

Static Public Member Functions inherited from vtkIncrementalPointLocator
static vtkTypeBool	IsTypeOf (const char *type)

static vtkIncrementalPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractPointLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

Static Public Member Functions inherited from vtkLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

	vtkIncrementalOctreePointLocator ()

	~vtkIncrementalOctreePointLocator () override

Protected Member Functions inherited from vtkIncrementalPointLocator
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

	vtkIncrementalPointLocator ()

	~vtkIncrementalPointLocator () override

Protected Member Functions inherited from vtkAbstractPointLocator
	vtkAbstractPointLocator ()

	~vtkAbstractPointLocator () override

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

virtual void	BuildLocatorInternal ()
	This function is not pure virtual to maintain backwards compatibility.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkAbstractPointLocator
double	Bounds [6]

vtkIdType	NumberOfBuckets

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	UseExistingSearchStructure

vtkTypeBool	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

Online Examples:

IncrementalOctreePointLocator

Tests:: vtkIncrementalOctreePointLocator (Tests)

Definition at line 72 of file vtkIncrementalOctreePointLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkIncrementalPointLocator vtkIncrementalOctreePointLocator::Superclass

Definition at line 75 of file vtkIncrementalOctreePointLocator.h.

Constructor & Destructor Documentation

◆ vtkIncrementalOctreePointLocator()

vtkIncrementalOctreePointLocator::vtkIncrementalOctreePointLocator ( )

protected

◆ ~vtkIncrementalOctreePointLocator()

vtkIncrementalOctreePointLocator::~vtkIncrementalOctreePointLocator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Standard type and print methods.

Reimplemented from vtkIncrementalPointLocator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkIncrementalOctreePointLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkIncrementalPointLocator.

◆ NewInstance()

vtkIncrementalOctreePointLocator * vtkIncrementalOctreePointLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkIncrementalOctreePointLocator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ New()

static vtkIncrementalOctreePointLocator * vtkIncrementalOctreePointLocator::New ( )

static

◆ SetMaxPointsPerLeaf()

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.

◆ GetMaxPointsPerLeaf()

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.

◆ SetBuildCubicOctree()

virtual void vtkIncrementalOctreePointLocator::SetBuildCubicOctree ( vtkTypeBool )

virtual

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

◆ GetBuildCubicOctree()

virtual vtkTypeBool vtkIncrementalOctreePointLocator::GetBuildCubicOctree ( )

virtual

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

◆ BuildCubicOctreeOn()

virtual void vtkIncrementalOctreePointLocator::BuildCubicOctreeOn ( )

virtual

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

◆ BuildCubicOctreeOff()

virtual void vtkIncrementalOctreePointLocator::BuildCubicOctreeOff ( )

virtual

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

◆ GetLocatorPoints()

virtual vtkPoints * vtkIncrementalOctreePointLocator::GetLocatorPoints ( )

virtual

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

◆ Initialize()

void vtkIncrementalOctreePointLocator::Initialize ( )

inlineoverridevirtual

Delete the octree search structure.

Reimplemented from vtkLocator.

Definition at line 115 of file vtkIncrementalOctreePointLocator.h.

◆ FreeSearchStructure()

void vtkIncrementalOctreePointLocator::FreeSearchStructure ( )

overridevirtual

Delete the octree search structure.

Implements vtkLocator.

◆ GetBounds() [1/2]

void vtkIncrementalOctreePointLocator::GetBounds ( double * bounds )

overridevirtual

Get the spatial bounding box of the octree.

Reimplemented from vtkAbstractPointLocator.

◆ GetBounds() [2/2]

double * vtkIncrementalOctreePointLocator::GetBounds ( )

inlineoverridevirtual

Get the spatial bounding box of the octree.

Reimplemented from vtkAbstractPointLocator.

Definition at line 130 of file vtkIncrementalOctreePointLocator.h.

◆ GetNumberOfPoints()

int vtkIncrementalOctreePointLocator::GetNumberOfPoints ( )

Get the number of points maintained by the octree.

◆ GetNumberOfNodes()

virtual int vtkIncrementalOctreePointLocator::GetNumberOfNodes ( )

virtual

Get number of nodes in the tree.

◆ FindClosestInsertedPoint()

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.

◆ GenerateRepresentation() [1/2]

void vtkIncrementalOctreePointLocator::GenerateRepresentation	(	int	level,
		vtkPolyData *	polysData
	)

overridevirtual

Create a polygonal representation of the octree 'level': for each node on the specified level we generate six faces for the bounding box of the node.

We also include a cell attribute that specifies the Index of the node. The second version of this function, generates user defined boundaries provided by 'GetBounds'. This function takes as parameters a user defined opaque 'data', the current node, and a pointer to where to write the 'bounds'. The function returns true if we want to generate the representation for this node, and false otherwise. A user can store data associated with a node using the node index.

See also: vtkIncrementalOctreeNode::GetIndex

Implements vtkLocator.

◆ GenerateRepresentation() [2/2]

void vtkIncrementalOctreePointLocator::GenerateRepresentation	(	int	level,
		vtkPolyData *	polysData,
		bool()(void data, vtkIncrementalOctreeNode node, double bounds)	UserGetBounds,
		void *	data
	)

Create a polygonal representation of the octree 'level': for each node on the specified level we generate six faces for the bounding box of the node.

We also include a cell attribute that specifies the Index of the node. The second version of this function, generates user defined boundaries provided by 'GetBounds'. This function takes as parameters a user defined opaque 'data', the current node, and a pointer to where to write the 'bounds'. The function returns true if we want to generate the representation for this node, and false otherwise. A user can store data associated with a node using the node index.

See also: vtkIncrementalOctreeNode::GetIndex

◆ BuildLocator()

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. This will NOT do anything if UseExistingSearchStructure is on.

Implements vtkLocator.

◆ ForceBuildLocator()

void vtkIncrementalOctreePointLocator::ForceBuildLocator ( )

overridevirtual

Build the locator from the input dataset (even if UseExistingSearchStructure is on).

Reimplemented from vtkLocator.

◆ FindClosestPoint() [1/4]

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.

◆ FindClosestPoint() [2/4]

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.

◆ FindClosestPoint() [3/4]

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.

◆ FindClosestPoint() [4/4]

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.

◆ FindClosestPointWithinRadius()

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.

◆ FindClosestPointWithinSquaredRadius()

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.

◆ FindPointsWithinRadius()

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.

◆ FindPointsWithinSquaredRadius()

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.

◆ FindClosestNPoints()

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.

◆ InitPointInsertion() [1/2]

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.

◆ InitPointInsertion() [2/2]

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.

◆ IsInsertedPoint() [1/2]

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.

◆ IsInsertedPoint() [2/2]

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.

◆ InsertUniquePoint()

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

overridevirtual

Insert a point to the octree unless there has been a duplicate 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.

◆ InsertPoint()

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.

◆ InsertNextPoint()

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 involves a repeated leaf container location). vtkPoints::InsertNextPoint() is invoked.

Implements vtkIncrementalPointLocator.

◆ InsertPointWithoutChecking()

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.

◆ GetRoot()

vtkIncrementalOctreeNode * vtkIncrementalOctreePointLocator::GetRoot ( ) const

inline

Definition at line 345 of file vtkIncrementalOctreePointLocator.h.

◆ GetNumberOfLevels()

int vtkIncrementalOctreePointLocator::GetNumberOfLevels ( )

Returns the maximum level of the tree.

If a tree has one node it returns 1 else it returns the maximum level of its children plus 1.

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

Common/DataModel/vtkIncrementalOctreePointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkIncrementalOctreePointLocator()

◆ ~vtkIncrementalOctreePointLocator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetMaxPointsPerLeaf()

◆ GetMaxPointsPerLeaf()

◆ SetBuildCubicOctree()

◆ GetBuildCubicOctree()

◆ BuildCubicOctreeOn()

◆ BuildCubicOctreeOff()

◆ GetLocatorPoints()

◆ Initialize()

◆ FreeSearchStructure()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetNumberOfPoints()

◆ GetNumberOfNodes()

◆ FindClosestInsertedPoint()

◆ GenerateRepresentation() [1/2]

◆ GenerateRepresentation() [2/2]

◆ BuildLocator()

◆ ForceBuildLocator()

◆ FindClosestPoint() [1/4]

◆ FindClosestPoint() [2/4]

◆ FindClosestPoint() [3/4]

◆ FindClosestPoint() [4/4]

◆ FindClosestPointWithinRadius()

◆ FindClosestPointWithinSquaredRadius()

◆ FindPointsWithinRadius()

◆ FindPointsWithinSquaredRadius()

◆ FindClosestNPoints()

◆ InitPointInsertion() [1/2]

◆ InitPointInsertion() [2/2]

◆ IsInsertedPoint() [1/2]

◆ IsInsertedPoint() [2/2]

◆ InsertUniquePoint()

◆ InsertPoint()

◆ InsertNextPoint()

◆ InsertPointWithoutChecking()

◆ GetRoot()

◆ GetNumberOfLevels()