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

#include <materialInterfaceSchema.h>

+ Inheritance diagram for HdMaterialInterfaceSchema:

Classes

class  Builder
 

Public Member Functions

HD_API NestedTfTokenMap GetReverseInterfaceMappings () const
 
Schema retrieval
 HdMaterialInterfaceSchema (HdContainerDataSourceHandle container)
 
Member accessor
HD_API
HdMaterialInterfaceParameterContainerSchema 		GetParameters () const
 A container for all the material's interface parameters. More...
 
HD_API HdTokenArrayDataSourceHandle GetParameterOrder () 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 HdContainerDataSourceHandle &parameters, const HdTokenArrayDataSourceHandle &parameterOrder)
 

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

The MaterialInterface schema describes a material's interface parameters, also known as public UI parameters.

Definition at line 59 of file materialInterfaceSchema.h.

Constructor & Destructor Documentation

HdMaterialInterfaceSchema::HdMaterialInterfaceSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 65 of file materialInterfaceSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMaterialInterfaceSchema::BuildRetained ( const HdContainerDataSourceHandle &  parameters,
const HdTokenArrayDataSourceHandle &  parameterOrder 
)
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 HdTokenArrayDataSourceHandle HdMaterialInterfaceSchema::GetParameterOrder ( ) const

Provides the intended order of the interface parameters for UI purposes. Any member of 'parameters' that is not found in this list can come after all listed members. The order of display groups is implicitly encoded. As this list is traversed, display groups are ordered by first encounter.

HD_API HdMaterialInterfaceParameterContainerSchema HdMaterialInterfaceSchema::GetParameters ( ) const

A container for all the material's interface parameters.

HD_API NestedTfTokenMap HdMaterialInterfaceSchema::GetReverseInterfaceMappings ( ) const

Builds and returns a map of reversed interface mappings. If no interface mappings were found, returns an empty map.

Interface mappings are mapped like this: publicUIName -> [(nodePath, inputName),...]

The returned map of reversed interface mappings is mapped like this: nodePath -> (inputName -> publicUIName)

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