HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HdDataSourceMaterialNetworkInterface Class Reference

#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
 
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 &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
 
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 ()
 
- 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 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

HD_API void HdDataSourceMaterialNetworkInterface::DeleteNode ( const TfToken &  nodeName)
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API void HdDataSourceMaterialNetworkInterface::DeleteNodeInputConnection ( const TfToken &  nodeName,
const TfToken &  inputName 
)
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API void HdDataSourceMaterialNetworkInterface::DeleteNodeParameter ( const TfToken &  nodeName,
const TfToken &  paramName 
)
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API void HdDataSourceMaterialNetworkInterface::DeleteTerminal ( const TfToken &  terminalName)
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API HdContainerDataSourceHandle HdDataSourceMaterialNetworkInterface::Finish ( )
HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::GetAuthoredNodeParameterNames ( const TfToken &  nodeName) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::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 HdDataSourceMaterialNetworkInterface::GetMaterialConfigValue ( const TfToken &  key) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API SdfPath HdDataSourceMaterialNetworkInterface::GetMaterialPrimPath ( ) const
inlineoverridevirtual

Implements HdMaterialNetworkInterface.

Definition at line 48 of file dataSourceMaterialNetworkInterface.h.

HD_API std::string HdDataSourceMaterialNetworkInterface::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.

HD_API InputConnectionVector HdDataSourceMaterialNetworkInterface::GetNodeInputConnection ( const TfToken &  nodeName,
const TfToken &  inputName 
) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::GetNodeInputConnectionNames ( const TfToken &  nodeName) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::GetNodeNames ( ) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API HdMaterialNetworkInterface::NodeParamData HdDataSourceMaterialNetworkInterface::GetNodeParameterData ( const TfToken &  nodeName,
const TfToken &  paramName 
) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API VtValue HdDataSourceMaterialNetworkInterface::GetNodeParameterValue ( const TfToken &  nodeName,
const TfToken &  paramName 
) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfToken HdDataSourceMaterialNetworkInterface::GetNodeType ( const TfToken &  nodeName) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::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 HdDataSourceMaterialNetworkInterface::GetNodeTypeInfoValue ( const TfToken &  nodeName,
const TfToken &  value 
) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API InputConnectionResult HdDataSourceMaterialNetworkInterface::GetTerminalConnection ( const TfToken &  terminalName) const
overridevirtual

Implements HdMaterialNetworkInterface.

HD_API TfTokenVector HdDataSourceMaterialNetworkInterface::GetTerminalNames ( ) const
overridevirtual

Terminal query & mutation

Implements HdMaterialNetworkInterface.

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

Implements HdMaterialNetworkInterface.

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

Implements HdMaterialNetworkInterface.

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

Implements HdMaterialNetworkInterface.

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

HD_API void HdDataSourceMaterialNetworkInterface::SetNodeTypeInfoValue ( const TfToken &  nodeName,
const TfToken &  key,
const VtValue &  value 
)
overridevirtual

Implements HdMaterialNetworkInterface.

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

Implements HdMaterialNetworkInterface.

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