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

abstract base class for objects that implement accelerated searches through HyperTree Grids (HTGs) More...

#include <vtkHyperTreeGridLocator.h>

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

Public Types

typedef vtkObject Superclass
 

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.
 
vtkHyperTreeGridLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkHyperTreeGridGetHTG ()
 Getter/Setter methods for setting the vtkHyperTreeGrid.
 
virtual void SetHTG (vtkHyperTreeGrid *)
 
virtual void Initialize ()
 Initialize or reinitialize the locator (setting or re-setting clean objects in memory) (Does nothing)
 
virtual void Update ()
 Update the locator's internal variables with respect to changes that could have happened outside.
 
virtual vtkIdType Search (const double point[3])=0
 Basic search for cell holding a given point.
 
virtual vtkIdType FindCell (const double point[3], double tol, vtkGenericCell *cell, int &subId, double pcoords[3], double *weights)=0
 Pure virtual.
 
virtual int IntersectWithLine (const double p0[3], const double p1[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell)=0
 Pure virtual.
 
virtual int IntersectWithLine (const double p0[3], const double p1[3], double tol, vtkPoints *points, vtkIdList *cellIds, vtkGenericCell *cell)=0
 Pure virtual.
 
virtual void SetTolerance (double)
 Get/Set tolerance used when searching for cells in the HTG.
 
virtual double GetTolerance ()
 Get/Set tolerance used when searching for cells in the HTG.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridLocatorSafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHyperTreeGridLocator ()=default
 
 ~vtkHyperTreeGridLocator () override=default
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkWeakPointer< vtkHyperTreeGridHTG
 Internal reference to the HyperTreeGrid one wants to search over.
 
double Tolerance = 0.0
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

abstract base class for objects that implement accelerated searches through HyperTree Grids (HTGs)

The goal of this abstract class is to define an interface to helper objects that implement optimized search methods through vtkHyperTreeGrids. This class is heavily inspired from the vtkLocator interface but constructed to be compatible with vtkHyperTreeGrids (which are not vtkDataSets at the time of this implementation). Ideally, implementations of this interface leverage the specific structure of HyperTrees and HyperTreeGrids to deliver accelerated search algorithms through their data.

As a side comment: ideally we would inherit from vtkLocator which only supports vtkDataSets right now. Hopefully in the future vtkHyperTreeGrid will become a vtkDataSet or vtkCompositeDataSet and we could accomplish just that with minimal refactoring.

See also
vtkHyperTreeGrid, vtkHyperTree, vtkHyperTreeGridOrientedCursor, vtkHyperTreeGridNonOrientedCursor

Definition at line 37 of file vtkHyperTreeGridLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkHyperTreeGridLocator.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridLocator()

vtkHyperTreeGridLocator::vtkHyperTreeGridLocator ( )
protecteddefault

◆ ~vtkHyperTreeGridLocator()

vtkHyperTreeGridLocator::~vtkHyperTreeGridLocator ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHyperTreeGridLocator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHyperTreeGridLocator * vtkHyperTreeGridLocator::NewInstance ( ) const

◆ PrintSelf()

void vtkHyperTreeGridLocator::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 vtkObjectBase.

◆ GetHTG()

virtual vtkHyperTreeGrid * vtkHyperTreeGridLocator::GetHTG ( )
virtual

Getter/Setter methods for setting the vtkHyperTreeGrid.

◆ SetHTG()

virtual void vtkHyperTreeGridLocator::SetHTG ( vtkHyperTreeGrid )
virtual

◆ Initialize()

virtual void vtkHyperTreeGridLocator::Initialize ( )
inlinevirtual

Initialize or reinitialize the locator (setting or re-setting clean objects in memory) (Does nothing)

Definition at line 54 of file vtkHyperTreeGridLocator.h.

◆ Update()

virtual void vtkHyperTreeGridLocator::Update ( )
virtual

Update the locator's internal variables with respect to changes that could have happened outside.

◆ Search()

virtual vtkIdType vtkHyperTreeGridLocator::Search ( const double  point[3])
pure virtual

Basic search for cell holding a given point.

Parameters
pointcoordinated of sought point
Returns
the global index of the cell holding the point (-1 if cell not found or masked)

Implemented in vtkHyperTreeGridGeometricLocator.

◆ FindCell()

virtual vtkIdType vtkHyperTreeGridLocator::FindCell ( const double  point[3],
double  tol,
vtkGenericCell cell,
int &  subId,
double  pcoords[3],
double *  weights 
)
pure virtual

Pure virtual.

Find the cell where a given point lies

Parameters
[in]pointan array holding the coordinates of the point to search for
[in]toltolerance level
[out]cellpointer to a cell configured with information from return value cell index
[out]subIdindex of the sub cell if composite cell
[out]pcoordsparametric coordinates of the point in the cell
[out]weightsinterpolation weights of the sought point in the cell
Returns
the global index of the cell holding the point (-1 if no cell is found or masked)

Implemented in vtkHyperTreeGridGeometricLocator.

◆ IntersectWithLine() [1/2]

virtual int vtkHyperTreeGridLocator::IntersectWithLine ( const double  p0[3],
const double  p1[3],
double  tol,
double &  t,
double  x[3],
double  pcoords[3],
int &  subId,
vtkIdType cellId,
vtkGenericCell cell 
)
pure virtual

Pure virtual.

Find first intersection of the line defined by (p0, p1) with the HTG

Parameters
[in]p0first point of the line
[in]p1second point of the line
[in]toltolerance level
[out]tpseudo-time along line path at intersection
[out]xintersection point
[out]pcoordsparametric coordinatesof intersection
[out]subIdindex of the sub cell if composite cell
[out]cellIdthe global index of the intersected cell
[out]cellpointer to a vtkCell object corresponding to cellId
Returns
an integer with 0 if no intersection could be found

Implemented in vtkHyperTreeGridGeometricLocator.

◆ IntersectWithLine() [2/2]

virtual int vtkHyperTreeGridLocator::IntersectWithLine ( const double  p0[3],
const double  p1[3],
double  tol,
vtkPoints points,
vtkIdList cellIds,
vtkGenericCell cell 
)
pure virtual

Pure virtual.

Find all intersections of the line defined by (p0, p1) with the HTG

Parameters
[in]p0first point of the line
[in]p1second point of the line
[in]toltolerance level
[out]pointsarray of points on the line intersecting the HTG
[out]cellIdsarray of cellIds holding the different points of the points array
[out]cellpointer to a vtkCell object corresponding to the last cellId found
Returns
an integer with 0 if no intersection could be found

Implemented in vtkHyperTreeGridGeometricLocator.

◆ SetTolerance()

virtual void vtkHyperTreeGridLocator::SetTolerance ( double  )
virtual

Get/Set tolerance used when searching for cells in the HTG.

Default is 0.0

◆ GetTolerance()

virtual double vtkHyperTreeGridLocator::GetTolerance ( )
virtual

Get/Set tolerance used when searching for cells in the HTG.

Default is 0.0

Member Data Documentation

◆ HTG

vtkWeakPointer<vtkHyperTreeGrid> vtkHyperTreeGridLocator::HTG
protected

Internal reference to the HyperTreeGrid one wants to search over.

Definition at line 128 of file vtkHyperTreeGridLocator.h.

◆ Tolerance

double vtkHyperTreeGridLocator::Tolerance = 0.0
protected

Definition at line 130 of file vtkHyperTreeGridLocator.h.


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