Public Member Functions | List of all members
HdExtComputationContextInternal Class Referencefinal

Hydra implementation of the HdExtComputationContext public interface. More...

+ Inheritance diagram for HdExtComputationContextInternal:

Public Member Functions

virtual HD_API const VtValue & GetInputValue (const TfToken &name) const override
 Obtains the value of an named input to the computation. More...
 
virtual HD_API const VtValue * GetOptionalInputValuePtr (const TfToken &name) const override
 Obtains the value of an named input to the computation. More...
 
virtual HD_API void SetOutputValue (const TfToken &name, const VtValue &output) override
 Sets the value of the specified output. More...
 
HD_API void SetInputValue (const TfToken &name, const VtValue &input)
 Adds the named input to the execution environment. More...
 
HD_API bool GetOutputValue (const TfToken &name, VtValue *output) const
 Fetches the named output from the execution environment. More...
 
HD_API bool HasComputationError ()
 returns true is an error occur in processing, such that the outputs are invalid. More...
 
virtual HD_API void RaiseComputationError () override
 Called to indicate an error occurred while executing a computation so that it's output are invalid. More...
 

Detailed Description

Hydra implementation of the HdExtComputationContext public interface.

The class provides additional API for setting up the context.

Definition at line 40 of file extComputationContextInternal.h.

Member Function Documentation

◆ GetInputValue()

virtual HD_API const VtValue& 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.

Implements HdExtComputationContext.

◆ GetOptionalInputValuePtr()

virtual HD_API const VtValue* 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.

Implements HdExtComputationContext.

◆ GetOutputValue()

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

Fetches the named output from the execution environment.

returns false if the output is not present.

◆ HasComputationError()

HD_API bool HasComputationError ( )

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

◆ RaiseComputationError()

virtual HD_API void RaiseComputationError ( )
overridevirtual

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

Implements HdExtComputationContext.

◆ SetInputValue()

HD_API void 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.

◆ SetOutputValue()

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

Sets the value of the specified output.

Implements HdExtComputationContext.

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