Loading...
Searching...
No Matches
HdMaterialNetwork2Interface Class Reference

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

#include <materialNetwork2Interface.h>

+ Inheritance diagram for HdMaterialNetwork2Interface:

Public Member Functions

 HdMaterialNetwork2Interface (const SdfPath &materialPrimPath, HdMaterialNetwork2 *materialNetwork)
 
HD_API SdfPath GetMaterialPrimPath () const override
 
HD_API std::string GetModelAssetName () const override
 Returns the nearest enclosing model asset name, as described by the model schema, or empty string if none is available.
 
HD_API TfTokenVector GetNodeNames () const override
 
HD_API TfToken GetNodeType (const TfToken &nodeName) const override
 
HD_API TfTokenVector GetNodeTypeInfoKeys (const TfToken &nodeName) const override
 Node type info is a collection of data related to the node type, often used to determine the node type.
 
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
 
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
 
virtual SdfPath GetMaterialPrimPath () const =0
 
virtual std::string GetModelAssetName () const =0
 Returns the nearest enclosing model asset name, as described by the model schema, or empty string if none is available.
 
virtual TfTokenVector GetNodeNames () const =0
 
virtual TfToken GetNodeType (const TfToken &nodeName) const =0
 
virtual TfTokenVector GetNodeTypeInfoKeys (const TfToken &nodeName) const =0
 Node type info is a collection of data related to the node type, often used to determine the node type.
 
virtual VtValue GetNodeTypeInfoValue (const TfToken &nodeName, const TfToken &key) const =0
 
virtual TfTokenVector GetAuthoredNodeParameterNames (const TfToken &nodeName) const =0
 
virtual VtValue GetNodeParameterValue (const TfToken &nodeName, const TfToken &paramName) const =0
 
virtual NodeParamData GetNodeParameterData (const TfToken &nodeName, const TfToken &paramName) const =0
 
virtual TfTokenVector GetNodeInputConnectionNames (const TfToken &nodeName) const =0
 
virtual InputConnectionVector GetNodeInputConnection (const TfToken &nodeName, const TfToken &inputName) const =0
 
virtual void DeleteNode (const TfToken &nodeName)=0
 
virtual void SetNodeType (const TfToken &nodeName, const TfToken &nodeType)=0
 
virtual void SetNodeParameterValue (const TfToken &nodeName, const TfToken &paramName, const VtValue &value)=0
 
virtual void SetNodeParameterData (const TfToken &nodeName, const TfToken &paramName, const NodeParamData &paramData)=0
 
virtual void DeleteNodeParameter (const TfToken &nodeName, const TfToken &paramName)=0
 
virtual void SetNodeInputConnection (const TfToken &nodeName, const TfToken &inputName, const InputConnectionVector &connections)=0
 
virtual void DeleteNodeInputConnection (const TfToken &nodeName, const TfToken &inputName)=0
 
virtual TfTokenVector GetTerminalNames () const =0
 
virtual InputConnectionResult GetTerminalConnection (const TfToken &terminalName) const =0
 
virtual void DeleteTerminal (const TfToken &terminalName)=0
 
virtual void SetTerminalConnection (const TfToken &terminalName, const InputConnection &connection)=0
 

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 39 of file materialNetwork2Interface.h.

Constructor & Destructor Documentation

◆ HdMaterialNetwork2Interface()

HdMaterialNetwork2Interface ( const SdfPath materialPrimPath,
HdMaterialNetwork2 materialNetwork 
)
inline

Definition at line 44 of file materialNetwork2Interface.h.

Member Function Documentation

◆ DeleteNode()

HD_API void DeleteNode ( const TfToken nodeName)
overridevirtual

◆ DeleteNodeInputConnection()

HD_API void DeleteNodeInputConnection ( const TfToken nodeName,
const TfToken inputName 
)
overridevirtual

◆ DeleteNodeParameter()

HD_API void DeleteNodeParameter ( const TfToken nodeName,
const TfToken paramName 
)
overridevirtual

◆ DeleteTerminal()

HD_API void DeleteTerminal ( const TfToken terminalName)
overridevirtual

◆ GetAuthoredNodeParameterNames()

HD_API TfTokenVector GetAuthoredNodeParameterNames ( const TfToken nodeName) const
overridevirtual

◆ GetMaterialPrimPath()

HD_API SdfPath GetMaterialPrimPath ( ) const
inlineoverridevirtual

Implements HdMaterialNetworkInterface.

Definition at line 53 of file materialNetwork2Interface.h.

◆ GetModelAssetName()

HD_API std::string 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 58 of file materialNetwork2Interface.h.

◆ GetNodeInputConnection()

HD_API InputConnectionVector GetNodeInputConnection ( const TfToken nodeName,
const TfToken inputName 
) const
overridevirtual

◆ GetNodeInputConnectionNames()

HD_API TfTokenVector GetNodeInputConnectionNames ( const TfToken nodeName) const
overridevirtual

◆ GetNodeNames()

HD_API TfTokenVector GetNodeNames ( ) const
overridevirtual

◆ GetNodeParameterData()

HD_API NodeParamData GetNodeParameterData ( const TfToken nodeName,
const TfToken paramName 
) const
overridevirtual

◆ GetNodeParameterValue()

HD_API VtValue GetNodeParameterValue ( const TfToken nodeName,
const TfToken paramName 
) const
overridevirtual

◆ GetNodeType()

HD_API TfToken GetNodeType ( const TfToken nodeName) const
overridevirtual

◆ GetNodeTypeInfoKeys()

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

For now, we only have getters for this, as we aren't really intending on mutating this in any filter.

Implements HdMaterialNetworkInterface.

◆ GetNodeTypeInfoValue()

HD_API VtValue GetNodeTypeInfoValue ( const TfToken nodeName,
const TfToken key 
) const
overridevirtual

◆ GetTerminalConnection()

HD_API InputConnectionResult GetTerminalConnection ( const TfToken terminalName) const
overridevirtual

◆ GetTerminalNames()

HD_API TfTokenVector GetTerminalNames ( ) const
overridevirtual

Terminal query & mutation

Implements HdMaterialNetworkInterface.

◆ SetNodeInputConnection()

HD_API void SetNodeInputConnection ( const TfToken nodeName,
const TfToken inputName,
const InputConnectionVector connections 
)
overridevirtual

◆ SetNodeParameterData()

HD_API void SetNodeParameterData ( const TfToken nodeName,
const TfToken paramName,
const NodeParamData &  paramData 
)
overridevirtual

◆ SetNodeParameterValue()

HD_API void SetNodeParameterValue ( const TfToken nodeName,
const TfToken paramName,
const VtValue value 
)
overridevirtual

◆ SetNodeType()

HD_API void SetNodeType ( const TfToken nodeName,
const TfToken nodeType 
)
overridevirtual

◆ SetTerminalConnection()

HD_API void SetTerminalConnection ( const TfToken terminalName,
const InputConnection &  connection 
)
overridevirtual

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