VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellLocatorStrategy Class Reference

implement a specific vtkPointSet::FindCell() strategy based on using a cell locator More...

#include <vtkCellLocatorStrategy.h>

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

Public Types

typedef vtkFindCellStrategy Superclass
 Standard methods for type information and printing. More...
 
- Public Types inherited from vtkFindCellStrategy
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...
 
vtkCellLocatorStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int Initialize (vtkPointSet *ps) override
 Provide necessary initialization method (see superclass for more information). More...
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Implement the specific strategy. More...
 
virtual void SetCellLocator (vtkAbstractCellLocator *)
 Set / get an instance of vtkAbstractCellLocator which is used to implement the strategy for FindCell(). More...
 
virtual vtkAbstractCellLocatorGetCellLocator ()
 
- Public Member Functions inherited from vtkFindCellStrategy
vtkFindCellStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkCellLocatorStrategyNew ()
 Construct a vtkFindCellStrategy subclass. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellLocatorStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkFindCellStrategy
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
 
 vtkCellLocatorStrategy ()
 
 ~vtkCellLocatorStrategy () override
 
- Protected Member Functions inherited from vtkFindCellStrategy
 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

vtkAbstractCellLocatorCellLocator
 
bool OwnsLocator
 
- Protected Attributes inherited from vtkFindCellStrategy
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

implement a specific vtkPointSet::FindCell() strategy based on using a cell locator

vtkCellLocatorStrategy is implements a FindCell() strategy based on using the FindCell() method in a cell locator. This is often the slowest strategy, but the most robust.

See also
vtkFindCellStrategy vtkPointSet

Definition at line 36 of file vtkCellLocatorStrategy.h.

Member Typedef Documentation

◆ Superclass

Standard methods for type information and printing.

Definition at line 48 of file vtkCellLocatorStrategy.h.

Constructor & Destructor Documentation

◆ vtkCellLocatorStrategy()

vtkCellLocatorStrategy::vtkCellLocatorStrategy ( )
protected

◆ ~vtkCellLocatorStrategy()

vtkCellLocatorStrategy::~vtkCellLocatorStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCellLocatorStrategy* vtkCellLocatorStrategy::New ( )
static

Construct a vtkFindCellStrategy subclass.

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellLocatorStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFindCellStrategy.

◆ NewInstance()

vtkCellLocatorStrategy* vtkCellLocatorStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkCellLocatorStrategy::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()

int vtkCellLocatorStrategy::Initialize ( vtkPointSet ps)
overridevirtual

Provide necessary initialization method (see superclass for more information).

Reimplemented from vtkFindCellStrategy.

◆ FindCell()

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

Implement the specific strategy.

Implements vtkFindCellStrategy.

◆ SetCellLocator()

virtual void vtkCellLocatorStrategy::SetCellLocator ( vtkAbstractCellLocator )
virtual

Set / get an instance of vtkAbstractCellLocator which is used to implement the strategy for FindCell().

The locator is required to already be built and non-NULL.

◆ GetCellLocator()

virtual vtkAbstractCellLocator* vtkCellLocatorStrategy::GetCellLocator ( )
virtual

Member Data Documentation

◆ CellLocator

vtkAbstractCellLocator* vtkCellLocatorStrategy::CellLocator
protected

Definition at line 81 of file vtkCellLocatorStrategy.h.

◆ OwnsLocator

bool vtkCellLocatorStrategy::OwnsLocator
protected

Definition at line 82 of file vtkCellLocatorStrategy.h.


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