vtkm::cont::PointLocatorBase Class Reference

Base class for all PointLocator classes. More...

#include <PointLocatorBase.h>

Inheritance diagram for vtkm::cont::PointLocatorBase:

Public Member Functions
virtual	~PointLocatorBase ()=default
vtkm::cont::CoordinateSystem	GetCoordinates () const
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const vtkm::cont::CoordinateSystem &coords)
	Specify the CoordinateSystem defining the location of the cells. More...
void	SetCoordinates (const vtkm::cont::UnknownArrayHandle &coords)
	Specify the CoordinateSystem defining the location of the cells. More...
void	Update () const

Protected Member Functions
void	SetModified ()
bool	GetModified () const
virtual void	Build ()=0

Private Attributes
vtkm::cont::CoordinateSystem	Coords
bool	Modified = true

Detailed Description

Base class for all PointLocator classes.

PointLocatorBase subclasses must implement the pure virtual Build() method. They also must provide a PrepareForExecution() method to satisfy the ExecutionObjectBase superclass.

If a derived class changes its state in a way that invalidates its internal search structure, it should call the protected SetModified() method. This will alert the base class to rebuild the structure on the next call to Update().

Constructor & Destructor Documentation

~PointLocatorBase()

virtual vtkm::cont::PointLocatorBase::~PointLocatorBase ( )

virtualdefault

Member Function Documentation

Build()

virtual void vtkm::cont::PointLocatorBase::Build ( )

protectedpure virtual

Implemented in vtkm::cont::PointLocatorSparseGrid.

GetCoordinates()

vtkm::cont::CoordinateSystem vtkm::cont::PointLocatorBase::GetCoordinates ( ) const

inline

Specify the CoordinateSystem defining the location of the cells.

This is often retrieved from the vtkm::cont::DataSet::GetCoordinateSystem() method, but it can be any array of size 3 Vecs.

GetModified()

bool vtkm::cont::PointLocatorBase::GetModified ( ) const

inlineprotected

SetCoordinates() [1/2]

void vtkm::cont::PointLocatorBase::SetCoordinates ( const vtkm::cont::CoordinateSystem &  coords )

inline

Specify the CoordinateSystem defining the location of the cells.

This is often retrieved from the vtkm::cont::DataSet::GetCoordinateSystem() method, but it can be any array of size 3 Vecs.

SetCoordinates() [2/2]

void vtkm::cont::PointLocatorBase::SetCoordinates ( const vtkm::cont::UnknownArrayHandle &  coords )

inline

Specify the CoordinateSystem defining the location of the cells.

This is often retrieved from the vtkm::cont::DataSet::GetCoordinateSystem() method, but it can be any array of size 3 Vecs.

SetModified()

void vtkm::cont::PointLocatorBase::SetModified ( )

inlineprotected

Update()

void vtkm::cont::PointLocatorBase::Update

(

)

const

Member Data Documentation

Coords

vtkm::cont::CoordinateSystem vtkm::cont::PointLocatorBase::Coords

private

Modified

bool vtkm::cont::PointLocatorBase::Modified = true

mutableprivate

---

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

• PointLocatorBase.h