vtkIncrementalPointLocator - Abstract class in support of both point location and point insertion. More...

Inheritance diagram for Kitware.VTK.vtkIncrementalPointLocator:

Collaboration diagram for Kitware.VTK.vtkIncrementalPointLocator:

Public Member Functions
	vtkIncrementalPointLocator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int	FindClosestInsertedPoint (IntPtr x)
	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. This method is used when performing incremental point insertion. Note -1 indicates that no point is found. InitPointInsertion() should have been called in advance.
virtual int	InitPointInsertion (vtkPoints newPts, IntPtr bounds)
	Initialize the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.
virtual int	InitPointInsertion (vtkPoints newPts, IntPtr bounds, int estSize)
	Initialize the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.
override void	Initialize ()
	Delete the search structure.
virtual int	InsertNextPoint (IntPtr x)
	Insert a given point and return the point index. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.
virtual void	InsertPoint (int ptId, IntPtr x)
	Insert a given point with a specified point index ptId. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.
virtual int	InsertUniquePoint (IntPtr x, ref int ptId)
	Insert a point unless there has been a duplciate in the search structure. This method is not thread safe.
override int	IsA (string type)
	*Undocumented Block
virtual int	IsInsertedPoint (double x, double y, double z)
	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.
virtual int	IsInsertedPoint (IntPtr x)
	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.
new vtkIncrementalPointLocator	NewInstance ()
	*Undocumented Block
Public Member Functions inherited from Kitware.VTK.vtkAbstractPointLocator
	vtkAbstractPointLocator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
override void	BuildLocator ()
	See vtkLocator interface documentation. These methods are not thread safe.
virtual void	FindClosestNPoints (int N, IntPtr x, vtkIdList result)
	Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList result)
	Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
virtual int	FindClosestPoint (IntPtr x)
	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.
int	FindClosestPoint (double x, double y, double z)
	Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
virtual int	FindClosestPointWithinRadius (double radius, IntPtr x, ref double dist2)
	Given a position x and a radius r, return the id of the point closest to the point in that radius. dist2 returns the squared distance to the point.
virtual void	FindPointsWithinRadius (double R, IntPtr x, vtkIdList result)
	Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList result)
	Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.
override void	FreeSearchStructure ()
	See vtkLocator interface documentation. These methods are not thread safe.
override void	GenerateRepresentation (int level, vtkPolyData pd)
	See vtkLocator interface documentation. These methods are not thread safe.
virtual IntPtr	GetBounds ()
	Provide an accessor to the bounds.
virtual void	GetBounds (IntPtr arg0)
	Provide an accessor to the bounds.
Public Member Functions inherited from Kitware.VTK.vtkLocator
	vtkLocator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
override void	Register (vtkObjectBase o)
	Handle the PointSet <-> Locator loop.
virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the construction of the locator (found in the subclass).
virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the construction of the locator (found in the subclass).
virtual int	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the construction of the locator (found in the subclass).
virtual uint	GetBuildTime ()
	Return the time of the last data structure build.
virtual vtkDataSet	GetDataSet ()
	Build the locator from the points/cells defining this dataset.
virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true). The value of this ivar may change each time the locator is built. Initial value is 8.
virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
virtual int	GetMaxLevelMaxValue ()
	Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
virtual int	GetMaxLevelMinValue ()
	Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual double	GetToleranceMaxValue ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual double	GetToleranceMinValue ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual void	SetAutomatic (int _arg)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. If not set, there will be an explicit method to control the construction of the locator (found in the subclass).
virtual void	SetDataSet (vtkDataSet arg0)
	Build the locator from the points/cells defining this dataset.
virtual void	SetMaxLevel (int _arg)
	Set the maximum allowable level for the tree. If the Automatic ivar is off, this will be the target depth of the locator. Initial value is 8.
virtual void	SetTolerance (double _arg)
	Specify absolute tolerance (in world coordinates) for performing geometric operations.
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkIncrementalPointLocator	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkIncrementalPointLocator"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkAbstractPointLocator
Public Attributes inherited from Kitware.VTK.vtkLocator
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "26vtkIncrementalPointLocator"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkAbstractPointLocator
Static Public Attributes inherited from Kitware.VTK.vtkLocator
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkIncrementalPointLocator ()
	Automatically generated type registration mechanics.

Detailed Description

vtkIncrementalPointLocator - Abstract class in support of both point location and point insertion.

Description Compared to a static point locator for 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. There are two incremental point locators, i.e., vtkPointLocator and vtkIncrementalOctreePointLocator. As opposed to the uniform bin-based search structure (adopted in vtkPointLocator) with a fixed spatial resolution, an octree mechanism (employed in vtkIncrementalOctreePointlocator) resorts to 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 point insertion, particularly when handling a radically imbalanced layout of points as not uncommon in datasets defined on adaptive meshes. In other words, vtkIncrementalOctreePointLocator is an octree-based accelerated implementation of all functionalities of vtkPointLocator.

vtkLocator, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkMergePoints

Constructor & Destructor Documentation

static Kitware.VTK.vtkIncrementalPointLocator.vtkIncrementalPointLocator ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkIncrementalPointLocator.vtkIncrementalPointLocator	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Member Function Documentation

override void Kitware.VTK.vtkIncrementalPointLocator.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAbstractPointLocator.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkNonMergingPointLocator, Kitware.VTK.vtkPointLocator, and Kitware.VTK.vtkMergePoints.

virtual int Kitware.VTK.vtkIncrementalPointLocator.FindClosestInsertedPoint ( IntPtr x )

virtual

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. This method is used when performing incremental point insertion. Note -1 indicates that no point is found. InitPointInsertion() should have been called in advance.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

override void Kitware.VTK.vtkIncrementalPointLocator.Initialize ( )

virtual

Delete the search structure.

Reimplemented from Kitware.VTK.vtkLocator.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

virtual int Kitware.VTK.vtkIncrementalPointLocator.InitPointInsertion	(	vtkPoints	newPts,
		IntPtr	bounds
	)

virtual

Initialize the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

virtual int Kitware.VTK.vtkIncrementalPointLocator.InitPointInsertion	(	vtkPoints	newPts,
		IntPtr	bounds,
		int	estSize
	)

virtual

Initialize the point insertion process. newPts is an object, storing 3D point coordinates, to which incremental point insertion puts coordinates. It is created and provided by an external VTK class. Argument bounds represents the spatial bounding box, into which the points fall.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

virtual int Kitware.VTK.vtkIncrementalPointLocator.InsertNextPoint ( IntPtr x )

virtual

Insert a given point and return the point index. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

virtual void Kitware.VTK.vtkIncrementalPointLocator.InsertPoint	(	int	ptId,
		IntPtr	x
	)

virtual

Insert a given point with a specified point index ptId. InitPointInsertion() should have been called prior to this function. Also, IsInsertedPoint() should have been called in advance to ensure that the given point has not been inserted unless point duplication is allowed.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, and Kitware.VTK.vtkPointLocator.

virtual int Kitware.VTK.vtkIncrementalPointLocator.InsertUniquePoint	(	IntPtr	x,
		ref int	ptId
	)

virtual

Insert a point unless there has been a duplciate in the search structure. This method is not thread safe.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

override int Kitware.VTK.vtkIncrementalPointLocator.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPointLocator.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

virtual int Kitware.VTK.vtkIncrementalPointLocator.IsInsertedPoint	(	double	x,
		double	y,
		double	z
	)

virtual

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.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

virtual int Kitware.VTK.vtkIncrementalPointLocator.IsInsertedPoint ( IntPtr x )

virtual

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.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

static new int Kitware.VTK.vtkIncrementalPointLocator.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPointLocator.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

new vtkIncrementalPointLocator Kitware.VTK.vtkIncrementalPointLocator.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPointLocator.

Reimplemented in Kitware.VTK.vtkIncrementalOctreePointLocator, Kitware.VTK.vtkPointLocator, Kitware.VTK.vtkNonMergingPointLocator, and Kitware.VTK.vtkMergePoints.

static new vtkIncrementalPointLocator Kitware.VTK.vtkIncrementalPointLocator.SafeDownCast ( vtkObjectBase o )

static