VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCellTreeLocator Class Reference

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. 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)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCellTreeLocatorNewInstance () 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
 Method to build a representation at a particular level. More...
 
virtual void BuildLocatorInternal ()
 
virtual void BuildLocatorIfNeeded ()
 
virtual void ForceBuildLocator ()
 
void BuildLocator () override
 Build the locator from the input dataset. More...
 
- Public Member Functions inherited from vtkAbstractCellLocator
vtkAbstractCellLocatorNewInstance () const
 
virtual void SetNumberOfCellsPerNode (int)
 Specify the preferred/maximum number of cells in each node/bucket. More...
 
virtual int GetNumberOfCellsPerNode ()
 
virtual void SetCacheCellBounds (vtkTypeBool)
 Boolean controls whether the bounds of each cell are computed only once and then saved. More...
 
virtual vtkTypeBool GetCacheCellBounds ()
 
virtual void CacheCellBoundsOn ()
 
virtual void CacheCellBoundsOff ()
 
virtual void SetRetainCellLists (vtkTypeBool)
 Boolean controls whether to maintain list of cells in each node. More...
 
virtual vtkTypeBool GetRetainCellLists ()
 
virtual void RetainCellListsOn ()
 
virtual void RetainCellListsOff ()
 
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 ()
 
virtual void LazyEvaluationOn ()
 
virtual void LazyEvaluationOff ()
 
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 ()
 
virtual void UseExistingSearchStructureOn ()
 
virtual void UseExistingSearchStructureOff ()
 
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...
 
- Public Member Functions inherited from vtkLocator
vtkLocatorNewInstance () const
 
virtual void SetDataSet (vtkDataSet *)
 Build the locator from the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 
virtual void SetMaxLevel (int)
 Set the maximum allowable level for the tree. More...
 
virtual int GetMaxLevel ()
 
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 ()
 
virtual void AutomaticOn ()
 
virtual void AutomaticOff ()
 
virtual void SetTolerance (double)
 Specify absolute tolerance (in world coordinates) for performing geometric operations. More...
 
virtual double GetTolerance ()
 
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 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
 Decrease the reference count (release by another object). 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellTreeLocatorSafeDownCast (vtkObjectBase *o)
 
static vtkCellTreeLocatorNew ()
 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 vtkAbstractCellLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLocator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLocatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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)
 
- 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 ()
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfBuckets
 
vtkCellTreeTree
 
- Protected Attributes inherited from vtkAbstractCellLocator
int NumberOfCellsPerNode
 
vtkTypeBool RetainCellLists
 
vtkTypeBool CacheCellBounds
 
vtkTypeBool LazyEvaluation
 
vtkTypeBool UseExistingSearchStructure
 
vtkGenericCellGenericCell
 
double(* CellBounds )[6]
 
- Protected Attributes inherited from vtkLocator
vtkDataSetDataSet
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkCellPointTraversal
 
class vtkCellTreeNode
 
class vtkCellTreeBuilder
 

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

Definition at line 48 of file vtkCellTreeLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkCellTreeLocator.h.

Constructor & Destructor Documentation

◆ vtkCellTreeLocator()

vtkCellTreeLocator::vtkCellTreeLocator ( )
protected

◆ ~vtkCellTreeLocator()

vtkCellTreeLocator::~vtkCellTreeLocator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellTreeLocator::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 vtkAbstractCellLocator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellTreeLocator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractCellLocator.

◆ NewInstance()

vtkCellTreeLocator* vtkCellTreeLocator::NewInstance ( ) const

◆ PrintSelf()

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.

◆ New()

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

◆ FindCell() [1/2]

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.

◆ IntersectWithLine() [1/4]

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.

◆ FindCellsWithinBounds()

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.

◆ IntersectWithLine() [2/4]

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 96 of file vtkCellTreeLocator.h.

◆ IntersectWithLine() [3/4]

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.

◆ IntersectWithLine() [4/4]

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 114 of file vtkCellTreeLocator.h.

◆ FindCell() [2/2]

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

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 123 of file vtkCellTreeLocator.h.

◆ FreeSearchStructure()

void vtkCellTreeLocator::FreeSearchStructure ( )
overridevirtual

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

◆ GenerateRepresentation()

void vtkCellTreeLocator::GenerateRepresentation ( int  level,
vtkPolyData pd 
)
overridevirtual

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.

Implements vtkLocator.

◆ BuildLocatorInternal()

virtual void vtkCellTreeLocator::BuildLocatorInternal ( )
virtual

◆ BuildLocatorIfNeeded()

virtual void vtkCellTreeLocator::BuildLocatorIfNeeded ( )
virtual

◆ ForceBuildLocator()

virtual void vtkCellTreeLocator::ForceBuildLocator ( )
virtual

◆ BuildLocator()

void vtkCellTreeLocator::BuildLocator ( )
overridevirtual

Build the locator from the input dataset.

Implements vtkLocator.

◆ RayMinMaxT() [1/2]

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

◆ RayMinMaxT() [2/2]

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

◆ getDominantAxis()

int vtkCellTreeLocator::getDominantAxis ( const double  dir[3])
protected

◆ Classify()

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

◆ IntersectCellInternal()

virtual int vtkCellTreeLocator::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 
)
protectedvirtual

Friends And Related Function Documentation

◆ vtkCellPointTraversal

friend class vtkCellPointTraversal
friend

Definition at line 224 of file vtkCellTreeLocator.h.

◆ vtkCellTreeNode

friend class vtkCellTreeNode
friend

Definition at line 225 of file vtkCellTreeLocator.h.

◆ vtkCellTreeBuilder

friend class vtkCellTreeBuilder
friend

Definition at line 226 of file vtkCellTreeLocator.h.

Member Data Documentation

◆ NumberOfBuckets

int vtkCellTreeLocator::NumberOfBuckets
protected

Definition at line 220 of file vtkCellTreeLocator.h.

◆ Tree

vtkCellTree* vtkCellTreeLocator::Tree
protected

Definition at line 222 of file vtkCellTreeLocator.h.


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