Loading...
Searching...
No Matches
rileyRenderOutputSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
25
26/* ************************************************************************** */
27/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_H
36#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_H
37
39
40#include "hdPrman/api.h"
42
43#include "pxr/imaging/hd/schema.h"
44#include "pxr/imaging/hd/version.h"
45
46// --(BEGIN CUSTOM CODE: Includes)--
47// --(END CUSTOM CODE: Includes)--
48
49PXR_NAMESPACE_OPEN_SCOPE
50
51// --(BEGIN CUSTOM CODE: Declares)--
52// --(END CUSTOM CODE: Declares)--
53
54#define HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_TOKENS \
55 (rileyRenderOutput) \
56 (name) \
57 (type) \
58 (source) \
59 (accumulationRule) \
60 (filter) \
61 (filterSize) \
62 (relativePixelVariance) \
63 (params) \
64 ((float_, "float")) \
65 (integer) \
66 (color) \
67 (vector) \
68
69TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyRenderOutputSchemaTokens, HDPRMAN_API,
70 HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_TOKENS);
71
72//-----------------------------------------------------------------------------
73
74
75class HdPrmanRileyRenderOutputSchema : public HdSchema
76{
77public:
80
81 HdPrmanRileyRenderOutputSchema(HdContainerDataSourceHandle container)
82 : HdSchema(container) {}
83
89 HDPRMAN_API
90 static HdPrmanRileyRenderOutputSchema GetFromParent(
91 const HdContainerDataSourceHandle &fromParentContainer);
92
94
95// --(BEGIN CUSTOM CODE: Schema Methods)--
96// --(END CUSTOM CODE: Schema Methods)--
97
100
101 HDPRMAN_API
102 HdTokenDataSourceHandle GetName()
103#if HD_API_VERSION >= 66
104 const;
105#else
106 ;
107#endif
108
109
110 HDPRMAN_API
111 HdTokenDataSourceHandle GetType()
112#if HD_API_VERSION >= 66
113 const;
114#else
115 ;
116#endif
117
118
119 HDPRMAN_API
120 HdTokenDataSourceHandle GetSource()
121#if HD_API_VERSION >= 66
122 const;
123#else
124 ;
125#endif
126
127
128 HDPRMAN_API
129 HdTokenDataSourceHandle GetAccumulationRule()
130#if HD_API_VERSION >= 66
131 const;
132#else
133 ;
134#endif
135
136
137 HDPRMAN_API
138 HdTokenDataSourceHandle GetFilter()
139#if HD_API_VERSION >= 66
140 const;
141#else
142 ;
143#endif
144
145
146 HDPRMAN_API
147 HdVec2fDataSourceHandle GetFilterSize()
148#if HD_API_VERSION >= 66
149 const;
150#else
151 ;
152#endif
153
154
155 HDPRMAN_API
156 HdFloatDataSourceHandle GetRelativePixelVariance()
157#if HD_API_VERSION >= 66
158 const;
159#else
160 ;
161#endif
162
163
164 HDPRMAN_API
165 HdPrmanRileyParamListSchema GetParams()
166#if HD_API_VERSION >= 66
167 const;
168#else
169 ;
170#endif
171
172
174
177
180 HDPRMAN_API
181 static const TfToken &GetSchemaToken();
182
185 HDPRMAN_API
186 static const HdDataSourceLocator &GetDefaultLocator();
187
189
198
200 HDPRMAN_API
201 static const HdDataSourceLocator &GetNameLocator();
202
204 HDPRMAN_API
205 static const HdDataSourceLocator &GetTypeLocator();
206
208 HDPRMAN_API
209 static const HdDataSourceLocator &GetSourceLocator();
210
212 HDPRMAN_API
213 static const HdDataSourceLocator &GetAccumulationRuleLocator();
214
216 HDPRMAN_API
217 static const HdDataSourceLocator &GetFilterLocator();
218
220 HDPRMAN_API
221 static const HdDataSourceLocator &GetFilterSizeLocator();
222
224 HDPRMAN_API
225 static const HdDataSourceLocator &GetRelativePixelVarianceLocator();
226
228 HDPRMAN_API
229 static const HdDataSourceLocator &GetParamsLocator();
231
234
242 HDPRMAN_API
243 static HdContainerDataSourceHandle
244 BuildRetained(
245 const HdTokenDataSourceHandle &name,
246 const HdTokenDataSourceHandle &type,
247 const HdTokenDataSourceHandle &source,
248 const HdTokenDataSourceHandle &accumulationRule,
249 const HdTokenDataSourceHandle &filter,
250 const HdVec2fDataSourceHandle &filterSize,
251 const HdFloatDataSourceHandle &relativePixelVariance,
252 const HdContainerDataSourceHandle &params
253 );
254
262 {
263 public:
264 HDPRMAN_API
265 Builder &SetName(
266 const HdTokenDataSourceHandle &name);
267 HDPRMAN_API
268 Builder &SetType(
269 const HdTokenDataSourceHandle &type);
270 HDPRMAN_API
271 Builder &SetSource(
272 const HdTokenDataSourceHandle &source);
273 HDPRMAN_API
274 Builder &SetAccumulationRule(
275 const HdTokenDataSourceHandle &accumulationRule);
276 HDPRMAN_API
277 Builder &SetFilter(
278 const HdTokenDataSourceHandle &filter);
279 HDPRMAN_API
280 Builder &SetFilterSize(
281 const HdVec2fDataSourceHandle &filterSize);
282 HDPRMAN_API
283 Builder &SetRelativePixelVariance(
284 const HdFloatDataSourceHandle &relativePixelVariance);
285 HDPRMAN_API
286 Builder &SetParams(
287 const HdContainerDataSourceHandle &params);
288
290 HDPRMAN_API
291 HdContainerDataSourceHandle Build();
292
293 private:
294 HdTokenDataSourceHandle _name;
295 HdTokenDataSourceHandle _type;
296 HdTokenDataSourceHandle _source;
297 HdTokenDataSourceHandle _accumulationRule;
298 HdTokenDataSourceHandle _filter;
299 HdVec2fDataSourceHandle _filterSize;
300 HdFloatDataSourceHandle _relativePixelVariance;
301 HdContainerDataSourceHandle _params;
302
303 };
304
313 HDPRMAN_API
314 static HdTokenDataSourceHandle BuildTypeDataSource(
315 const TfToken &type);
316
318};
319
320PXR_NAMESPACE_CLOSE_SCOPE
321
322#endif
Represents an object that can identify the location of a data source.
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.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98