Loading...
Searching...
No Matches
rileyParamListSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_H
19#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_H
20
22
23#include "hdPrman/api.h"
24#include "hdPrman/rileySchemaTypeDefs.h"
25
26#include "pxr/imaging/hd/schema.h"
27#include "pxr/imaging/hd/version.h"
28
29// --(BEGIN CUSTOM CODE: Includes)--
30// --(END CUSTOM CODE: Includes)--
31
32PXR_NAMESPACE_OPEN_SCOPE
33
34// --(BEGIN CUSTOM CODE: Declares)--
35// --(END CUSTOM CODE: Declares)--
36
37#define HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_TOKENS \
38 (params) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyParamListSchemaTokens, HDPRMAN_API,
41 HD_PRMAN_RILEY_PARAM_LIST_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45// Schema to describe RtParamList.
46//
47// To obtain an RtParamList from this schema, we call the appropriate
48// RtParamList::SetFOO(name, value) for each name in the container params.
49//
50// The schema HdPrmanRileyParamSchema determines what SetFOO method is called
51// with what value. To resolve what SetFOO method to use, the type of the
52// VtValue from the value data source is used as well as the role token if
53// necessary. The value is coming from the value data source.
54//
55
56class HdPrmanRileyParamListSchema : public HdSchema
57{
58public:
61
62 HdPrmanRileyParamListSchema(HdContainerDataSourceHandle container)
63 : HdSchema(container) {}
64
66
67// --(BEGIN CUSTOM CODE: Schema Methods)--
68// --(END CUSTOM CODE: Schema Methods)--
69
72
73 HDPRMAN_API
75#if HD_API_VERSION >= 66
76 const;
77#else
78 ;
79#endif
80
81
83
86
94 HDPRMAN_API
95 static HdContainerDataSourceHandle
96 BuildRetained(
97 const HdContainerDataSourceHandle &params
98 );
99
107 {
108 public:
109 HDPRMAN_API
110 Builder &SetParams(
111 const HdContainerDataSourceHandle &params);
112
114 HDPRMAN_API
115 HdContainerDataSourceHandle Build();
116
117 private:
118 HdContainerDataSourceHandle _params;
119
120 };
121
123};
124
125PXR_NAMESPACE_CLOSE_SCOPE
126
127#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HDPRMAN_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Template class for a schema backed by a container whose children have arbitrary names but an expected...
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81