VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFindCellStrategy Class Referenceabstract

helper class to manage the vtkPointSet::FindCell() METHOD More...

#include <vtkFindCellStrategy.h>

Inheritance diagram for vtkFindCellStrategy:
[legend]
Collaboration diagram for vtkFindCellStrategy:
[legend]

Public Types

typedef vtkObject Superclass
 Standard methdos for type information and printing. 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...
 
vtkFindCellStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int Initialize (vtkPointSet *ps)
 All subclasses of this class must provide an initialize method. More...
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0
 Virtual method for finding a cell. 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)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). 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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFindCellStrategySafeDownCast (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
 
 vtkFindCellStrategy ()
 
 ~vtkFindCellStrategy () 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPointSetPointSet
 
double Bounds [6]
 
vtkTimeStamp InitializeTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper class to manage the vtkPointSet::FindCell() METHOD

vtkFindCellStrategy is a helper class to manage the use of locators for locating cells containing a query point x[3], the so-called FindCell() method. The use of vtkDataSet::FindCell() is a common operation in applications such as streamline generation and probing. However, in some dataset types FindCell() can be implemented very simply (e.g., vtkImageData) while in other datasets it is a complex operation requiring supplemental objects like locators to perform efficiently. In particular, vtkPointSet and its subclasses (like vtkUnstructuredGrid) require complex strategies to efficiently implement the FindCell() operation. Subclasses of the abstract vtkFindCellStrategy implement several of these strategies.

The are two key methods to this class and subclasses. The Initialize() method negotiates with an input dataset to define the locator to use: either a locator associated with the inout dataset, or possibly an alternative locator defined by the strategy (subclasses do this). The second important method, FindCell() mimics vtkDataSet::FindCell() and can be used in place of it.

See also
vtkPointSet vtkPolyData vtkStructuredGrid vtkUnstructuredGrid

Definition at line 51 of file vtkFindCellStrategy.h.

Member Typedef Documentation

◆ Superclass

Standard methdos for type information and printing.

Definition at line 58 of file vtkFindCellStrategy.h.

Constructor & Destructor Documentation

◆ vtkFindCellStrategy()

vtkFindCellStrategy::vtkFindCellStrategy ( )
protected

◆ ~vtkFindCellStrategy()

vtkFindCellStrategy::~vtkFindCellStrategy ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkFindCellStrategy::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 vtkObjectBase.

Reimplemented in vtkClosestPointStrategy, vtkCellLocatorStrategy, and vtkClosestNPointsStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFindCellStrategy::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkFindCellStrategy* vtkFindCellStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkFindCellStrategy::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 vtkObject.

◆ Initialize()

virtual int vtkFindCellStrategy::Initialize ( vtkPointSet ps)
virtual

All subclasses of this class must provide an initialize method.

This method performs handshaking and setup between the vtkPointSet dataset and associated locator(s). A return value==0 means the initialization process failed.

Reimplemented in vtkClosestPointStrategy, and vtkCellLocatorStrategy.

◆ FindCell()

virtual vtkIdType vtkFindCellStrategy::FindCell ( double  x[3],
vtkCell cell,
vtkGenericCell gencell,
vtkIdType  cellId,
double  tol2,
int subId,
double  pcoords[3],
double weights 
)
pure virtual

Virtual method for finding a cell.

Subclasses must satisfy this API. This method is of the same signature as vtkDataSet::FindCell().

Implemented in vtkClosestPointStrategy, vtkCellLocatorStrategy, and vtkClosestNPointsStrategy.

Member Data Documentation

◆ PointSet

vtkPointSet* vtkFindCellStrategy::PointSet
protected

Definition at line 83 of file vtkFindCellStrategy.h.

◆ Bounds

double vtkFindCellStrategy::Bounds[6]
protected

Definition at line 84 of file vtkFindCellStrategy.h.

◆ InitializeTime

vtkTimeStamp vtkFindCellStrategy::InitializeTime
protected

Definition at line 86 of file vtkFindCellStrategy.h.


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