Loading...
Searching...
No Matches
usdRenderProductSchema.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 PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_H
19#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_H
20
22
23#include "pxr/usdImaging/usdImaging/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_TOKENS \
36 (__usdRenderProduct) \
37 (resolution) \
38 (pixelAspectRatio) \
39 (aspectRatioConformPolicy) \
40 (dataWindowNDC) \
41 (disableMotionBlur) \
42 (disableDepthOfField) \
43 (camera) \
44 (productType) \
45 (productName) \
46 (orderedVars) \
47 (namespacedSettings) \
48
49TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderProductSchemaTokens, USDIMAGING_API,
50 USD_IMAGING_USD_RENDER_PRODUCT_SCHEMA_TOKENS);
51
52//-----------------------------------------------------------------------------
53
54
55class UsdImagingUsdRenderProductSchema : public HdSchema
56{
57public:
60
61 UsdImagingUsdRenderProductSchema(HdContainerDataSourceHandle container)
62 : HdSchema(container) {}
63
69 USDIMAGING_API
70 static UsdImagingUsdRenderProductSchema GetFromParent(
71 const HdContainerDataSourceHandle &fromParentContainer);
72
74
75// --(BEGIN CUSTOM CODE: Schema Methods)--
76// --(END CUSTOM CODE: Schema Methods)--
77
80
81 USDIMAGING_API
82 HdVec2iDataSourceHandle GetResolution() const;
83
84 USDIMAGING_API
85 HdFloatDataSourceHandle GetPixelAspectRatio() const;
86
87 USDIMAGING_API
88 HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;
89
90 USDIMAGING_API
91 HdVec4fDataSourceHandle GetDataWindowNDC() const;
92
93 USDIMAGING_API
94 HdBoolDataSourceHandle GetDisableMotionBlur() const;
95
96 USDIMAGING_API
97 HdBoolDataSourceHandle GetDisableDepthOfField() const;
98
99 USDIMAGING_API
100 HdPathDataSourceHandle GetCamera() const;
101
102 USDIMAGING_API
103 HdTokenDataSourceHandle GetProductType() const;
104
105 USDIMAGING_API
106 HdTokenDataSourceHandle GetProductName() const;
107
108 USDIMAGING_API
109 HdPathArrayDataSourceHandle GetOrderedVars() const;
110
111 USDIMAGING_API
112 HdContainerDataSourceHandle GetNamespacedSettings() const;
113
115
118
121 USDIMAGING_API
122 static const TfToken &GetSchemaToken();
123
126 USDIMAGING_API
127 static const HdDataSourceLocator &GetDefaultLocator();
128
130
139
141 USDIMAGING_API
142 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
144
147
155 USDIMAGING_API
156 static HdContainerDataSourceHandle
157 BuildRetained(
158 const HdVec2iDataSourceHandle &resolution,
159 const HdFloatDataSourceHandle &pixelAspectRatio,
160 const HdTokenDataSourceHandle &aspectRatioConformPolicy,
161 const HdVec4fDataSourceHandle &dataWindowNDC,
162 const HdBoolDataSourceHandle &disableMotionBlur,
163 const HdBoolDataSourceHandle &disableDepthOfField,
164 const HdPathDataSourceHandle &camera,
165 const HdTokenDataSourceHandle &productType,
166 const HdTokenDataSourceHandle &productName,
167 const HdPathArrayDataSourceHandle &orderedVars,
168 const HdContainerDataSourceHandle &namespacedSettings
169 );
170
178 {
179 public:
180 USDIMAGING_API
181 Builder &SetResolution(
182 const HdVec2iDataSourceHandle &resolution);
183 USDIMAGING_API
184 Builder &SetPixelAspectRatio(
185 const HdFloatDataSourceHandle &pixelAspectRatio);
186 USDIMAGING_API
187 Builder &SetAspectRatioConformPolicy(
188 const HdTokenDataSourceHandle &aspectRatioConformPolicy);
189 USDIMAGING_API
190 Builder &SetDataWindowNDC(
191 const HdVec4fDataSourceHandle &dataWindowNDC);
192 USDIMAGING_API
193 Builder &SetDisableMotionBlur(
194 const HdBoolDataSourceHandle &disableMotionBlur);
195 USDIMAGING_API
196 Builder &SetDisableDepthOfField(
197 const HdBoolDataSourceHandle &disableDepthOfField);
198 USDIMAGING_API
199 Builder &SetCamera(
200 const HdPathDataSourceHandle &camera);
201 USDIMAGING_API
202 Builder &SetProductType(
203 const HdTokenDataSourceHandle &productType);
204 USDIMAGING_API
205 Builder &SetProductName(
206 const HdTokenDataSourceHandle &productName);
207 USDIMAGING_API
208 Builder &SetOrderedVars(
209 const HdPathArrayDataSourceHandle &orderedVars);
210 USDIMAGING_API
211 Builder &SetNamespacedSettings(
212 const HdContainerDataSourceHandle &namespacedSettings);
213
215 USDIMAGING_API
216 HdContainerDataSourceHandle Build();
217
218 private:
219 HdVec2iDataSourceHandle _resolution;
220 HdFloatDataSourceHandle _pixelAspectRatio;
221 HdTokenDataSourceHandle _aspectRatioConformPolicy;
222 HdVec4fDataSourceHandle _dataWindowNDC;
223 HdBoolDataSourceHandle _disableMotionBlur;
224 HdBoolDataSourceHandle _disableDepthOfField;
225 HdPathDataSourceHandle _camera;
226 HdTokenDataSourceHandle _productType;
227 HdTokenDataSourceHandle _productName;
228 HdPathArrayDataSourceHandle _orderedVars;
229 HdContainerDataSourceHandle _namespacedSettings;
230
231 };
232
234};
235
236PXR_NAMESPACE_CLOSE_SCOPE
237
238#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:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
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:92