Loading...
Searching...
No Matches
usdRenderProductSchema.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 PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_H
36#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_H
37
39
40#include "pxr/usdImaging/usdImaging/api.h"
41
42#include "pxr/imaging/hd/schema.h"
43
44// --(BEGIN CUSTOM CODE: Includes)--
45// --(END CUSTOM CODE: Includes)--
46
47PXR_NAMESPACE_OPEN_SCOPE
48
49// --(BEGIN CUSTOM CODE: Declares)--
50// --(END CUSTOM CODE: Declares)--
51
52#define USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_TOKENS \
53 (__usdRenderProduct) \
54 (resolution) \
55 (pixelAspectRatio) \
56 (aspectRatioConformPolicy) \
57 (dataWindowNDC) \
58 (disableMotionBlur) \
59 (disableDepthOfField) \
60 (camera) \
61 (productType) \
62 (productName) \
63 (orderedVars) \
64 (namespacedSettings) \
65
66TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderProductSchemaTokens, USDIMAGING_API,
67 USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_TOKENS);
68
69//-----------------------------------------------------------------------------
70
71
72class UsdImagingUsdRenderProductSchema : public HdSchema
73{
74public:
77
78 UsdImagingUsdRenderProductSchema(HdContainerDataSourceHandle container)
79 : HdSchema(container) {}
80
86 USDIMAGING_API
87 static UsdImagingUsdRenderProductSchema GetFromParent(
88 const HdContainerDataSourceHandle &fromParentContainer);
89
91
92// --(BEGIN CUSTOM CODE: Schema Methods)--
93// --(END CUSTOM CODE: Schema Methods)--
94
97
98 USDIMAGING_API
99 HdVec2iDataSourceHandle GetResolution() const;
100
101 USDIMAGING_API
102 HdFloatDataSourceHandle GetPixelAspectRatio() const;
103
104 USDIMAGING_API
105 HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;
106
107 USDIMAGING_API
108 HdVec4fDataSourceHandle GetDataWindowNDC() const;
109
110 USDIMAGING_API
111 HdBoolDataSourceHandle GetDisableMotionBlur() const;
112
113 USDIMAGING_API
114 HdBoolDataSourceHandle GetDisableDepthOfField() const;
115
116 USDIMAGING_API
117 HdPathDataSourceHandle GetCamera() const;
118
119 USDIMAGING_API
120 HdTokenDataSourceHandle GetProductType() const;
121
122 USDIMAGING_API
123 HdTokenDataSourceHandle GetProductName() const;
124
125 USDIMAGING_API
126 HdPathArrayDataSourceHandle GetOrderedVars() const;
127
128 USDIMAGING_API
129 HdContainerDataSourceHandle GetNamespacedSettings() const;
130
132
135
138 USDIMAGING_API
139 static const TfToken &GetSchemaToken();
140
143 USDIMAGING_API
144 static const HdDataSourceLocator &GetDefaultLocator();
145
147
156
158 USDIMAGING_API
159 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
161
164
172 USDIMAGING_API
173 static HdContainerDataSourceHandle
174 BuildRetained(
175 const HdVec2iDataSourceHandle &resolution,
176 const HdFloatDataSourceHandle &pixelAspectRatio,
177 const HdTokenDataSourceHandle &aspectRatioConformPolicy,
178 const HdVec4fDataSourceHandle &dataWindowNDC,
179 const HdBoolDataSourceHandle &disableMotionBlur,
180 const HdBoolDataSourceHandle &disableDepthOfField,
181 const HdPathDataSourceHandle &camera,
182 const HdTokenDataSourceHandle &productType,
183 const HdTokenDataSourceHandle &productName,
184 const HdPathArrayDataSourceHandle &orderedVars,
185 const HdContainerDataSourceHandle &namespacedSettings
186 );
187
195 {
196 public:
197 USDIMAGING_API
198 Builder &SetResolution(
199 const HdVec2iDataSourceHandle &resolution);
200 USDIMAGING_API
201 Builder &SetPixelAspectRatio(
202 const HdFloatDataSourceHandle &pixelAspectRatio);
203 USDIMAGING_API
204 Builder &SetAspectRatioConformPolicy(
205 const HdTokenDataSourceHandle &aspectRatioConformPolicy);
206 USDIMAGING_API
207 Builder &SetDataWindowNDC(
208 const HdVec4fDataSourceHandle &dataWindowNDC);
209 USDIMAGING_API
210 Builder &SetDisableMotionBlur(
211 const HdBoolDataSourceHandle &disableMotionBlur);
212 USDIMAGING_API
213 Builder &SetDisableDepthOfField(
214 const HdBoolDataSourceHandle &disableDepthOfField);
215 USDIMAGING_API
216 Builder &SetCamera(
217 const HdPathDataSourceHandle &camera);
218 USDIMAGING_API
219 Builder &SetProductType(
220 const HdTokenDataSourceHandle &productType);
221 USDIMAGING_API
222 Builder &SetProductName(
223 const HdTokenDataSourceHandle &productName);
224 USDIMAGING_API
225 Builder &SetOrderedVars(
226 const HdPathArrayDataSourceHandle &orderedVars);
227 USDIMAGING_API
228 Builder &SetNamespacedSettings(
229 const HdContainerDataSourceHandle &namespacedSettings);
230
232 USDIMAGING_API
233 HdContainerDataSourceHandle Build();
234
235 private:
236 HdVec2iDataSourceHandle _resolution;
237 HdFloatDataSourceHandle _pixelAspectRatio;
238 HdTokenDataSourceHandle _aspectRatioConformPolicy;
239 HdVec4fDataSourceHandle _dataWindowNDC;
240 HdBoolDataSourceHandle _disableMotionBlur;
241 HdBoolDataSourceHandle _disableDepthOfField;
242 HdPathDataSourceHandle _camera;
243 HdTokenDataSourceHandle _productType;
244 HdTokenDataSourceHandle _productName;
245 HdPathArrayDataSourceHandle _orderedVars;
246 HdContainerDataSourceHandle _namespacedSettings;
247
248 };
249
251};
252
253PXR_NAMESPACE_CLOSE_SCOPE
254
255#endif
Represents an object that can identify the location of a data source.
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
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
USDIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98