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

implement a specific vtkPointSet::FindCell() strategy based on closest point More...

#include <vtkClosestPointStrategy.h>

Inheritance diagram for vtkClosestPointStrategy:
[legend]
Collaboration diagram for vtkClosestPointStrategy:
[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...
 
vtkClosestPointStrategyNewInstance () 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 the 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 SetPointLocator (vtkAbstractPointLocator *)
 Set / get an instance of vtkAbstractPointLocator which is used to implement the strategy for FindCell(). More...
 
virtual vtkAbstractPointLocatorGetPointLocator ()
 
vtkCellSelectCell (vtkPointSet *self, vtkIdType cellId, vtkCell *cell, vtkGenericCell *gencell)
 Subclasses use this method to select the current cell. More...
 
- 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 vtkClosestPointStrategyNew ()
 Construct a vtkFindCellStrategy subclass. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkClosestPointStrategySafeDownCast (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
 
 vtkClosestPointStrategy ()
 
 ~vtkClosestPointStrategy () 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

std::set< vtkIdTypeVisitedCells
 
vtkIdListPointIds
 
vtkIdListNeighbors
 
vtkIdListCellIds
 
vtkIdListNearPointIds
 
vtkAbstractPointLocatorPointLocator
 
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 closest point

vtkClosestPointStrategy is implements a FindCell() strategy based on locating the closest point in a dataset, and then searching the attached cells. While relatively fast, it does not always return the correct result (it may not find a cell, since the closest cell may not be connected to the closest point). vtkCellLocatorStrategy or vtkClosestNPointsStrategy will produce better results at the cost of speed.

See also
vtkFindCellStrategy vtkPointSet vtkCellLocatorStrategy vtkClosestNPointsStrategy

Definition at line 46 of file vtkClosestPointStrategy.h.

Member Typedef Documentation

◆ Superclass

Standard methods for type information and printing.

Definition at line 58 of file vtkClosestPointStrategy.h.

Constructor & Destructor Documentation

◆ vtkClosestPointStrategy()

vtkClosestPointStrategy::vtkClosestPointStrategy ( )
protected

◆ ~vtkClosestPointStrategy()

vtkClosestPointStrategy::~vtkClosestPointStrategy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkClosestPointStrategy* vtkClosestPointStrategy::New ( )
static

Construct a vtkFindCellStrategy subclass.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkClosestNPointsStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkClosestPointStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFindCellStrategy.

Reimplemented in vtkClosestNPointsStrategy.

◆ NewInstance()

vtkClosestPointStrategy* vtkClosestPointStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkClosestPointStrategy::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 vtkClosestPointStrategy::Initialize ( vtkPointSet ps)
overridevirtual

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

This method sets up the point locator, vtkPointSet relationship. It will use the vtkPointSet's default locator if not defined by SetPointLocator() below.

Reimplemented from vtkFindCellStrategy.

◆ FindCell()

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

Implement the specific strategy.

This method should only be called after the Initialize() method has been invoked.

Implements vtkFindCellStrategy.

◆ SetPointLocator()

virtual void vtkClosestPointStrategy::SetPointLocator ( vtkAbstractPointLocator )
virtual

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

Note if a locator is not specified, then the default locator instantiated by the vtkPointSet provided in the Initialize() method is used.

◆ GetPointLocator()

virtual vtkAbstractPointLocator* vtkClosestPointStrategy::GetPointLocator ( )
virtual

◆ SelectCell()

vtkCell * vtkClosestPointStrategy::SelectCell ( vtkPointSet self,
vtkIdType  cellId,
vtkCell cell,
vtkGenericCell gencell 
)
inline

Subclasses use this method to select the current cell.

Definition at line 117 of file vtkClosestPointStrategy.h.

Member Data Documentation

◆ VisitedCells

std::set<vtkIdType> vtkClosestPointStrategy::VisitedCells
protected

Definition at line 100 of file vtkClosestPointStrategy.h.

◆ PointIds

vtkIdList* vtkClosestPointStrategy::PointIds
protected

Definition at line 101 of file vtkClosestPointStrategy.h.

◆ Neighbors

vtkIdList* vtkClosestPointStrategy::Neighbors
protected

Definition at line 102 of file vtkClosestPointStrategy.h.

◆ CellIds

vtkIdList* vtkClosestPointStrategy::CellIds
protected

Definition at line 103 of file vtkClosestPointStrategy.h.

◆ NearPointIds

vtkIdList* vtkClosestPointStrategy::NearPointIds
protected

Definition at line 104 of file vtkClosestPointStrategy.h.

◆ PointLocator

vtkAbstractPointLocator* vtkClosestPointStrategy::PointLocator
protected

Definition at line 106 of file vtkClosestPointStrategy.h.

◆ OwnsLocator

bool vtkClosestPointStrategy::OwnsLocator
protected

Definition at line 107 of file vtkClosestPointStrategy.h.


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