vtkm::VecAxisAlignedPointCoordinates< NumDimensions > Class Template Reference

An implicit vector for point coordinates in axis aligned cells. More...

#include <VecAxisAlignedPointCoordinates.h>

Public Types
using	ComponentType = vtkm::Vec3f

Public Member Functions
VTKM_EXEC_CONT	VecAxisAlignedPointCoordinates (ComponentType origin=ComponentType(0, 0, 0), ComponentType spacing=ComponentType(1, 1, 1))
VTKM_EXEC_CONT vtkm::IdComponent	GetNumberOfComponents () const
template<vtkm::IdComponent DestSize>
VTKM_EXEC_CONT void	CopyInto (vtkm::Vec< ComponentType, DestSize > &dest) const
VTKM_EXEC_CONT ComponentType	operator[] (vtkm::IdComponent index) const
const VTKM_EXEC_CONT ComponentType &	GetOrigin () const
const VTKM_EXEC_CONT ComponentType &	GetSpacing () const

Static Public Attributes
static constexpr vtkm::IdComponent	NUM_COMPONENTS

Private Attributes
ComponentType	Origin
ComponentType	Spacing

Detailed Description

template<vtkm::IdComponent NumDimensions>
class vtkm::VecAxisAlignedPointCoordinates< NumDimensions >

An implicit vector for point coordinates in axis aligned cells.

For internal use only.

The VecAxisAlignedPointCoordinates class is a Vec-like class that holds the point coordinates for a axis aligned cell. The class is templated on the dimensions of the cell, which can be 1 (for a line).

This is an internal class used to represent coordinates for uniform datasets in an execution environment when executing a WorkletMapPointToCell. Users should not directly construct this class under any circumstances. Use the related ArrayPortalUniformPointCoordinates and ArrayHandleUniformPointCoordinates classes instead.

Member Typedef Documentation

ComponentType

template<vtkm::IdComponent NumDimensions>

using vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::ComponentType = vtkm::Vec3f

Constructor & Destructor Documentation

VecAxisAlignedPointCoordinates()

template<vtkm::IdComponent NumDimensions>

VTKM_EXEC_CONT vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::VecAxisAlignedPointCoordinates ( ComponentType  origin = ComponentType(0, 0, 0), ComponentType  spacing = ComponentType(1, 1, 1)  )

inline

Member Function Documentation

CopyInto()

template<vtkm::IdComponent NumDimensions>

template<vtkm::IdComponent DestSize>

VTKM_EXEC_CONT void vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::CopyInto ( vtkm::Vec< ComponentType, DestSize > &  dest ) const

inline

GetNumberOfComponents()

template<vtkm::IdComponent NumDimensions>

VTKM_EXEC_CONT vtkm::IdComponent vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::GetNumberOfComponents ( ) const

inline

GetOrigin()

template<vtkm::IdComponent NumDimensions>

const VTKM_EXEC_CONT ComponentType& vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::GetOrigin ( ) const

inline

GetSpacing()

template<vtkm::IdComponent NumDimensions>

const VTKM_EXEC_CONT ComponentType& vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::GetSpacing ( ) const

inline

operator[]()

template<vtkm::IdComponent NumDimensions>

VTKM_EXEC_CONT ComponentType vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::operator[] ( vtkm::IdComponent  index ) const

inline

Member Data Documentation

NUM_COMPONENTS

template<vtkm::IdComponent NumDimensions>

constexpr vtkm::IdComponent vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::NUM_COMPONENTS

staticconstexpr

Initial value:

=
    detail::VecAxisAlignedPointCoordinatesNumComponents<NumDimensions>::NUM_COMPONENTS

Origin

template<vtkm::IdComponent NumDimensions>

ComponentType vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::Origin

private

Spacing

template<vtkm::IdComponent NumDimensions>

ComponentType vtkm::VecAxisAlignedPointCoordinates< NumDimensions >::Spacing

private

---

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

• VecAxisAlignedPointCoordinates.h