vtkm::rendering::Actor Class Reference

An item to be rendered. More...

#include <Actor.h>

Public Member Functions
	Actor (const vtkm::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName)
	Actor (const vtkm::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName, const vtkm::cont::ColorTable &colorTable)
	Actor (const vtkm::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName, const vtkm::rendering::Color &color)
	Actor (const vtkm::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName)
	Actor (const vtkm::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName, const vtkm::cont::ColorTable &colorTable)
	Actor (const vtkm::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName, const vtkm::rendering::Color &color)
	Actor (const vtkm::cont::UnknownCellSet &cells, const vtkm::cont::CoordinateSystem &coordinates, const vtkm::cont::Field &scalarField)
	Create an Actor object that renders a set of cells positioned by a given coordiante system. More...
	Actor (const vtkm::cont::UnknownCellSet &cells, const vtkm::cont::CoordinateSystem &coordinates, const vtkm::cont::Field &scalarField, const vtkm::cont::ColorTable &colorTable)
	Create an Actor object that renders a set of cells positioned by a given coordiante system. More...
	Actor (const vtkm::cont::UnknownCellSet &cells, const vtkm::cont::CoordinateSystem &coordinates, const vtkm::cont::Field &scalarField, const vtkm::rendering::Color &color)
	Create an Actor object that renders a set of cells positioned by a given coordiante system. More...
	Actor (const Actor &)
Actor &	operator= (const Actor &)
	Actor (Actor &&) noexcept
Actor &	operator= (Actor &&) noexcept
	~Actor ()
void	Render (vtkm::rendering::Mapper &mapper, vtkm::rendering::Canvas &canvas, const vtkm::rendering::Camera &camera) const
const vtkm::cont::UnknownCellSet &	GetCells () const
vtkm::cont::CoordinateSystem	GetCoordinates () const
const vtkm::cont::Field &	GetScalarField () const
const vtkm::cont::ColorTable &	GetColorTable () const
const vtkm::Range &	GetScalarRange () const
const vtkm::Bounds &	GetSpatialBounds () const
void	SetScalarRange (const vtkm::Range &scalarRange)
	Specifies the range for psudocoloring. More...

Private Member Functions
void	Init (const vtkm::cont::CoordinateSystem &coordinates, const vtkm::cont::Field &scalarField)
void	Init ()

Private Attributes
std::unique_ptr< InternalsType >	Internals

Detailed Description

An item to be rendered.

The Actor holds the geometry from a vtkm::cont::DataSet as well as other visual properties that define how the geometry should look when it is rendered.

Constructor & Destructor Documentation

Actor() [1/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::DataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName
	)

Actor() [2/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::DataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName,
		const vtkm::cont::ColorTable &	colorTable
	)

Actor() [3/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::DataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName,
		const vtkm::rendering::Color &	color
	)

Actor() [4/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::PartitionedDataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName
	)

Actor() [5/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::PartitionedDataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName,
		const vtkm::cont::ColorTable &	colorTable
	)

Actor() [6/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::PartitionedDataSet	dataSet,
		const std::string	coordinateName,
		const std::string	fieldName,
		const vtkm::rendering::Color &	color
	)

Actor() [7/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::UnknownCellSet &	cells,
		const vtkm::cont::CoordinateSystem &	coordinates,
		const vtkm::cont::Field &	scalarField
	)

Create an Actor object that renders a set of cells positioned by a given coordiante system.

A field to apply psudocoloring is also provided. The default colormap is applied. The cells, coordinates, and field are typically pulled from a vtkm::cont::DataSet object.

Actor() [8/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::UnknownCellSet &	cells,
		const vtkm::cont::CoordinateSystem &	coordinates,
		const vtkm::cont::Field &	scalarField,
		const vtkm::cont::ColorTable &	colorTable
	)

Create an Actor object that renders a set of cells positioned by a given coordiante system.

A field to apply psudocoloring is also provided. A color table providing the map from scalar values to colors is also provided. The cells, coordinates, and field are typically pulled from a vtkm::cont::DataSet object.

Actor() [9/11]

vtkm::rendering::Actor::Actor	(	const vtkm::cont::UnknownCellSet &	cells,
		const vtkm::cont::CoordinateSystem &	coordinates,
		const vtkm::cont::Field &	scalarField,
		const vtkm::rendering::Color &	color
	)

Create an Actor object that renders a set of cells positioned by a given coordiante system.

A constant color to apply to the object is also provided. The cells and coordinates are typically pulled from a vtkm::cont::DataSet object.

Actor() [10/11]

vtkm::rendering::Actor::Actor

(

const Actor &

)

Actor() [11/11]

vtkm::rendering::Actor::Actor ( Actor &&  )

noexcept

~Actor()

vtkm::rendering::Actor::~Actor

(

)

Member Function Documentation

GetCells()

const vtkm::cont::UnknownCellSet& vtkm::rendering::Actor::GetCells

(

)

const

GetColorTable()

const vtkm::cont::ColorTable& vtkm::rendering::Actor::GetColorTable

(

)

const

GetCoordinates()

vtkm::cont::CoordinateSystem vtkm::rendering::Actor::GetCoordinates

(

)

const

GetScalarField()

const vtkm::cont::Field& vtkm::rendering::Actor::GetScalarField

(

)

const

GetScalarRange()

const vtkm::Range& vtkm::rendering::Actor::GetScalarRange

(

)

const

GetSpatialBounds()

const vtkm::Bounds& vtkm::rendering::Actor::GetSpatialBounds

(

)

const

Init() [1/2]

void vtkm::rendering::Actor::Init ( )

private

Init() [2/2]

void vtkm::rendering::Actor::Init ( const vtkm::cont::CoordinateSystem &  coordinates, const vtkm::cont::Field &  scalarField  )

private

operator=() [1/2]

Actor& vtkm::rendering::Actor::operator= ( Actor &&  )

noexcept

operator=() [2/2]

Actor& vtkm::rendering::Actor::operator=

(

const Actor &

)

Render()

void vtkm::rendering::Actor::Render	(	vtkm::rendering::Mapper &	mapper,
		vtkm::rendering::Canvas &	canvas,
		const vtkm::rendering::Camera &	camera
	)		const

SetScalarRange()

void vtkm::rendering::Actor::SetScalarRange

(

const vtkm::Range &

scalarRange

)

Specifies the range for psudocoloring.

When coloring data by mapping a scalar field to colors, this is the range used for the colors provided by the table. If a range is not provided, the range of data in the field is used.

Member Data Documentation

Internals

std::unique_ptr<InternalsType> vtkm::rendering::Actor::Internals

private

---

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

• Actor.h