![]() |
|
The MaterialInterfaceMapping schema identifies a material node parameter using its two members 'nodePath' and 'inputName'. More...
#include <materialInterfaceMappingSchema.h>
Inheritance diagram for HdMaterialInterfaceMappingSchema:Classes | |
| class | Builder |
| Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More... | |
Public Member Functions | |
| HdDataSourceLocator | BuildNetworkRelativeLocator () |
| Returns the data source locator relative to the material network for the material node parameter indicated by the interface mapping. | |
Schema retrieval | |
| HdMaterialInterfaceMappingSchema (HdContainerDataSourceHandle container) | |
Member accessor | |
| HD_API HdTokenDataSourceHandle | GetNodePath () const |
| HD_API HdTokenDataSourceHandle | GetInputName () const |
Public Member Functions inherited from HdSchema | |
| HdSchema (HdContainerDataSourceHandle container) | |
| HD_API HdContainerDataSourceHandle | GetContainer () const |
| Returns the container data source that this schema is interpreting. | |
| HD_API bool | IsDefined () const |
| operator bool () const | |
Returns true if this schema is applied on top of a non-null container. | |
Static Public Member Functions | |
Schema construction | |
| static HD_API HdContainerDataSourceHandle | BuildRetained (const HdTokenDataSourceHandle &nodePath, const HdTokenDataSourceHandle &inputName) |
Additional Inherited Members | |
Public Types inherited from HdSchema | |
| using | UnderlyingDataSource = HdContainerDataSource |
Protected Member Functions inherited from HdSchema | |
| template<typename T > | |
| T::Handle | _GetTypedDataSource (TfToken name) const |
| Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc. | |
Protected Attributes inherited from HdSchema | |
| HdContainerDataSourceHandle | _container |
The MaterialInterfaceMapping schema identifies a material node parameter using its two members 'nodePath' and 'inputName'.
For example, if we are looking at some material network at material/<renderContext>/... and we have a mapping target defined by the following data sources:
ds at: material/<renderContext>/.../nodePath = Color_Manipulate
ds at: material/<renderContext>/.../inputName = adjustVal
The above defines a mapping target to the material node parameter under that material network, eg:
ds at: material/<renderContext>/nodes/Color_Manipulate/parameters/ adjustVal
Definition at line 64 of file materialInterfaceMappingSchema.h.
|
inline |
Definition at line 70 of file materialInterfaceMappingSchema.h.
| HdDataSourceLocator BuildNetworkRelativeLocator | ( | ) |
Returns the data source locator relative to the material network for the material node parameter indicated by the interface mapping.
Ie. Returns locator: nodes/<nodePath>/parameters/<inputName>
|
static |
Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.