HdMaterialConnectionSchema Class Reference

The MaterialConnection schema defines an upstream connected node and output. More...

#include <materialConnectionSchema.h>

Inheritance diagram for HdMaterialConnectionSchema:

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
Schema retrieval
	HdMaterialConnectionSchema (HdContainerDataSourceHandle container)
Member accessor
HD_API HdTokenDataSourceHandle	GetUpstreamNodePath () const
HD_API HdTokenDataSourceHandle	GetUpstreamNodeOutputName () 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 &upstreamNodePath, const HdTokenDataSourceHandle &upstreamNodeOutputName)

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

Detailed Description

The MaterialConnection schema defines an upstream connected node and output.

See MaterialNode schema's documentation on its 'inputConnections' member for an example.

Definition at line 53 of file materialConnectionSchema.h.

Constructor & Destructor Documentation

HdMaterialConnectionSchema()

HdMaterialConnectionSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 59 of file materialConnectionSchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdTokenDataSourceHandle &  upstreamNodePath, const HdTokenDataSourceHandle &  upstreamNodeOutputName  )

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.

---

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

• pxr/imaging/hd/materialConnectionSchema.h