Inheritance diagram for HdExtComputationContextInternal:

Public Member Functions
HD_API	HdExtComputationContextInternal ()

virtual HD_API	~HdExtComputationContextInternal ()

virtual HD_API const VtValue &	GetInputValue (const TfToken &name) const override

virtual HD_API const VtValue *	GetOptionalInputValuePtr (const TfToken &name) const override

virtual HD_API void	SetOutputValue (const TfToken &name, const VtValue &output) override

HD_API void	SetInputValue (const TfToken &name, const VtValue &input)

HD_API bool	GetOutputValue (const TfToken &name, VtValue *output) const

HD_API bool	HasComputationError ()

virtual HD_API void	RaiseComputationError () override

Public Member Functions inherited from HdExtComputationContext
	HdExtComputationContext ()=default

virtual	~HdExtComputationContext ()

Detailed Description

Hydra implementation of the HdExtComputationContext public interface. The class provides additional API for setting up the context.

Constructor & Destructor Documentation

HD_API HdExtComputationContextInternal::HdExtComputationContextInternal ( )

virtual HD_API HdExtComputationContextInternal::~HdExtComputationContextInternal ( )

virtual

virtual HD_API const VtValue& HdExtComputationContextInternal::GetInputValue ( const TfToken & name ) const

overridevirtual

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.

virtual HD_API const VtValue* HdExtComputationContextInternal::GetOptionalInputValuePtr ( const TfToken & name ) const

overridevirtual

Obtains the value of an named input to the computation.

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

HD_API bool HdExtComputationContextInternal::GetOutputValue	(	const TfToken &	name,
		VtValue *	output
	)		const

Fetches the named output from the execution environment. returns false if the output is not present.

HD_API bool HdExtComputationContextInternal::HasComputationError ( )

returns true is an error occur in processing, such that the outputs are invalid.

virtual HD_API void HdExtComputationContextInternal::RaiseComputationError ( )

overridevirtual

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

HD_API void HdExtComputationContextInternal::SetInputValue	(	const TfToken &	name,
		const VtValue &	input
	)

Adds the named input to the execution environment. If the input already exists, the value is not replaced.

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

overridevirtual

Sets the value of the specified output.

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