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

#include <vtkAbstractPointLocator.h>

Inheritance diagram for vtkAbstractPointLocator:

Collaboration diagram for vtkAbstractPointLocator:

Public Types
typedef vtkLocator	Superclass

Public Types inherited from vtkLocator
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractPointLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


virtual vtkIdType	FindClosestPoint (const double x[3])=0

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


virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)=0


virtual void	FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0

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


virtual void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0

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


virtual double *	GetBounds ()

virtual void	GetBounds (double *)


virtual void	FreeSearchStructure ()=0

virtual void	BuildLocator ()=0

virtual void	GenerateRepresentation (int level, vtkPolyData *pd)=0

Public Member Functions inherited from vtkLocator
vtkLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Update ()

virtual void	Initialize ()

virtual void	SetDataSet (vtkDataSet *)

virtual vtkDataSet *	GetDataSet ()

virtual void	SetMaxLevel (int)

virtual int	GetMaxLevel ()

virtual int	GetLevel ()

virtual void	SetAutomatic (int)

virtual int	GetAutomatic ()

virtual void	AutomaticOn ()

virtual void	AutomaticOff ()

virtual void	SetTolerance (double)

virtual double	GetTolerance ()

virtual unsigned long	GetBuildTime ()

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkLocator
static int	IsTypeOf (const char *type)

static vtkLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractPointLocator ()

virtual	~vtkAbstractPointLocator ()

Protected Member Functions inherited from vtkLocator
virtual void	ReportReferences (vtkGarbageCollector *)

	vtkLocator ()

	~vtkLocator ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Bounds [6]

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

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

abstract class to quickly locate points in 3-space

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

Tests:: vtkAbstractPointLocator (Tests)

Definition at line 37 of file vtkAbstractPointLocator.h.

Member Typedef Documentation

typedef vtkLocator vtkAbstractPointLocator::Superclass

Definition at line 40 of file vtkAbstractPointLocator.h.

Constructor & Destructor Documentation

vtkAbstractPointLocator::vtkAbstractPointLocator ( )

protected

virtual vtkAbstractPointLocator::~vtkAbstractPointLocator ( )

protectedvirtual

Member Function Documentation

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

static

virtual int vtkAbstractPointLocator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkLocator.

Reimplemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.

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

static

virtual vtkObjectBase* vtkAbstractPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkLocator.

Reimplemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.

vtkAbstractPointLocator* vtkAbstractPointLocator::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkKdTreePointLocator, and vtkMergePoints.

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

pure virtual

Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implemented in vtkIncrementalOctreePointLocator, vtkOctreePointLocator, vtkPointLocator, and vtkKdTreePointLocator.

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

Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

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

pure virtual

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

Implemented in vtkIncrementalOctreePointLocator, vtkOctreePointLocator, vtkPointLocator, and vtkKdTreePointLocator.

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

pure virtual

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

Implemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkOctreePointLocator, and vtkKdTreePointLocator.

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

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

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

pure virtual

Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implemented in vtkIncrementalOctreePointLocator, vtkPointLocator, vtkOctreePointLocator, and vtkKdTreePointLocator.

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

Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

virtual double* vtkAbstractPointLocator::GetBounds ( )

inlinevirtual

Provide an accessor to the bounds.

Reimplemented in vtkIncrementalOctreePointLocator, and vtkOctreePointLocator.

Definition at line 86 of file vtkAbstractPointLocator.h.

virtual void vtkAbstractPointLocator::GetBounds ( double * )

virtual

Provide an accessor to the bounds.

Reimplemented in vtkIncrementalOctreePointLocator, and vtkOctreePointLocator.

virtual void vtkAbstractPointLocator::FreeSearchStructure ( )

pure virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkLocator.

Implemented in vtkPointLocator, vtkOctreePointLocator, vtkIncrementalOctreePointLocator, and vtkKdTreePointLocator.

virtual void vtkAbstractPointLocator::BuildLocator ( )

pure virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkLocator.

Implemented in vtkPointLocator, vtkIncrementalOctreePointLocator, vtkOctreePointLocator, and vtkKdTreePointLocator.

virtual void vtkAbstractPointLocator::GenerateRepresentation	(	int	level,
		vtkPolyData *	pd
	)

pure virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkLocator.

Implemented in vtkPointLocator, vtkOctreePointLocator, vtkIncrementalOctreePointLocator, and vtkKdTreePointLocator.

Member Data Documentation

double vtkAbstractPointLocator::Bounds[6]

protected

Definition at line 102 of file vtkAbstractPointLocator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkAbstractPointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation