abstract base class for objects that accelerate spatial searches More...

#include <vtkLocator.h>

Inheritance diagram for vtkLocator:

Collaboration diagram for vtkLocator:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Update ()

virtual void	Initialize ()

virtual void	BuildLocator ()=0

virtual void	FreeSearchStructure ()=0

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


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

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

virtual void	ReportReferences (vtkGarbageCollector *)

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

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

	vtkLocator ()

	~vtkLocator ()

Detailed Description

abstract base class for objects that accelerate spatial searches

vtkLocator is an abstract base class for spatial search objects, or locators. The principle behind locators is that they divide 3-space into small pieces (or "buckets") that can be quickly found in response to queries like point location, line intersection, or object-object intersection.

The purpose of this base class is to provide ivars and methods shared by all locators. The GenerateRepresentation() is one such interesting method. This method works in conjunction with vtkLocatorFilter to create polygonal representations for the locator. For example, if the locator is an OBB tree (i.e., vtkOBBTree.h), then the representation is a set of one or more oriented bounding boxes, depending upon the specified level.

Locators typically work as follows. One or more "entities", such as points or cells, are inserted into the tree. These entities are associated with one or more buckets. Then, when performing geometric operations, the operations are performed first on the buckets, and then if the operation tests positive, then on the entities in the bucket. For example, during collision tests, the locators are collided first to identify intersecting buckets. If an intersection is found, more expensive operations are then carried out on the entities in the bucket.

To obtain good performance, locators are often organized in a tree structure. In such a structure, there are frequently multiple "levels" corresponding to different nodes in the tree. So the word level (in the context of the locator) can be used to specify a particular representation in the tree. For example, in an octree (which is a tree with 8 children), level 0 is the bounding box, or root octant, and level 1 consists of its eight children.

See also: vtkPointLocator vtkCellLocator vtkOBBTree vtkMergePoints

Definition at line 61 of file vtkLocator.h.

Member Typedef Documentation

typedef vtkObject vtkLocator::Superclass

Definition at line 64 of file vtkLocator.h.

Constructor & Destructor Documentation

vtkLocator::vtkLocator ( )

protected

Handle the PointSet <-> Locator loop.

vtkLocator::~vtkLocator ( )

protected

Handle the PointSet <-> Locator loop.

Member Function Documentation

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

static

virtual int vtkLocator::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 vtkObject.

Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkKdTree, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkCellLocator, vtkOctreePointLocator, vtkAbstractCellLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkAbstractPointLocator, vtkKdTreePointLocator, and vtkMergePoints.

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

static

virtual vtkObjectBase* vtkLocator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkModifiedBSPTree, vtkOBBTree, vtkKdTree, vtkIncrementalOctreePointLocator, vtkPointLocator, vtkIncrementalPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkCellLocator, vtkOctreePointLocator, vtkAbstractCellLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, vtkAbstractPointLocator, vtkKdTreePointLocator, and vtkMergePoints.

vtkLocator* vtkLocator::NewInstance ( ) const

void vtkLocator::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 vtkModifiedBSPTree, vtkOBBTree, vtkPointLocator, vtkPKdTree, vtkCellTreeLocator, vtkOctreePointLocator, vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.

virtual void vtkLocator::SetDataSet ( vtkDataSet * )

virtual

Build the locator from the points/cells defining this dataset.

Reimplemented in vtkKdTree.

virtual vtkDataSet* vtkLocator::GetDataSet ( )

virtual

Build the locator from the points/cells defining this dataset.

Reimplemented in vtkKdTree.

virtual void vtkLocator::SetMaxLevel ( int )

virtual

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 vtkLocator::GetMaxLevel ( )

virtual

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 vtkLocator::GetLevel ( )

virtual

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 void vtkLocator::SetAutomatic ( int )

virtual

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 vtkLocator::GetAutomatic ( )

virtual

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 vtkLocator::AutomaticOn ( )

virtual

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 vtkLocator::AutomaticOff ( )

virtual

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 vtkLocator::SetTolerance ( double )

virtual

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

virtual double vtkLocator::GetTolerance ( )

virtual

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

virtual void vtkLocator::Update ( )

virtual

Cause the locator to rebuild itself if it or its input dataset has changed.

virtual void vtkLocator::Initialize ( )

virtual

Initialize locator. Frees memory and resets object as appropriate.

Reimplemented in vtkPointLocator, vtkIncrementalOctreePointLocator, and vtkIncrementalPointLocator.

virtual void vtkLocator::BuildLocator ( )

pure virtual

Build the locator from the input dataset.

Implemented in vtkKdTree, vtkPointLocator, vtkModifiedBSPTree, vtkOBBTree, vtkCellLocator, vtkCellTreeLocator, vtkIncrementalOctreePointLocator, vtkOctreePointLocator, vtkAbstractPointLocator, vtkKdTreePointLocator, and vtkPKdTree.

virtual void vtkLocator::FreeSearchStructure ( )

pure virtual

Free the memory required for the spatial data structure.

Implemented in vtkKdTree, vtkPointLocator, vtkOBBTree, vtkModifiedBSPTree, vtkCellLocator, vtkOctreePointLocator, vtkCellTreeLocator, vtkIncrementalOctreePointLocator, vtkAbstractPointLocator, and vtkKdTreePointLocator.

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

pure virtual

Method to build a representation at a particular level. Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.

Implemented in vtkKdTree, vtkPointLocator, vtkOBBTree, vtkModifiedBSPTree, vtkCellLocator, vtkOctreePointLocator, vtkCellTreeLocator, vtkIncrementalOctreePointLocator, vtkAbstractPointLocator, and vtkKdTreePointLocator.

virtual unsigned long vtkLocator::GetBuildTime ( )

virtual

Return the time of the last data structure build.

virtual void vtkLocator::Register ( vtkObjectBase * o )

virtual

Handle the PointSet <-> Locator loop.

Reimplemented from vtkObjectBase.

virtual void vtkLocator::UnRegister ( vtkObjectBase * o )

virtual

Handle the PointSet <-> Locator loop.

Reimplemented from vtkObjectBase.

virtual void vtkLocator::ReportReferences ( vtkGarbageCollector * )

protectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

vtkDataSet* vtkLocator::DataSet

protected

Definition at line 138 of file vtkLocator.h.

int vtkLocator::Automatic

protected

Definition at line 139 of file vtkLocator.h.

double vtkLocator::Tolerance

protected

Definition at line 140 of file vtkLocator.h.

int vtkLocator::MaxLevel

protected

Definition at line 141 of file vtkLocator.h.

int vtkLocator::Level

protected

Definition at line 142 of file vtkLocator.h.

vtkTimeStamp vtkLocator::BuildTime

protected

Definition at line 144 of file vtkLocator.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/vtkLocator.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