viskores::VecAxisAlignedPointCoordinates< NumDimensions > Class Template Reference

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

#include <VecAxisAlignedPointCoordinates.h>

Public Types
using	ComponentType = viskores::Vec3f

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

Static Public Attributes
static constexpr viskores::IdComponent	NUM_COMPONENTS

Private Attributes
ComponentType	Origin
ComponentType	Spacing

Detailed Description

template<viskores::IdComponent NumDimensions>
class viskores::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<viskores::IdComponent NumDimensions>

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

Constructor & Destructor Documentation

VecAxisAlignedPointCoordinates()

template<viskores::IdComponent NumDimensions>

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

inline

Member Function Documentation

CopyInto()

template<viskores::IdComponent NumDimensions>

template<viskores::IdComponent DestSize>

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

inline

GetNumberOfComponents()

template<viskores::IdComponent NumDimensions>

viskores::IdComponent viskores::VecAxisAlignedPointCoordinates< NumDimensions >::GetNumberOfComponents ( ) const

inline

GetOrigin()

template<viskores::IdComponent NumDimensions>

const ComponentType& viskores::VecAxisAlignedPointCoordinates< NumDimensions >::GetOrigin ( ) const

inline

GetSpacing()

template<viskores::IdComponent NumDimensions>

const ComponentType& viskores::VecAxisAlignedPointCoordinates< NumDimensions >::GetSpacing ( ) const

inline

operator[]()

template<viskores::IdComponent NumDimensions>

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

inline

Member Data Documentation

NUM_COMPONENTS

template<viskores::IdComponent NumDimensions>

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

staticconstexpr

Initial value:

=
    detail::VecAxisAlignedPointCoordinatesNumComponents<NumDimensions>::NUM_COMPONENTS

Origin

template<viskores::IdComponent NumDimensions>

ComponentType viskores::VecAxisAlignedPointCoordinates< NumDimensions >::Origin

private

Spacing

template<viskores::IdComponent NumDimensions>

ComponentType viskores::VecAxisAlignedPointCoordinates< NumDimensions >::Spacing

private

---

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

• VecAxisAlignedPointCoordinates.h