Loading...
Searching...
No Matches
legacyDisplayStyleSchema.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_IMAGING_HD_LEGACY_DISPLAY_STYLE_SCHEMA_H
19#define PXR_IMAGING_HD_LEGACY_DISPLAY_STYLE_SCHEMA_H
20
22
23#include "pxr/imaging/hd/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 HD_LEGACY_DISPLAY_STYLE_SCHEMA_TOKENS \
36 (displayStyle) \
37 (refineLevel) \
38 (flatShadingEnabled) \
39 (displacementEnabled) \
40 (displayInOverlay) \
41 (occludedSelectionShowsThrough) \
42 (pointsShadingEnabled) \
43 (materialIsFinal) \
44 (shadingStyle) \
45 (reprSelector) \
46 (cullStyle) \
47
48TF_DECLARE_PUBLIC_TOKENS(HdLegacyDisplayStyleSchemaTokens, HD_API,
49 HD_LEGACY_DISPLAY_STYLE_SCHEMA_TOKENS);
50
51//-----------------------------------------------------------------------------
52
53
54class HdLegacyDisplayStyleSchema : public HdSchema
55{
56public:
59
60 HdLegacyDisplayStyleSchema(HdContainerDataSourceHandle container)
61 : HdSchema(container) {}
62
68 HD_API
69 static HdLegacyDisplayStyleSchema GetFromParent(
70 const HdContainerDataSourceHandle &fromParentContainer);
71
73
74// --(BEGIN CUSTOM CODE: Schema Methods)--
75// --(END CUSTOM CODE: Schema Methods)--
76
79
80 HD_API
81 HdIntDataSourceHandle GetRefineLevel() const;
82
83 HD_API
84 HdBoolDataSourceHandle GetFlatShadingEnabled() const;
85
86 HD_API
87 HdBoolDataSourceHandle GetDisplacementEnabled() const;
88
89 HD_API
90 HdBoolDataSourceHandle GetDisplayInOverlay() const;
91
92 HD_API
93 HdBoolDataSourceHandle GetOccludedSelectionShowsThrough() const;
94
95 HD_API
96 HdBoolDataSourceHandle GetPointsShadingEnabled() const;
97
98 HD_API
99 HdBoolDataSourceHandle GetMaterialIsFinal() const;
100
101 HD_API
102 HdTokenDataSourceHandle GetShadingStyle() const;
103
104 HD_API
105 HdTokenArrayDataSourceHandle GetReprSelector() const;
106
107 HD_API
108 HdTokenDataSourceHandle GetCullStyle() const;
109
111
114
117 HD_API
118 static const TfToken &GetSchemaToken();
119
122 HD_API
123 static const HdDataSourceLocator &GetDefaultLocator();
124
126
135
137 HD_API
138 static const HdDataSourceLocator &GetRefineLevelLocator();
139
141 HD_API
142 static const HdDataSourceLocator &GetFlatShadingEnabledLocator();
143
145 HD_API
146 static const HdDataSourceLocator &GetDisplacementEnabledLocator();
147
149 HD_API
150 static const HdDataSourceLocator &GetDisplayInOverlayLocator();
151
153 HD_API
154 static const HdDataSourceLocator &GetOccludedSelectionShowsThroughLocator();
155
157 HD_API
158 static const HdDataSourceLocator &GetPointsShadingEnabledLocator();
159
161 HD_API
162 static const HdDataSourceLocator &GetMaterialIsFinalLocator();
163
165 HD_API
166 static const HdDataSourceLocator &GetShadingStyleLocator();
167
169 HD_API
170 static const HdDataSourceLocator &GetReprSelectorLocator();
171
173 HD_API
174 static const HdDataSourceLocator &GetCullStyleLocator();
176
179
187 HD_API
188 static HdContainerDataSourceHandle
189 BuildRetained(
190 const HdIntDataSourceHandle &refineLevel,
191 const HdBoolDataSourceHandle &flatShadingEnabled,
192 const HdBoolDataSourceHandle &displacementEnabled,
193 const HdBoolDataSourceHandle &displayInOverlay,
194 const HdBoolDataSourceHandle &occludedSelectionShowsThrough,
195 const HdBoolDataSourceHandle &pointsShadingEnabled,
196 const HdBoolDataSourceHandle &materialIsFinal,
197 const HdTokenDataSourceHandle &shadingStyle,
198 const HdTokenArrayDataSourceHandle &reprSelector,
199 const HdTokenDataSourceHandle &cullStyle
200 );
201
209 {
210 public:
211 HD_API
212 Builder &SetRefineLevel(
213 const HdIntDataSourceHandle &refineLevel);
214 HD_API
215 Builder &SetFlatShadingEnabled(
216 const HdBoolDataSourceHandle &flatShadingEnabled);
217 HD_API
218 Builder &SetDisplacementEnabled(
219 const HdBoolDataSourceHandle &displacementEnabled);
220 HD_API
221 Builder &SetDisplayInOverlay(
222 const HdBoolDataSourceHandle &displayInOverlay);
223 HD_API
224 Builder &SetOccludedSelectionShowsThrough(
225 const HdBoolDataSourceHandle &occludedSelectionShowsThrough);
226 HD_API
227 Builder &SetPointsShadingEnabled(
228 const HdBoolDataSourceHandle &pointsShadingEnabled);
229 HD_API
230 Builder &SetMaterialIsFinal(
231 const HdBoolDataSourceHandle &materialIsFinal);
232 HD_API
233 Builder &SetShadingStyle(
234 const HdTokenDataSourceHandle &shadingStyle);
235 HD_API
236 Builder &SetReprSelector(
237 const HdTokenArrayDataSourceHandle &reprSelector);
238 HD_API
239 Builder &SetCullStyle(
240 const HdTokenDataSourceHandle &cullStyle);
241
243 HD_API
244 HdContainerDataSourceHandle Build();
245
246 private:
247 HdIntDataSourceHandle _refineLevel;
248 HdBoolDataSourceHandle _flatShadingEnabled;
249 HdBoolDataSourceHandle _displacementEnabled;
250 HdBoolDataSourceHandle _displayInOverlay;
251 HdBoolDataSourceHandle _occludedSelectionShowsThrough;
252 HdBoolDataSourceHandle _pointsShadingEnabled;
253 HdBoolDataSourceHandle _materialIsFinal;
254 HdTokenDataSourceHandle _shadingStyle;
255 HdTokenArrayDataSourceHandle _reprSelector;
256 HdTokenDataSourceHandle _cullStyle;
257
258 };
259
261};
262
263PXR_NAMESPACE_CLOSE_SCOPE
264
265#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...
HD_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:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81