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 TfTokenVector	GetMaterialConfigKeys () const override
	Material config is a collection of data related to the entire material, e.g.
HD_API VtValue	GetMaterialConfigValue (const TfToken &key) 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
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

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

DeleteNode()

HD_API void DeleteNode ( const TfToken & nodeName )

overridevirtual

Implements HdMaterialNetworkInterface.

DeleteNodeInputConnection()

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

overridevirtual

Implements HdMaterialNetworkInterface.

DeleteNodeParameter()

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

overridevirtual

Implements HdMaterialNetworkInterface.

DeleteTerminal()

HD_API void DeleteTerminal ( const TfToken & terminalName )

overridevirtual

Implements HdMaterialNetworkInterface.

GetAuthoredNodeParameterNames()

HD_API TfTokenVector GetAuthoredNodeParameterNames ( const TfToken & nodeName ) const

overridevirtual

Implements HdMaterialNetworkInterface.

GetMaterialConfigKeys()

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

GetMaterialConfigValue()

HD_API VtValue GetMaterialConfigValue ( const TfToken & key ) const

overridevirtual

Implements HdMaterialNetworkInterface.

GetMaterialPrimPath()

HD_API SdfPath GetMaterialPrimPath ( ) const

inlineoverridevirtual

Implements HdMaterialNetworkInterface.

Definition at line 36 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 46 of file materialNetwork2Interface.h.

GetNodeInputConnection()

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

overridevirtual

Implements HdMaterialNetworkInterface.

GetNodeInputConnectionNames()

HD_API TfTokenVector GetNodeInputConnectionNames ( const TfToken & nodeName ) const

overridevirtual

Implements HdMaterialNetworkInterface.

GetNodeNames()

HD_API TfTokenVector GetNodeNames ( ) const

overridevirtual

Implements HdMaterialNetworkInterface.

GetNodeParameterData()

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

overridevirtual

Implements HdMaterialNetworkInterface.

GetNodeParameterValue()

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

overridevirtual

Implements HdMaterialNetworkInterface.

GetNodeType()

HD_API TfToken GetNodeType ( const TfToken & nodeName ) const

overridevirtual

Implements HdMaterialNetworkInterface.

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.

Implements HdMaterialNetworkInterface.

GetNodeTypeInfoValue()

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

overridevirtual

Implements HdMaterialNetworkInterface.

GetTerminalConnection()

HD_API InputConnectionResult GetTerminalConnection ( const TfToken & terminalName ) const

overridevirtual

Implements HdMaterialNetworkInterface.

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

Implements HdMaterialNetworkInterface.

SetNodeParameterData()

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

overridevirtual

Implements HdMaterialNetworkInterface.

SetNodeParameterValue()

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

overridevirtual

Implements HdMaterialNetworkInterface.

SetNodeType()

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

overridevirtual

Implements HdMaterialNetworkInterface.

SetNodeTypeInfoValue()

virtual HD_API void SetNodeTypeInfoValue ( const TfToken & nodeName, const TfToken & key, const VtValue & value )

overridevirtual

Implements HdMaterialNetworkInterface.

SetTerminalConnection()

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

overridevirtual

Implements HdMaterialNetworkInterface.

---

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

• pxr/imaging/hd/materialNetwork2Interface.h