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
56class HdLegacyDisplayStyleSchema : public HdSchema
57{
58public:
61
62 HdLegacyDisplayStyleSchema(HdContainerDataSourceHandle container)
63 : HdSchema(container) {}
64
70 HD_API
71 static HdLegacyDisplayStyleSchema GetFromParent(
72 const HdContainerDataSourceHandle &fromParentContainer);
73
75
76// --(BEGIN CUSTOM CODE: Schema Methods)--
77// --(END CUSTOM CODE: Schema Methods)--
78
81
82 HD_API
83 HdIntDataSourceHandle GetRefineLevel() const;
84
85 HD_API
86 HdBoolDataSourceHandle GetFlatShadingEnabled() const;
87
88 HD_API
89 HdBoolDataSourceHandle GetDisplacementEnabled() const;
90
91 HD_API
92 HdBoolDataSourceHandle GetDisplayInOverlay() const;
93
94 HD_API
95 HdBoolDataSourceHandle GetOccludedSelectionShowsThrough() const;
96
97 HD_API
98 HdBoolDataSourceHandle GetPointsShadingEnabled() const;
99
100 HD_API
101 HdBoolDataSourceHandle GetMaterialIsFinal() const;
102
103 HD_API
104 HdTokenDataSourceHandle GetShadingStyle() const;
105
106 HD_API
107 HdTokenArrayDataSourceHandle GetReprSelector() const;
108
109 HD_API
110 HdTokenDataSourceHandle GetCullStyle() const;
111
113
116
119 HD_API
120 static const TfToken &GetSchemaToken();
121
124 HD_API
125 static const HdDataSourceLocator &GetDefaultLocator();
126
128
137
139 HD_API
140 static const HdDataSourceLocator &GetRefineLevelLocator();
141
143 HD_API
144 static const HdDataSourceLocator &GetFlatShadingEnabledLocator();
145
147 HD_API
148 static const HdDataSourceLocator &GetDisplacementEnabledLocator();
149
151 HD_API
152 static const HdDataSourceLocator &GetDisplayInOverlayLocator();
153
155 HD_API
156 static const HdDataSourceLocator &GetOccludedSelectionShowsThroughLocator();
157
159 HD_API
160 static const HdDataSourceLocator &GetPointsShadingEnabledLocator();
161
163 HD_API
164 static const HdDataSourceLocator &GetMaterialIsFinalLocator();
165
167 HD_API
168 static const HdDataSourceLocator &GetShadingStyleLocator();
169
171 HD_API
172 static const HdDataSourceLocator &GetReprSelectorLocator();
173
175 HD_API
176 static const HdDataSourceLocator &GetCullStyleLocator();
178
181
189 HD_API
190 static HdContainerDataSourceHandle
191 BuildRetained(
192 const HdIntDataSourceHandle &refineLevel,
193 const HdBoolDataSourceHandle &flatShadingEnabled,
194 const HdBoolDataSourceHandle &displacementEnabled,
195 const HdBoolDataSourceHandle &displayInOverlay,
196 const HdBoolDataSourceHandle &occludedSelectionShowsThrough,
197 const HdBoolDataSourceHandle &pointsShadingEnabled,
198 const HdBoolDataSourceHandle &materialIsFinal,
199 const HdTokenDataSourceHandle &shadingStyle,
200 const HdTokenArrayDataSourceHandle &reprSelector,
201 const HdTokenDataSourceHandle &cullStyle
202 );
203
211 {
212 public:
213 HD_API
214 Builder &SetRefineLevel(
215 const HdIntDataSourceHandle &refineLevel);
216 HD_API
217 Builder &SetFlatShadingEnabled(
218 const HdBoolDataSourceHandle &flatShadingEnabled);
219 HD_API
220 Builder &SetDisplacementEnabled(
221 const HdBoolDataSourceHandle &displacementEnabled);
222 HD_API
223 Builder &SetDisplayInOverlay(
224 const HdBoolDataSourceHandle &displayInOverlay);
225 HD_API
226 Builder &SetOccludedSelectionShowsThrough(
227 const HdBoolDataSourceHandle &occludedSelectionShowsThrough);
228 HD_API
229 Builder &SetPointsShadingEnabled(
230 const HdBoolDataSourceHandle &pointsShadingEnabled);
231 HD_API
232 Builder &SetMaterialIsFinal(
233 const HdBoolDataSourceHandle &materialIsFinal);
234 HD_API
235 Builder &SetShadingStyle(
236 const HdTokenDataSourceHandle &shadingStyle);
237 HD_API
238 Builder &SetReprSelector(
239 const HdTokenArrayDataSourceHandle &reprSelector);
240 HD_API
241 Builder &SetCullStyle(
242 const HdTokenDataSourceHandle &cullStyle);
243
245 HD_API
246 HdContainerDataSourceHandle Build();
247
248 private:
249 HdIntDataSourceHandle _refineLevel;
250 HdBoolDataSourceHandle _flatShadingEnabled;
251 HdBoolDataSourceHandle _displacementEnabled;
252 HdBoolDataSourceHandle _displayInOverlay;
253 HdBoolDataSourceHandle _occludedSelectionShowsThrough;
254 HdBoolDataSourceHandle _pointsShadingEnabled;
255 HdBoolDataSourceHandle _materialIsFinal;
256 HdTokenDataSourceHandle _shadingStyle;
257 HdTokenArrayDataSourceHandle _reprSelector;
258 HdTokenDataSourceHandle _cullStyle;
259
260 };
261
263};
264
265PXR_NAMESPACE_CLOSE_SCOPE
266
267#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:92