Viskores  1.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
viskores::rendering::Actor Class Reference

An item to be rendered. More...

#include <Actor.h>

Public Member Functions

 Actor (const viskores::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName)
 
 Actor (const viskores::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName, const viskores::cont::ColorTable &colorTable)
 
 Actor (const viskores::cont::DataSet dataSet, const std::string coordinateName, const std::string fieldName, const viskores::rendering::Color &color)
 
 Actor (const viskores::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName)
 
 Actor (const viskores::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName, const viskores::cont::ColorTable &colorTable)
 
 Actor (const viskores::cont::PartitionedDataSet dataSet, const std::string coordinateName, const std::string fieldName, const viskores::rendering::Color &color)
 
 Actor (const viskores::cont::UnknownCellSet &cells, const viskores::cont::CoordinateSystem &coordinates, const viskores::cont::Field &scalarField)
 Create an Actor object that renders a set of cells positioned by a given coordiante system. More...
 
 Actor (const viskores::cont::UnknownCellSet &cells, const viskores::cont::CoordinateSystem &coordinates, const viskores::cont::Field &scalarField, const viskores::cont::ColorTable &colorTable)
 Create an Actor object that renders a set of cells positioned by a given coordiante system. More...
 
 Actor (const viskores::cont::UnknownCellSet &cells, const viskores::cont::CoordinateSystem &coordinates, const viskores::cont::Field &scalarField, const viskores::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 (viskores::rendering::Mapper &mapper, viskores::rendering::Canvas &canvas, const viskores::rendering::Camera &camera) const
 
const viskores::cont::UnknownCellSet & GetCells () const
 
viskores::cont::CoordinateSystem GetCoordinates () const
 
const viskores::cont::Field & GetScalarField () const
 
const viskores::cont::ColorTable & GetColorTable () const
 
const viskores::Range & GetScalarRange () const
 
const viskores::Bounds & GetSpatialBounds () const
 
void SetScalarRange (const viskores::Range &scalarRange)
 Specifies the range for psudocoloring. More...
 

Private Member Functions

void Init (const viskores::cont::CoordinateSystem &coordinates, const viskores::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 viskores::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]

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

◆ Actor() [2/11]

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

◆ Actor() [3/11]

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

◆ Actor() [4/11]

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

◆ Actor() [5/11]

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

◆ Actor() [6/11]

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

◆ Actor() [7/11]

viskores::rendering::Actor::Actor ( const viskores::cont::UnknownCellSet &  cells,
const viskores::cont::CoordinateSystem &  coordinates,
const viskores::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 viskores::cont::DataSet object.

◆ Actor() [8/11]

viskores::rendering::Actor::Actor ( const viskores::cont::UnknownCellSet &  cells,
const viskores::cont::CoordinateSystem &  coordinates,
const viskores::cont::Field &  scalarField,
const viskores::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 viskores::cont::DataSet object.

◆ Actor() [9/11]

viskores::rendering::Actor::Actor ( const viskores::cont::UnknownCellSet &  cells,
const viskores::cont::CoordinateSystem &  coordinates,
const viskores::cont::Field &  scalarField,
const viskores::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 viskores::cont::DataSet object.

◆ Actor() [10/11]

viskores::rendering::Actor::Actor ( const Actor &  )

◆ Actor() [11/11]

viskores::rendering::Actor::Actor ( Actor &&  )
noexcept

◆ ~Actor()

viskores::rendering::Actor::~Actor ( )

Member Function Documentation

◆ GetCells()

const viskores::cont::UnknownCellSet& viskores::rendering::Actor::GetCells ( ) const

◆ GetColorTable()

const viskores::cont::ColorTable& viskores::rendering::Actor::GetColorTable ( ) const

◆ GetCoordinates()

viskores::cont::CoordinateSystem viskores::rendering::Actor::GetCoordinates ( ) const

◆ GetScalarField()

const viskores::cont::Field& viskores::rendering::Actor::GetScalarField ( ) const

◆ GetScalarRange()

const viskores::Range& viskores::rendering::Actor::GetScalarRange ( ) const

◆ GetSpatialBounds()

const viskores::Bounds& viskores::rendering::Actor::GetSpatialBounds ( ) const

◆ Init() [1/2]

void viskores::rendering::Actor::Init ( )
private

◆ Init() [2/2]

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

◆ operator=() [1/2]

Actor& viskores::rendering::Actor::operator= ( Actor &&  )
noexcept

◆ operator=() [2/2]

Actor& viskores::rendering::Actor::operator= ( const Actor &  )

◆ Render()

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

◆ SetScalarRange()

void viskores::rendering::Actor::SetScalarRange ( const viskores::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> viskores::rendering::Actor::Internals
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17