This class implements the data structures, construction algorithms for fast cell location presented in "Fast, Memory-Efficient Cell location in Unstructured Grids for Visualization" by Christop Garth and Kenneth I. More...

#include <vtkCellTreeLocator.h>

Inheritance diagram for vtkCellTreeLocator:

[legend]

Collaboration diagram for vtkCellTreeLocator:

[legend]

Classes
class	vtkCellTree
	Internal classes made public to allow subclasses to create customized some traversal algorithms. More...

class	vtkCellTreeNode
	This class is the basic building block of the cell tree. More...

Public Types
typedef vtkAbstractCellLocator	Superclass

Public Types inherited from vtkAbstractCellLocator
typedef vtkLocator	Superclass

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

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

vtkCellTreeLocator *	NewInstance () const

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

vtkIdType	FindCell (double pos[3], double vtkNotUsed, vtkGenericCell cell, double pcoords[3], double weights) override
	Test a point to find if it is inside a cell. More...

int	IntersectWithLine (const double a0[3], const double a1[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell) override
	Return intersection point (if any) AND the cell which was intersected by the finite line. More...

void	FindCellsWithinBounds (double bbox, vtkIdList cells) override
	Return a list of unique cell ids inside of a given bounding box. More...

int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
	reimplemented from vtkAbstractCellLocator to support bad compilers More...

int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId) override
	Return intersection point (if any) AND the cell which was intersected by the finite line. More...

int	IntersectWithLine (const double p1[3], const double p2[3], vtkPoints points, vtkIdList cellIds) override
	reimplemented from vtkAbstractCellLocator to support bad compilers More...

vtkIdType	FindCell (double x[3]) override
	reimplemented from vtkAbstractCellLocator to support bad compilers More...


void	FreeSearchStructure () override
	Satisfy vtkLocator abstract interface. More...

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Satisfy vtkLocator abstract interface. More...

virtual void	BuildLocatorInternal ()
	Satisfy vtkLocator abstract interface. More...

virtual void	BuildLocatorIfNeeded ()
	Satisfy vtkLocator abstract interface. More...

virtual void	ForceBuildLocator ()
	Satisfy vtkLocator abstract interface. More...

void	BuildLocator () override
	Satisfy vtkLocator abstract interface. More...

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

virtual void	FindClosestPoint (const double x[3], double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point and the cell which is closest to the point x. More...

virtual void	FindClosestPoint (const double x[3], double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point and the cell which is closest to the point x. More...

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point within a specified radius and the cell which is closest to the point x. More...

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2)
	Return the closest point within a specified radius and the cell which is closest to the point x. More...

virtual vtkIdType	FindClosestPointWithinRadius (double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside)
	Return the closest point within a specified radius and the cell which is closest to the point x. More...

virtual void	FindCellsAlongLine (const double p1[3], const double p2[3], double tolerance, vtkIdList *cells)
	Given a finite line defined by the two points (p1,p2), return the list of unique cell ids in the buckets containing the line. More...

virtual bool	InsideCellBounds (double x[3], vtkIdType cell_ID)
	Quickly test if a point is inside the bounds of a particular cell. More...

virtual void	SetNumberOfCellsPerNode (int)
	Specify the preferred/maximum number of cells in each node/bucket. More...

virtual int	GetNumberOfCellsPerNode ()
	Specify the preferred/maximum number of cells in each node/bucket. More...

virtual void	SetCacheCellBounds (vtkTypeBool)
	Boolean controls whether the bounds of each cell are computed only once and then saved. More...

virtual vtkTypeBool	GetCacheCellBounds ()
	Boolean controls whether the bounds of each cell are computed only once and then saved. More...

virtual void	CacheCellBoundsOn ()
	Boolean controls whether the bounds of each cell are computed only once and then saved. More...

virtual void	CacheCellBoundsOff ()
	Boolean controls whether the bounds of each cell are computed only once and then saved. More...

virtual void	SetRetainCellLists (vtkTypeBool)
	Boolean controls whether to maintain list of cells in each node. More...

virtual vtkTypeBool	GetRetainCellLists ()
	Boolean controls whether to maintain list of cells in each node. More...

virtual void	RetainCellListsOn ()
	Boolean controls whether to maintain list of cells in each node. More...

virtual void	RetainCellListsOff ()
	Boolean controls whether to maintain list of cells in each node. More...

virtual void	SetLazyEvaluation (vtkTypeBool)
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...

virtual vtkTypeBool	GetLazyEvaluation ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...

virtual void	LazyEvaluationOn ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...

virtual void	LazyEvaluationOff ()
	Most Locators build their search structures during BuildLocator but some may delay construction until it is actually needed. More...

virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase. More...

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase. More...

virtual void	UseExistingSearchStructureOn ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase. More...

virtual void	UseExistingSearchStructureOff ()
	Some locators support querying a new dataset without rebuilding the search structure (typically this may occur when a dataset changes due to a time update, but is actually the same topology) Turning on this flag enables some locators to skip the rebuilding phase. More...

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

virtual void	Initialize ()
	Initialize locator. More...

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

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

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

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

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

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

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

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

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

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

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

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

void	Register (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop. More...

void	UnRegister (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop. More...

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

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

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

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

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

static vtkCellTreeLocator *	SafeDownCast (vtkObjectBase *o)

static vtkCellTreeLocator *	New ()
	Constructor sets the maximum number of cells in a leaf to 8 and number of buckets to 5. More...

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

static vtkAbstractCellLocator *	SafeDownCast (vtkObjectBase *o)

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

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

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

Protected Member Functions inherited from vtkAbstractCellLocator
	vtkAbstractCellLocator ()

	~vtkAbstractCellLocator () override

virtual bool	StoreCellBounds ()
	This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array. More...

virtual void	FreeCellBounds ()
	This command is used internally by the locator to copy all cell Bounds into the internal CellBounds array. More...

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

int	NumberOfBuckets

vtkCellTree *	Tree

class	vtkCellPointTraversal

class	vtkCellTreeNode

class	vtkCellTreeBuilder

	vtkCellTreeLocator ()

	~vtkCellTreeLocator () override

bool	RayMinMaxT (const double origin[3], const double dir[3], double &rTmin, double &rTmax)

bool	RayMinMaxT (const double bounds[6], const double origin[3], const double dir[3], double &rTmin, double &rTmax)

int	getDominantAxis (const double dir[3])

void	Classify (const double origin[3], const double dir[3], double &rDist, vtkCellTreeNode &near, vtkCellTreeNode &mid, vtkCellTreeNode *&far, int &mustCheck)

virtual int	IntersectCellInternal (vtkIdType cell_ID, const double p1[3], const double p2[3], const double tol, double &t, double ipt[3], double pcoords[3], int &subId)

Additional Inherited Members
Protected Attributes inherited from vtkAbstractCellLocator
int	NumberOfCellsPerNode

vtkTypeBool	RetainCellLists

vtkTypeBool	CacheCellBounds

vtkTypeBool	LazyEvaluation

vtkTypeBool	UseExistingSearchStructure

vtkGenericCell *	GenericCell

double(*	CellBounds )[6]

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	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

This class implements the data structures, construction algorithms for fast cell location presented in "Fast, Memory-Efficient Cell location in Unstructured Grids for Visualization" by Christop Garth and Kenneth I.

Joy in VisWeek, 2011.

Cell Tree is a bounding interval hierarchy based data structure, where child boxes do not form an exact split of the parent boxes along a dimension. Therefore two axis- aligned bounding planes (left max and right min) are stored for each node along a dimension. This class implements the data structure (Cell Tree Node) and its build and traversal algorithms described in the paper. Some methods in building and traversing the cell tree in this class were derived avtCellLocatorBIH class in the VisIT Visualization Tool

See also: vtkLocator vtkCellLocator vtkModifiedBSPTree

Tests:: vtkCellTreeLocator (Tests)

Definition at line 51 of file vtkCellTreeLocator.h.

Member Typedef Documentation

typedef vtkAbstractCellLocator vtkCellTreeLocator::Superclass

Definition at line 55 of file vtkCellTreeLocator.h.

Constructor & Destructor Documentation

vtkCellTreeLocator::vtkCellTreeLocator ( )

protected

vtkCellTreeLocator::~vtkCellTreeLocator ( )

overrideprotected

Member Function Documentation

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

static

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

virtual

Standard type and print methods.

Reimplemented from vtkAbstractCellLocator.

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

static

virtual vtkObjectBase* vtkCellTreeLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkAbstractCellLocator.

vtkCellTreeLocator* vtkCellTreeLocator::NewInstance ( ) const

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

overridevirtual

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

static vtkCellTreeLocator* vtkCellTreeLocator::New ( )

static

Constructor sets the maximum number of cells in a leaf to 8 and number of buckets to 5.

Buckets are used in building the cell tree as described in the paper

vtkIdType vtkCellTreeLocator::FindCell	(	double	pos[3],
		double	vtkNotUsed,
		vtkGenericCell *	cell,
		double	pcoords[3],
		double *	weights
	)

overridevirtual

Test a point to find if it is inside a cell.

Returns the cellId if inside or -1 if not.

Reimplemented from vtkAbstractCellLocator.

int vtkCellTreeLocator::IntersectWithLine	(	const double	a0[3],
		const double	a1[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId,
		vtkIdType &	cellId,
		vtkGenericCell *	cell
	)

overridevirtual

Return intersection point (if any) AND the cell which was intersected by the finite line.

The cell is returned as a cell id and as a generic cell.

Reimplemented from vtkAbstractCellLocator.

void vtkCellTreeLocator::FindCellsWithinBounds	(	double *	bbox,
		vtkIdList *	cells
	)

overridevirtual

Return a list of unique cell ids inside of a given bounding box.

The user must provide the vtkIdList to populate. This method returns data only after the locator has been built.

Reimplemented from vtkAbstractCellLocator.

int vtkCellTreeLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId
	)

inlineoverridevirtual

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 100 of file vtkCellTreeLocator.h.

int vtkCellTreeLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId,
		vtkIdType &	cellId
	)

overridevirtual

Return intersection point (if any) AND the cell which was intersected by the finite line.

The cell is returned as a cell id and as a generic cell. This function is a modification from the vtkModifiedBSPTree class using the data structures in the paper to find intersections.

Reimplemented from vtkAbstractCellLocator.

int vtkCellTreeLocator::IntersectWithLine	(	const double	p1[3],
		const double	p2[3],
		vtkPoints *	points,
		vtkIdList *	cellIds
	)

inlineoverridevirtual

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 118 of file vtkCellTreeLocator.h.

vtkIdType vtkCellTreeLocator::FindCell ( double x[3] )

inlineoverridevirtual

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 128 of file vtkCellTreeLocator.h.

void vtkCellTreeLocator::FreeSearchStructure ( )

overridevirtual