vtkm::worklet::ScalarsToColors Class Reference

#include <ScalarsToColors.h>

Public Member Functions
	ScalarsToColors ()
	ScalarsToColors (const vtkm::Range &range, vtkm::Float32 alpha)
	ScalarsToColors (const vtkm::Range &range)
	ScalarsToColors (vtkm::Float32 alpha)
void	SetRange (const vtkm::Range &range)
vtkm::Range	GetRange () const
void	SetAlpha (vtkm::Float32 alpha)
vtkm::Float32	GetAlpha () const
template<typename T , typename S >
void	Run (const vtkm::cont::ArrayHandle< T, S > &values, vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &rgbaOut) const
	Use each component to generate RGBA colors. More...
template<typename T , typename S >
void	Run (const vtkm::cont::ArrayHandle< T, S > &values, vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &rgbOut) const
	Use each component to generate RGB colors. More...
template<typename T , int N, typename S >
void	RunMagnitude (const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &values, vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &rgbaOut) const
	Use magnitude of a vector to generate RGBA colors. More...
template<typename T , int N, typename S >
void	RunMagnitude (const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &values, vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &rgbOut) const
	Use magnitude of a vector to generate RGB colors. More...
template<typename T , int N, typename S >
void	RunComponent (const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &values, vtkm::IdComponent comp, vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &rgbaOut) const
	Use a single component of a vector to generate RGBA colors. More...
template<typename T , int N, typename S >
void	RunComponent (const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &values, vtkm::IdComponent comp, vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &rgbOut) const
	Use a single component of a vector to generate RGB colors. More...

Private Attributes
vtkm::Range	ValueRange = { 0.0f, 255.0f }
vtkm::Float32	Alpha = 1.0f
vtkm::Float32	Shift = 0.0f
vtkm::Float32	Scale = 1.0f

Constructor & Destructor Documentation

ScalarsToColors() [1/4]

vtkm::worklet::ScalarsToColors::ScalarsToColors ( )

inline

ScalarsToColors() [2/4]

vtkm::worklet::ScalarsToColors::ScalarsToColors ( const vtkm::Range &  range, vtkm::Float32  alpha  )

inline

ScalarsToColors() [3/4]

vtkm::worklet::ScalarsToColors::ScalarsToColors ( const vtkm::Range &  range )

inline

ScalarsToColors() [4/4]

vtkm::worklet::ScalarsToColors::ScalarsToColors ( vtkm::Float32  alpha )

inline

Member Function Documentation

GetAlpha()

vtkm::Float32 vtkm::worklet::ScalarsToColors::GetAlpha ( ) const

inline

GetRange()

vtkm::Range vtkm::worklet::ScalarsToColors::GetRange ( ) const

inline

Run() [1/2]

template<typename T , typename S >

void vtkm::worklet::ScalarsToColors::Run	(	const vtkm::cont::ArrayHandle< T, S > &	values,
		vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &	rgbOut
	)		const

Use each component to generate RGB colors.

Run() [2/2]

template<typename T , typename S >

void vtkm::worklet::ScalarsToColors::Run	(	const vtkm::cont::ArrayHandle< T, S > &	values,
		vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &	rgbaOut
	)		const

Use each component to generate RGBA colors.

RunComponent() [1/2]

template<typename T , int N, typename S >

void vtkm::worklet::ScalarsToColors::RunComponent	(	const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &	values,
		vtkm::IdComponent	comp,
		vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &	rgbOut
	)		const

Use a single component of a vector to generate RGB colors.

RunComponent() [2/2]

template<typename T , int N, typename S >

void vtkm::worklet::ScalarsToColors::RunComponent	(	const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &	values,
		vtkm::IdComponent	comp,
		vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &	rgbaOut
	)		const

Use a single component of a vector to generate RGBA colors.

RunMagnitude() [1/2]

template<typename T , int N, typename S >

void vtkm::worklet::ScalarsToColors::RunMagnitude	(	const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &	values,
		vtkm::cont::ArrayHandle< vtkm::Vec3ui_8 > &	rgbOut
	)		const

Use magnitude of a vector to generate RGB colors.

RunMagnitude() [2/2]

template<typename T , int N, typename S >

void vtkm::worklet::ScalarsToColors::RunMagnitude	(	const vtkm::cont::ArrayHandle< vtkm::Vec< T, N >, S > &	values,
		vtkm::cont::ArrayHandle< vtkm::Vec4ui_8 > &	rgbaOut
	)		const

Use magnitude of a vector to generate RGBA colors.

SetAlpha()

void vtkm::worklet::ScalarsToColors::SetAlpha ( vtkm::Float32  alpha )

inline

SetRange()

void vtkm::worklet::ScalarsToColors::SetRange ( const vtkm::Range &  range )

inline

Member Data Documentation

Alpha

vtkm::Float32 vtkm::worklet::ScalarsToColors::Alpha = 1.0f

private

Scale

vtkm::Float32 vtkm::worklet::ScalarsToColors::Scale = 1.0f

private

Shift

vtkm::Float32 vtkm::worklet::ScalarsToColors::Shift = 0.0f

private

ValueRange

vtkm::Range vtkm::worklet::ScalarsToColors::ValueRange = { 0.0f, 255.0f }

private

---

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

• ScalarsToColors.h