viskores::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 viskores::cont::UnknownCellSet &cells, const viskores::cont::CoordinateSystem &coordinates, const viskores::cont::Field &field0={}, const viskores::cont::Field &field1={}, const viskores::cont::Field &field2={}, const viskores::cont::Field &field3={})
	Main constructor taking cells, coordinates, and up to 4 fields. More...
	ANARIActor (const viskores::cont::UnknownCellSet &cells, const viskores::cont::CoordinateSystem &coordinates, const FieldSet &fieldset)
	Convenience constructor when an entire FieldSet already exists. More...
	ANARIActor (const viskores::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 viskores::cont::UnknownCellSet &	GetCellSet () const
const viskores::cont::CoordinateSystem &	GetCoordinateSystem () const
const viskores::cont::Field &	GetField (viskores::IdComponent idx=-1) const
FieldSet	GetFieldSet () const
void	SetPrimaryFieldIndex (viskores::IdComponent idx)
viskores::IdComponent	GetPrimaryFieldIndex () const
viskores::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]

viskores::interop::anari::ANARIActor::ANARIActor ( )

default

ANARIActor() [2/4]

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

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

ANARIActor() [3/4]

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

Convenience constructor when an entire FieldSet already exists.

ANARIActor() [4/4]

viskores::interop::anari::ANARIActor::ANARIActor	(	const viskores::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 viskores::cont::UnknownCellSet& viskores::interop::anari::ANARIActor::GetCellSet

(

)

const

GetCoordinateSystem()

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

(

)

const

GetField()

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

(

viskores::IdComponent

idx = -1

)

const

GetFieldSet()

FieldSet viskores::interop::anari::ANARIActor::GetFieldSet

(

)

const

GetPrimaryFieldIndex()

viskores::IdComponent viskores::interop::anari::ANARIActor::GetPrimaryFieldIndex

(

)

const

MakeDataSet()

viskores::cont::DataSet viskores::interop::anari::ANARIActor::MakeDataSet

(

bool

includeFields = false

)

const

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

SetPrimaryFieldIndex()

void viskores::interop::anari::ANARIActor::SetPrimaryFieldIndex

(

viskores::IdComponent

idx

)

Member Data Documentation

Data

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

private

---

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

• ANARIActor.h