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

#include <materialInterfaceMappingSchema.h>

+ Inheritance diagram for HdMaterialInterfaceMappingSchema:

Classes

class  Builder
 

Public Member Functions

HdDataSourceLocator BuildNetworkRelativeLocator ()
 
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. More...
 
HD_API bool IsDefined () const
 
 operator bool () const
 

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
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 51 of file materialInterfaceMappingSchema.h.

Constructor & Destructor Documentation

HdMaterialInterfaceMappingSchema::HdMaterialInterfaceMappingSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 57 of file materialInterfaceMappingSchema.h.

Member Function Documentation

HdDataSourceLocator HdMaterialInterfaceMappingSchema::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 HD_API HdContainerDataSourceHandle HdMaterialInterfaceMappingSchema::BuildRetained ( const HdTokenDataSourceHandle &  nodePath,
const HdTokenDataSourceHandle &  inputName 
)
static
Deprecated:
Use Builder instead.

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.

HD_API HdTokenDataSourceHandle HdMaterialInterfaceMappingSchema::GetInputName ( ) const
HD_API HdTokenDataSourceHandle HdMaterialInterfaceMappingSchema::GetNodePath ( ) const
The documentation for this class was generated from the following file: