HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdMaterialNetwork2Interface Class Reference

#include <materialNetwork2Interface.h>

+ Inheritance diagram for HdMaterialNetwork2Interface:

Public Member Functions

 HdMaterialNetwork2Interface (const SdfPath &materialPrimPath, HdMaterialNetwork2 *materialNetwork)
 
HD_API SdfPath GetMaterialPrimPath () const override
 
HD_API TfTokenVector GetMaterialConfigKeys () const override
 
HD_API VtValue GetMaterialConfigValue (const TfToken &key) const override
 
HD_API std::string GetModelAssetName () const override
 
HD_API TfTokenVector GetNodeNames () const override
 
HD_API TfToken GetNodeType (const TfToken &nodeName) const override
 
HD_API TfTokenVector GetNodeTypeInfoKeys (const TfToken &nodeName) const override
 
HD_API VtValue GetNodeTypeInfoValue (const TfToken &nodeName, const TfToken &key) const override
 
HD_API TfTokenVector GetAuthoredNodeParameterNames (const TfToken &nodeName) const override
 
HD_API VtValue GetNodeParameterValue (const TfToken &nodeName, const TfToken &paramName) const override
 
HD_API NodeParamData GetNodeParameterData (const TfToken &nodeName, const TfToken &paramName) const override
 
HD_API TfTokenVector GetNodeInputConnectionNames (const TfToken &nodeName) const override
 
HD_API InputConnectionVector GetNodeInputConnection (const TfToken &nodeName, const TfToken &inputName) const override
 
HD_API void DeleteNode (const TfToken &nodeName) override
 
HD_API void SetNodeType (const TfToken &nodeName, const TfToken &nodeType) override
 
virtual HD_API void SetNodeTypeInfoValue (const TfToken &nodeName, const TfToken &key, const VtValue &value) override
 
HD_API void SetNodeParameterValue (const TfToken &nodeName, const TfToken &paramName, const VtValue &value) override
 
HD_API void SetNodeParameterData (const TfToken &nodeName, const TfToken &paramName, const NodeParamData &paramData) override
 
HD_API void DeleteNodeParameter (const TfToken &nodeName, const TfToken &paramName) override
 
HD_API void SetNodeInputConnection (const TfToken &nodeName, const TfToken &inputName, const InputConnectionVector &connections) override
 
HD_API void DeleteNodeInputConnection (const TfToken &nodeName, const TfToken &inputName) override
 
HD_API TfTokenVector GetTerminalNames () const override
 
HD_API InputConnectionResult GetTerminalConnection (const TfToken &terminalName) const override
 
HD_API void DeleteTerminal (const TfToken &terminalName) override
 
HD_API void SetTerminalConnection (const TfToken &terminalName, const InputConnection &connection) override
 
- Public Member Functions inherited from HdMaterialNetworkInterface
virtual ~HdMaterialNetworkInterface ()=default
 

Additional Inherited Members

- Public Types inherited from HdMaterialNetworkInterface
using InputConnectionVector = TfSmallVector< InputConnection, 4 >
 
using InputConnectionResult = std::pair< bool, InputConnection >
 

Detailed Description

Implements HdMaterialNetworkInterface interface backed by an HdMaterialNetwork2 – which is useful for implementing material filtering functions without being tied to the legacy data model

Definition at line 22 of file materialNetwork2Interface.h.

Constructor & Destructor Documentation

HdMaterialNetwork2Interface::HdMaterialNetwork2Interface ( const SdfPath materialPrimPath,
HdMaterialNetwork2 materialNetwork 
)
inline

Definition at line 27 of file materialNetwork2Interface.h.

Member Function Documentation

HD_API void HdMaterialNetwork2Interface::DeleteNode ( const TfToken nodeName)
overridevirtual
HD_API void HdMaterialNetwork2Interface::DeleteNodeInputConnection ( const TfToken nodeName,
const TfToken inputName 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::DeleteNodeParameter ( const TfToken nodeName,
const TfToken paramName 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::DeleteTerminal ( const TfToken terminalName)
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetAuthoredNodeParameterNames ( const TfToken nodeName) const
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetMaterialConfigKeys ( ) const
overridevirtual

Material config is a collection of data related to the entire material, e.g. material definition version, etc.

Similarly to GetNodeTypeInfoXXX() below, only getters are provided, as we don't intend to mutate this config data.

Implements HdMaterialNetworkInterface.

HD_API VtValue HdMaterialNetwork2Interface::GetMaterialConfigValue ( const TfToken key) const
overridevirtual
HD_API SdfPath HdMaterialNetwork2Interface::GetMaterialPrimPath ( ) const
inlineoverridevirtual

Implements HdMaterialNetworkInterface.

Definition at line 36 of file materialNetwork2Interface.h.

HD_API std::string HdMaterialNetwork2Interface::GetModelAssetName ( ) const
inlineoverridevirtual

Returns the nearest enclosing model asset name, as described by the model schema, or empty string if none is available.

Implements HdMaterialNetworkInterface.

Definition at line 46 of file materialNetwork2Interface.h.

HD_API InputConnectionVector HdMaterialNetwork2Interface::GetNodeInputConnection ( const TfToken nodeName,
const TfToken inputName 
) const
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetNodeInputConnectionNames ( const TfToken nodeName) const
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetNodeNames ( ) const
overridevirtual
HD_API NodeParamData HdMaterialNetwork2Interface::GetNodeParameterData ( const TfToken nodeName,
const TfToken paramName 
) const
overridevirtual
HD_API VtValue HdMaterialNetwork2Interface::GetNodeParameterValue ( const TfToken nodeName,
const TfToken paramName 
) const
overridevirtual
HD_API TfToken HdMaterialNetwork2Interface::GetNodeType ( const TfToken nodeName) const
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetNodeTypeInfoKeys ( const TfToken nodeName) const
overridevirtual

Node type info is a collection of data related to the node type, often used to determine the node type.

Implements HdMaterialNetworkInterface.

HD_API VtValue HdMaterialNetwork2Interface::GetNodeTypeInfoValue ( const TfToken nodeName,
const TfToken key 
) const
overridevirtual
HD_API InputConnectionResult HdMaterialNetwork2Interface::GetTerminalConnection ( const TfToken terminalName) const
overridevirtual
HD_API TfTokenVector HdMaterialNetwork2Interface::GetTerminalNames ( ) const
overridevirtual

Terminal query & mutation

Implements HdMaterialNetworkInterface.

HD_API void HdMaterialNetwork2Interface::SetNodeInputConnection ( const TfToken nodeName,
const TfToken inputName,
const InputConnectionVector connections 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::SetNodeParameterData ( const TfToken nodeName,
const TfToken paramName,
const NodeParamData paramData 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::SetNodeParameterValue ( const TfToken nodeName,
const TfToken paramName,
const VtValue value 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::SetNodeType ( const TfToken nodeName,
const TfToken nodeType 
)
overridevirtual
virtual HD_API void HdMaterialNetwork2Interface::SetNodeTypeInfoValue ( const TfToken nodeName,
const TfToken key,
const VtValue value 
)
overridevirtual
HD_API void HdMaterialNetwork2Interface::SetTerminalConnection ( const TfToken terminalName,
const InputConnection connection 
)
overridevirtual

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