Inheritance diagram for HdExtComputationContext:

Public Member Functions
	HdExtComputationContext ()=default

virtual	~HdExtComputationContext ()

virtual const VtValue &	GetInputValue (const TfToken &name) const =0

virtual const VtValue *	GetOptionalInputValuePtr (const TfToken &name) const =0

virtual void	SetOutputValue (const TfToken &name, const VtValue &output)=0

virtual void	RaiseComputationError ()=0

Detailed Description

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

Definition at line 37 of file extComputationContext.h.

Constructor & Destructor Documentation

HdExtComputationContext::HdExtComputationContext ( )

default

virtual HdExtComputationContext::~HdExtComputationContext ( )

virtual

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 array if the input is missing or of a different type.

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 or of a different type nullptr will be returned.

virtual void HdExtComputationContext::RaiseComputationError ( )

pure virtual

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

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

pure virtual

Set the value of the specified output.

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