HdDataSourceMaterialNetworkInterface Class Reference

Implements HdMaterialNetworkInterface for reading from and overriding values within data sources. More...

#include <dataSourceMaterialNetworkInterface.h>

Inheritance diagram for HdDataSourceMaterialNetworkInterface:

Public Member Functions
	HdDataSourceMaterialNetworkInterface (const SdfPath &materialPrimPath, const HdContainerDataSourceHandle &networkContainer, const HdContainerDataSourceHandle &primContainer)
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 &value) 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 HdMaterialNetworkInterface::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
	Set the nodeType for the shader node with the given nodeName.
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
HD_API HdContainerDataSourceHandle	Finish ()
virtual SdfPath	GetMaterialPrimPath () const =0
virtual TfTokenVector	GetMaterialConfigKeys () const =0
	Material config is a collection of data related to the entire material, e.g.
virtual VtValue	GetMaterialConfigValue (const TfToken &key) 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	SetNodeTypeInfoValue (const TfToken &nodeName, const TfToken &key, const VtValue &value)=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 for reading from and overriding values within data sources.

Overrides are managed internally via an HdContainerDataSourceEditor. Calling Finish returns the resulting container data resource representing an individual material network. If nothing is overriden, the input data source is returned.

Definition at line 28 of file dataSourceMaterialNetworkInterface.h.

Constructor & Destructor Documentation

HdDataSourceMaterialNetworkInterface()

HdDataSourceMaterialNetworkInterface ( const SdfPath &  materialPrimPath, const HdContainerDataSourceHandle &  networkContainer, const HdContainerDataSourceHandle &  primContainer  )

inline

Definition at line 33 of file dataSourceMaterialNetworkInterface.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 48 of file dataSourceMaterialNetworkInterface.h.

GetModelAssetName()

HD_API std::string GetModelAssetName ( ) const

overridevirtual

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

Implements HdMaterialNetworkInterface.

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 HdMaterialNetworkInterface::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 &  value  ) 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

Set the nodeType for the shader node with the given nodeName.

If nodeType is empty then the nodeType attribute will be removed from the node's dataSource.

Implements HdMaterialNetworkInterface.

SetNodeTypeInfoValue()

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/dataSourceMaterialNetworkInterface.h