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

#include <materialNetworkSchema.h>

+ Inheritance diagram for HdMaterialNetworkSchema:

Classes

class  Builder
 

Public Member Functions

Schema retrieval
 HdMaterialNetworkSchema (HdContainerDataSourceHandle container)
 
Member accessor
HD_API
HdMaterialNodeContainerSchema 		GetNodes () const
 
HD_API
HdMaterialConnectionContainerSchema 		GetTerminals () const
 
HD_API
HdMaterialInterfaceMappingsContainerSchema 		GetInterfaceMappings () const
 
HD_API
HdSampledDataSourceContainerSchema 		GetConfig () 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 &nodes, const HdContainerDataSourceHandle &terminals, const HdContainerDataSourceHandle &interfaceMappings, const HdContainerDataSourceHandle &config)
 

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 79 of file materialNetworkSchema.h.

Constructor & Destructor Documentation

HdMaterialNetworkSchema::HdMaterialNetworkSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 85 of file materialNetworkSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMaterialNetworkSchema::BuildRetained ( const HdContainerDataSourceHandle &  nodes,
const HdContainerDataSourceHandle &  terminals,
const HdContainerDataSourceHandle &  interfaceMappings,
const HdContainerDataSourceHandle &  config 
)
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 HdSampledDataSourceContainerSchema HdMaterialNetworkSchema::GetConfig ( ) const

Maps node names to material nodes. Each material node is a container that is defined by the MaterialNode schema. The topology of the network is expressed by the connections found on each material node.

HD_API HdMaterialInterfaceMappingsContainerSchema HdMaterialNetworkSchema::GetInterfaceMappings ( ) const

Maps interface names (public UI names) to vectors of material node parameters. Each mapped material node parameter is a container defined by the InterfaceMappings schema.

HD_API HdMaterialNodeContainerSchema HdMaterialNetworkSchema::GetNodes ( ) const

Maps node names to material nodes. Each material node is a container that is defined by the MaterialNode schema. The topology of the network is expressed by the connections found on each material node.

HD_API HdMaterialConnectionContainerSchema HdMaterialNetworkSchema::GetTerminals ( ) const

Maps terminal names to material connections. Each connection is a container defined by the MaterialConnection schema.

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