geomModelSchema.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_GEOM_MODEL_SCHEMA_H
19 #define PXR_USD_IMAGING_USD_IMAGING_GEOM_MODEL_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 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 // --(BEGIN CUSTOM CODE: Declares)--
33 // --(END CUSTOM CODE: Declares)--
34 
35 #define USD_IMAGING_GEOM_MODEL_SCHEMA_TOKENS \
36  (geomModel) \
37  (drawMode) \
38  (applyDrawMode) \
39  (drawModeColor) \
40  (cardGeometry) \
41  (cardVisibility) \
42  (cardTextureXPos) \
43  (cardTextureYPos) \
44  (cardTextureZPos) \
45  (cardTextureXNeg) \
46  (cardTextureYNeg) \
47  (cardTextureZNeg) \
48  ((default_, "default")) \
49  (origin) \
50  (bounds) \
51  (cards) \
52  (inherited) \
53  (cross) \
54  (box) \
55  (fromTexture) \
56  (simple) \
57  (full) \
58 
59 TF_DECLARE_PUBLIC_TOKENS(UsdImagingGeomModelSchemaTokens, USDIMAGING_API,
60  USD_IMAGING_GEOM_MODEL_SCHEMA_TOKENS);
61 
62 //-----------------------------------------------------------------------------
63 
64 
67 class UsdImagingGeomModelSchema : public HdSchema
68 {
69 public:
72 
73  UsdImagingGeomModelSchema(HdContainerDataSourceHandle container)
74  : HdSchema(container) {}
75 
81  USDIMAGING_API
82  static UsdImagingGeomModelSchema GetFromParent(
83  const HdContainerDataSourceHandle &fromParentContainer);
84 
86 
87 // --(BEGIN CUSTOM CODE: Schema Methods)--
88 // --(END CUSTOM CODE: Schema Methods)--
89 
92 
93  USDIMAGING_API
94  HdTokenDataSourceHandle GetDrawMode() const;
95 
96  USDIMAGING_API
97  HdBoolDataSourceHandle GetApplyDrawMode() const;
98 
99  USDIMAGING_API
100  HdVec3fDataSourceHandle GetDrawModeColor() const;
101 
102  USDIMAGING_API
103  HdTokenDataSourceHandle GetCardGeometry() const;
104 
105  USDIMAGING_API
106  HdTokenDataSourceHandle GetCardVisibility() const;
107 
108  USDIMAGING_API
109  HdAssetPathDataSourceHandle GetCardTextureXPos() const;
110 
111  USDIMAGING_API
112  HdAssetPathDataSourceHandle GetCardTextureYPos() const;
113 
114  USDIMAGING_API
115  HdAssetPathDataSourceHandle GetCardTextureZPos() const;
116 
117  USDIMAGING_API
118  HdAssetPathDataSourceHandle GetCardTextureXNeg() const;
119 
120  USDIMAGING_API
121  HdAssetPathDataSourceHandle GetCardTextureYNeg() const;
122 
123  USDIMAGING_API
124  HdAssetPathDataSourceHandle GetCardTextureZNeg() const;
125 
127 
130 
133  USDIMAGING_API
134  static const TfToken &GetSchemaToken();
135 
138  USDIMAGING_API
139  static const HdDataSourceLocator &GetDefaultLocator();
140 
142 
151 
153  USDIMAGING_API
154  static const HdDataSourceLocator &GetDrawModeLocator();
156 
159 
167  USDIMAGING_API
168  static HdContainerDataSourceHandle
169  BuildRetained(
170  const HdTokenDataSourceHandle &drawMode,
171  const HdBoolDataSourceHandle &applyDrawMode,
172  const HdVec3fDataSourceHandle &drawModeColor,
173  const HdTokenDataSourceHandle &cardGeometry,
174  const HdTokenDataSourceHandle &cardVisibility,
175  const HdAssetPathDataSourceHandle &cardTextureXPos,
176  const HdAssetPathDataSourceHandle &cardTextureYPos,
177  const HdAssetPathDataSourceHandle &cardTextureZPos,
178  const HdAssetPathDataSourceHandle &cardTextureXNeg,
179  const HdAssetPathDataSourceHandle &cardTextureYNeg,
180  const HdAssetPathDataSourceHandle &cardTextureZNeg
181  );
182 
189  class Builder
190  {
191  public:
192  USDIMAGING_API
193  Builder &SetDrawMode(
194  const HdTokenDataSourceHandle &drawMode);
195  USDIMAGING_API
196  Builder &SetApplyDrawMode(
197  const HdBoolDataSourceHandle &applyDrawMode);
198  USDIMAGING_API
199  Builder &SetDrawModeColor(
200  const HdVec3fDataSourceHandle &drawModeColor);
201  USDIMAGING_API
202  Builder &SetCardGeometry(
203  const HdTokenDataSourceHandle &cardGeometry);
204  USDIMAGING_API
205  Builder &SetCardVisibility(
206  const HdTokenDataSourceHandle &cardVisibility);
207  USDIMAGING_API
208  Builder &SetCardTextureXPos(
209  const HdAssetPathDataSourceHandle &cardTextureXPos);
210  USDIMAGING_API
211  Builder &SetCardTextureYPos(
212  const HdAssetPathDataSourceHandle &cardTextureYPos);
213  USDIMAGING_API
214  Builder &SetCardTextureZPos(
215  const HdAssetPathDataSourceHandle &cardTextureZPos);
216  USDIMAGING_API
217  Builder &SetCardTextureXNeg(
218  const HdAssetPathDataSourceHandle &cardTextureXNeg);
219  USDIMAGING_API
220  Builder &SetCardTextureYNeg(
221  const HdAssetPathDataSourceHandle &cardTextureYNeg);
222  USDIMAGING_API
223  Builder &SetCardTextureZNeg(
224  const HdAssetPathDataSourceHandle &cardTextureZNeg);
225 
227  USDIMAGING_API
228  HdContainerDataSourceHandle Build();
229 
230  private:
231  HdTokenDataSourceHandle _drawMode;
232  HdBoolDataSourceHandle _applyDrawMode;
233  HdVec3fDataSourceHandle _drawModeColor;
234  HdTokenDataSourceHandle _cardGeometry;
235  HdTokenDataSourceHandle _cardVisibility;
236  HdAssetPathDataSourceHandle _cardTextureXPos;
237  HdAssetPathDataSourceHandle _cardTextureYPos;
238  HdAssetPathDataSourceHandle _cardTextureZPos;
239  HdAssetPathDataSourceHandle _cardTextureXNeg;
240  HdAssetPathDataSourceHandle _cardTextureYNeg;
241  HdAssetPathDataSourceHandle _cardTextureZNeg;
242 
243  };
244 
254  USDIMAGING_API
255  static HdTokenDataSourceHandle BuildDrawModeDataSource(
256  const TfToken &drawMode);
257 
265  USDIMAGING_API
266  static HdTokenDataSourceHandle BuildCardGeometryDataSource(
267  const TfToken &cardGeometry);
268 
276  USDIMAGING_API
277  static HdTokenDataSourceHandle BuildCardVisibilityDataSource(
278  const TfToken &cardVisibility);
279 
281 };
282 
283 PXR_NAMESPACE_CLOSE_SCOPE
284 
285 #endif
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.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:80
Represents an object that can identify the location of a data source.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:25