VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkScalarTree Class Referenceabstract

organize data according to scalar values (used to accelerate contouring operations) More...

#include <vtkScalarTree.h>

Inheritance diagram for vtkScalarTree:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkScalarTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void BuildTree ()=0
 
virtual void Initialize ()=0
 
virtual void InitTraversal (double scalarValue)=0
 
virtual void SetDataSet (vtkDataSet *)
 
virtual vtkDataSet * GetDataSet ()
 
virtual vtkCell * GetNextCell (vtkIdType &cellId, vtkIdList *&ptIds, vtkDataArray *cellScalars)=0
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkScalarTreeSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkScalarTree ()
 
 ~vtkScalarTree ()
 

Protected Attributes

vtkDataSet * DataSet
 
vtkDataArray * Scalars
 
vtkTimeStamp BuildTime
 
double ScalarValue
 

Detailed Description

organize data according to scalar values (used to accelerate contouring operations)

vtkScalarTree is an abstract class that defines the API to concrete scalar tree subclasses. A scalar tree is a data structure that organizes data according to its scalar value. This allows rapid access to data for those algorithms that access the data based on scalar value. For example, isocontouring operates on cells based on the scalar (isocontour) value.

To use subclasses of this class, you must specify a dataset to operate on, and then specify a scalar value in the InitTraversal() method. Then calls to GetNextCell() return cells whose scalar data contains the scalar value specified.

See Also
vtkSimpleScalarTree

Definition at line 46 of file vtkScalarTree.h.

Member Typedef Documentation

typedef vtkObject vtkScalarTree::Superclass

Definition at line 49 of file vtkScalarTree.h.

Constructor & Destructor Documentation

vtkScalarTree::vtkScalarTree ( )
protected
vtkScalarTree::~vtkScalarTree ( )
protected

Member Function Documentation

static int vtkScalarTree::IsTypeOf ( const char *  type)
static
virtual int vtkScalarTree::IsA ( const char *  type)
virtual

Reimplemented in vtkSimpleScalarTree.

static vtkScalarTree* vtkScalarTree::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkScalarTree::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkSimpleScalarTree.

vtkScalarTree* vtkScalarTree::NewInstance ( ) const
void vtkScalarTree::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkScalarTree::SetDataSet ( vtkDataSet *  )
virtual

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

virtual vtkDataSet* vtkScalarTree::GetDataSet ( )
virtual

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

virtual void vtkScalarTree::BuildTree ( )
pure virtual

Construct the scalar tree from the dataset provided. Checks build times and modified time from input and reconstructs the tree if necessary.

Implemented in vtkSimpleScalarTree.

virtual void vtkScalarTree::Initialize ( )
pure virtual

Initialize locator. Frees memory and resets object as appropriate.

Implemented in vtkSimpleScalarTree.

virtual void vtkScalarTree::InitTraversal ( double  scalarValue)
pure virtual

Begin to traverse the cells based on a scalar value. Returned cells will have scalar values that span the scalar value specified.

Implemented in vtkSimpleScalarTree.

virtual vtkCell* vtkScalarTree::GetNextCell ( vtkIdType &  cellId,
vtkIdList *&  ptIds,
vtkDataArray *  cellScalars 
)
pure virtual

Return the next cell that may contain scalar value specified to initialize traversal. The value NULL is returned if the list is exhausted. Make sure that InitTraversal() has been invoked first or you'll get erratic behavior.

Implemented in vtkSimpleScalarTree.

Member Data Documentation

vtkDataSet* vtkScalarTree::DataSet
protected

Definition at line 83 of file vtkScalarTree.h.

vtkDataArray* vtkScalarTree::Scalars
protected

Definition at line 84 of file vtkScalarTree.h.

vtkTimeStamp vtkScalarTree::BuildTime
protected

Definition at line 86 of file vtkScalarTree.h.

double vtkScalarTree::ScalarValue
protected

Definition at line 87 of file vtkScalarTree.h.


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