HdPrmanRileyParamListSchema Class Reference

Schema to describe RtParamList. More...

#include <rileyParamListSchema.h>

Inheritance diagram for HdPrmanRileyParamListSchema:

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
	HdPrmanRileyParamListSchema (HdContainerDataSourceHandle container)
Member accessor
HDPRMAN_API HdPrmanRileyParamContainerSchema	GetParams ()
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 HDPRMAN_API HdContainerDataSourceHandle	BuildRetained (const HdContainerDataSourceHandle &params)

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

Schema to describe RtParamList.

To obtain an RtParamList from this schema, we call the appropriate RtParamList::SetFOO(name, value) for each name in the container params.

The schema HdPrmanRileyParamSchema determines what SetFOO method is called with what value. To resolve what SetFOO method to use, the type of the VtValue from the value data source is used as well as the role token if necessary. The value is coming from the value data source.

Definition at line 58 of file rileyParamListSchema.h.

Constructor & Destructor Documentation

HdPrmanRileyParamListSchema()

HdPrmanRileyParamListSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 64 of file rileyParamListSchema.h.

Member Function Documentation

BuildRetained()

static HDPRMAN_API HdContainerDataSourceHandle BuildRetained ( const HdContainerDataSourceHandle &  params )

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/hdPrman/rileyParamListSchema.h