vtkm::interop::anari::ANARIActor Struct Reference

Collects cells, coords, and 0-4 fields for ANARI mappers to consume. More...

#include <ANARIActor.h>

Classes
struct	ActorData

Public Member Functions
	ANARIActor ()=default
	ANARIActor (const vtkm::cont::UnknownCellSet &cells, const vtkm::cont::CoordinateSystem &coordinates, const vtkm::cont::Field &field0={}, const vtkm::cont::Field &field1={}, const vtkm::cont::Field &field2={}, const vtkm::cont::Field &field3={})
	Main constructor taking cells, coordinates, and up to 4 fields. More...
	ANARIActor (const vtkm::cont::UnknownCellSet &cells, const vtkm::cont::CoordinateSystem &coordinates, const FieldSet &fieldset)
	Convenience constructor when an entire FieldSet already exists. More...
	ANARIActor (const vtkm::cont::DataSet &dataset, const std::string &field0="", const std::string &field1="", const std::string &field2="", const std::string &field3="")
	Convenience constructor using a dataset + named fields. More...
const vtkm::cont::UnknownCellSet &	GetCellSet () const
const vtkm::cont::CoordinateSystem &	GetCoordinateSystem () const
const vtkm::cont::Field &	GetField (vtkm::IdComponent idx=-1) const
FieldSet	GetFieldSet () const
void	SetPrimaryFieldIndex (vtkm::IdComponent idx)
vtkm::IdComponent	GetPrimaryFieldIndex () const
vtkm::cont::DataSet	MakeDataSet (bool includeFields=false) const
	Utility to reconstitute a DataSet from the items in the actor. More...

Private Attributes
std::shared_ptr< ActorData >	Data = std::make_shared<ActorData>()

Detailed Description

Collects cells, coords, and 0-4 fields for ANARI mappers to consume.

ANARIActor represents a selected set of cells, coordinates, and fields for ANARIMapper based mappers to map onto ANARI objects. This class also maintains which field is the "main" field, which almost always is the field which is used to color the geometry or volume.

Mappers creating geometry will generally add all fields as attribute arrays if possible, letting applications use more than one field as material inputs or data to be color mapped by samplers.

Constructor & Destructor Documentation

ANARIActor() [1/4]

vtkm::interop::anari::ANARIActor::ANARIActor ( )

default

ANARIActor() [2/4]

vtkm::interop::anari::ANARIActor::ANARIActor	(	const vtkm::cont::UnknownCellSet &	cells,
		const vtkm::cont::CoordinateSystem &	coordinates,
		const vtkm::cont::Field &	field0 = {},
		const vtkm::cont::Field &	field1 = {},
		const vtkm::cont::Field &	field2 = {},
		const vtkm::cont::Field &	field3 = {}
	)

Main constructor taking cells, coordinates, and up to 4 fields.

ANARIActor() [3/4]

vtkm::interop::anari::ANARIActor::ANARIActor	(	const vtkm::cont::UnknownCellSet &	cells,
		const vtkm::cont::CoordinateSystem &	coordinates,
		const FieldSet &	fieldset
	)

Convenience constructor when an entire FieldSet already exists.

ANARIActor() [4/4]

vtkm::interop::anari::ANARIActor::ANARIActor	(	const vtkm::cont::DataSet &	dataset,
		const std::string &	field0 = "",
		const std::string &	field1 = "",
		const std::string &	field2 = "",
		const std::string &	field3 = ""
	)

Convenience constructor using a dataset + named fields.

Member Function Documentation

GetCellSet()

const vtkm::cont::UnknownCellSet& vtkm::interop::anari::ANARIActor::GetCellSet

(

)

const

GetCoordinateSystem()

const vtkm::cont::CoordinateSystem& vtkm::interop::anari::ANARIActor::GetCoordinateSystem

(

)

const

GetField()

const vtkm::cont::Field& vtkm::interop::anari::ANARIActor::GetField

(

vtkm::IdComponent

idx = -1

)

const

GetFieldSet()

FieldSet vtkm::interop::anari::ANARIActor::GetFieldSet

(

)

const

GetPrimaryFieldIndex()

vtkm::IdComponent vtkm::interop::anari::ANARIActor::GetPrimaryFieldIndex

(

)

const

MakeDataSet()

vtkm::cont::DataSet vtkm::interop::anari::ANARIActor::MakeDataSet

(

bool

includeFields = false

)

const

Utility to reconstitute a DataSet from the items in the actor.

SetPrimaryFieldIndex()

void vtkm::interop::anari::ANARIActor::SetPrimaryFieldIndex

(

vtkm::IdComponent

idx

)

Member Data Documentation

Data

std::shared_ptr<ActorData> vtkm::interop::anari::ANARIActor::Data = std::make_shared<ActorData>()

private

---

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

• ANARIActor.h