VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions
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:
Inheritance graph
[legend]
Collaboration diagram for vtkCellTreeLocator:
Collaboration graph
[legend]

List of all members.

Classes

class  vtkCellTree
class  vtkCellTreeNode

Public Types

typedef vtkAbstractCellLocator Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void FindCellsWithinBounds (double *bbox, vtkIdList *cells)
virtual vtkIdType FindCell (double pos[3], double vtkNotUsed, vtkGenericCell *cell, double pcoords[3], double *weights)
virtual int IntersectWithLine (double a0[3], double a1[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell)
virtual int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
virtual int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId)
virtual int IntersectWithLine (const double p1[3], const double p2[3], vtkPoints *points, vtkIdList *cellIds)
virtual vtkIdType FindCell (double x[3])
virtual void FreeSearchStructure ()
virtual void GenerateRepresentation (int level, vtkPolyData *pd)
virtual void BuildLocatorInternal ()
virtual void BuildLocatorIfNeeded ()
virtual void ForceBuildLocator ()
virtual void BuildLocator ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkCellTreeLocatorSafeDownCast (vtkObject *o)
static vtkCellTreeLocatorNew ()
int NumberOfBuckets
vtkCellTreeTree
class vtkCellPointTraversal
class vtkCellTreeNode
class vtkCellTreeBuilder
 vtkCellTreeLocator ()
 ~vtkCellTreeLocator ()
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)

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


Member Typedef Documentation

Reimplemented from vtkAbstractCellLocator.

Definition at line 53 of file vtkCellTreeLocator.h.


Constructor & Destructor Documentation

vtkCellTreeLocator::vtkCellTreeLocator ( ) [protected]
vtkCellTreeLocator::~vtkCellTreeLocator ( ) [protected]

Member Function Documentation

virtual const char* vtkCellTreeLocator::GetClassName ( ) [virtual]

Reimplemented from vtkAbstractCellLocator.

static int vtkCellTreeLocator::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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.

virtual int 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.

static vtkCellTreeLocator* vtkCellTreeLocator::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkAbstractCellLocator.

void vtkCellTreeLocator::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 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

Reimplemented from vtkObject.

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

Test a point to find if it is inside a cell. Returns the cellId if inside or -1 if not.

Reimplemented from vtkAbstractCellLocator.

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

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.

virtual void vtkCellTreeLocator::FindCellsWithinBounds ( double bbox,
vtkIdList cells 
) [virtual]

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.

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

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 96 of file vtkCellTreeLocator.h.

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

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.

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

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 117 of file vtkCellTreeLocator.h.

virtual vtkIdType vtkCellTreeLocator::FindCell ( double  x[3]) [inline, virtual]

reimplemented from vtkAbstractCellLocator to support bad compilers

Reimplemented from vtkAbstractCellLocator.

Definition at line 127 of file vtkCellTreeLocator.h.

virtual void vtkCellTreeLocator::FreeSearchStructure ( ) [virtual]

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

virtual void vtkCellTreeLocator::GenerateRepresentation ( int  level,
vtkPolyData pd 
) [virtual]

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

virtual void vtkCellTreeLocator::BuildLocatorInternal ( ) [virtual]

Satisfy vtkLocator abstract interface.

virtual void vtkCellTreeLocator::BuildLocatorIfNeeded ( ) [virtual]

Satisfy vtkLocator abstract interface.

virtual void vtkCellTreeLocator::ForceBuildLocator ( ) [virtual]

Satisfy vtkLocator abstract interface.

virtual void vtkCellTreeLocator::BuildLocator ( ) [virtual]

Satisfy vtkLocator abstract interface.

Implements vtkLocator.

bool vtkCellTreeLocator::RayMinMaxT ( const double  origin[3],
const double  dir[3],
double rTmin,
double rTmax 
) [protected]
bool vtkCellTreeLocator::RayMinMaxT ( const double  bounds[6],
const double  origin[3],
const double  dir[3],
double rTmin,
double rTmax 
) [protected]
int vtkCellTreeLocator::getDominantAxis ( const double  dir[3]) [protected]
void vtkCellTreeLocator::Classify ( const double  origin[3],
const double  dir[3],
double rDist,
vtkCellTreeNode *&  near,
vtkCellTreeNode *&  mid,
vtkCellTreeNode *&  far,
int mustCheck 
) [protected]
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 
) [protected, virtual]

Friends And Related Function Documentation

friend class vtkCellPointTraversal [friend]

Definition at line 245 of file vtkCellTreeLocator.h.

friend class vtkCellTreeNode [friend]

Definition at line 246 of file vtkCellTreeLocator.h.

friend class vtkCellTreeBuilder [friend]

Definition at line 247 of file vtkCellTreeLocator.h.


Member Data Documentation

Definition at line 241 of file vtkCellTreeLocator.h.

Definition at line 243 of file vtkCellTreeLocator.h.


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