HdExtComputationContext Class Reference

#include <extComputationContext.h>

Inheritance diagram for HdExtComputationContext:

Public Member Functions
	HdExtComputationContext ()=default
virtual	~HdExtComputationContext ()
virtual const VtValue &	GetInputValue (const TfToken &name) const =0
template<typename T >
T	GetTypedInputValue (const TfToken &name) const
virtual const VtValue *	GetOptionalInputValuePtr (const TfToken &name) const =0
template<typename T >
const T *	GetOptionalTypedInputValuePtr (const TfToken &name) const
virtual void	SetOutputValue (const TfToken &name, const VtValue &output)=0
template<typename T >
void	SetTypedOutputValue (const TfToken &name, const T &output)
virtual void	RaiseComputationError ()=0

Detailed Description

Interface class that defines the execution environment for the client to run a computation.

Definition at line 20 of file extComputationContext.h.

Constructor & Destructor Documentation

HdExtComputationContext::HdExtComputationContext ( )

default

virtual HdExtComputationContext::~HdExtComputationContext ( )

virtual

Member Function Documentation

virtual const VtValue& HdExtComputationContext::GetInputValue ( const TfToken &  name ) const

pure virtual

Obtains the value of an named input to the computation.

The code will issue a coding error and return a empty value if the input is missing.

Implemented in HdExtComputationContextInternal.

virtual const VtValue* HdExtComputationContext::GetOptionalInputValuePtr ( const TfToken &  name ) const

pure virtual

Obtains the value of an named input to the computation.

If the input isn't present, a nullptr will be returned.

Implemented in HdExtComputationContextInternal.

template<typename T >

const T * HdExtComputationContext::GetOptionalTypedInputValuePtr

(

const TfToken &

name

)

const

Obtains the value of an named input to the computation.

If the input isn't present, a nullptr will be returned. If the input is of the wrong type, a coding error will be issued and a nullptr will be returned.

Definition at line 101 of file extComputationContext.h.

template<typename T >

T HdExtComputationContext::GetTypedInputValue

(

const TfToken &

name

)

const

Obtains the value of an named input to the computation.

The code will issue a coding error and return a default constructed value if the input is missing or is of the wrong type.

Definition at line 85 of file extComputationContext.h.

virtual void HdExtComputationContext::RaiseComputationError ( )

pure virtual

Called to indicate an error occurred while executing a computation so that its output are invalid.

Implemented in HdExtComputationContextInternal.

virtual void HdExtComputationContext::SetOutputValue ( const TfToken &  name, const VtValue &  output  )

pure virtual

Set the value of the specified output.

Implemented in HdExtComputationContextInternal.

template<typename T >

void HdExtComputationContext::SetTypedOutputValue	(	const TfToken &	name,
		const T &	output
	)

Set the value of the specified output.

Definition at line 122 of file extComputationContext.h.

---

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

• pxr/imaging/hd/extComputationContext.h