Loading...
Searching...
No Matches
legacyDisplayStyleSchema.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_IMAGING_HD_LEGACY_DISPLAY_STYLE_SCHEMA_H
36#define PXR_IMAGING_HD_LEGACY_DISPLAY_STYLE_SCHEMA_H
37
39
40#include "pxr/imaging/hd/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 HD_LEGACY_DISPLAY_STYLE_SCHEMA_TOKENS \
53 (displayStyle) \
54 (refineLevel) \
55 (flatShadingEnabled) \
56 (displacementEnabled) \
57 (occludedSelectionShowsThrough) \
58 (pointsShadingEnabled) \
59 (materialIsFinal) \
60 (shadingStyle) \
61 (reprSelector) \
62 (cullStyle) \
63
64TF_DECLARE_PUBLIC_TOKENS(HdLegacyDisplayStyleSchemaTokens, HD_API,
65 HD_LEGACY_DISPLAY_STYLE_SCHEMA_TOKENS);
66
67//-----------------------------------------------------------------------------
68
69
70class HdLegacyDisplayStyleSchema : public HdSchema
71{
72public:
75
76 HdLegacyDisplayStyleSchema(HdContainerDataSourceHandle container)
77 : HdSchema(container) {}
78
84 HD_API
85 static HdLegacyDisplayStyleSchema GetFromParent(
86 const HdContainerDataSourceHandle &fromParentContainer);
87
89
90// --(BEGIN CUSTOM CODE: Schema Methods)--
91// --(END CUSTOM CODE: Schema Methods)--
92
95
96 HD_API
97 HdIntDataSourceHandle GetRefineLevel() const;
98
99 HD_API
100 HdBoolDataSourceHandle GetFlatShadingEnabled() const;
101
102 HD_API
103 HdBoolDataSourceHandle GetDisplacementEnabled() const;
104
105 HD_API
106 HdBoolDataSourceHandle GetOccludedSelectionShowsThrough() const;
107
108 HD_API
109 HdBoolDataSourceHandle GetPointsShadingEnabled() const;
110
111 HD_API
112 HdBoolDataSourceHandle GetMaterialIsFinal() const;
113
114 HD_API
115 HdTokenDataSourceHandle GetShadingStyle() const;
116
117 HD_API
118 HdTokenArrayDataSourceHandle GetReprSelector() const;
119
120 HD_API
121 HdTokenDataSourceHandle GetCullStyle() const;
122
124
127
130 HD_API
131 static const TfToken &GetSchemaToken();
132
135 HD_API
136 static const HdDataSourceLocator &GetDefaultLocator();
137
139
148
150 HD_API
151 static const HdDataSourceLocator &GetReprSelectorLocator();
152
154 HD_API
155 static const HdDataSourceLocator &GetCullStyleLocator();
157
160
168 HD_API
169 static HdContainerDataSourceHandle
170 BuildRetained(
171 const HdIntDataSourceHandle &refineLevel,
172 const HdBoolDataSourceHandle &flatShadingEnabled,
173 const HdBoolDataSourceHandle &displacementEnabled,
174 const HdBoolDataSourceHandle &occludedSelectionShowsThrough,
175 const HdBoolDataSourceHandle &pointsShadingEnabled,
176 const HdBoolDataSourceHandle &materialIsFinal,
177 const HdTokenDataSourceHandle &shadingStyle,
178 const HdTokenArrayDataSourceHandle &reprSelector,
179 const HdTokenDataSourceHandle &cullStyle
180 );
181
189 {
190 public:
191 HD_API
192 Builder &SetRefineLevel(
193 const HdIntDataSourceHandle &refineLevel);
194 HD_API
195 Builder &SetFlatShadingEnabled(
196 const HdBoolDataSourceHandle &flatShadingEnabled);
197 HD_API
198 Builder &SetDisplacementEnabled(
199 const HdBoolDataSourceHandle &displacementEnabled);
200 HD_API
201 Builder &SetOccludedSelectionShowsThrough(
202 const HdBoolDataSourceHandle &occludedSelectionShowsThrough);
203 HD_API
204 Builder &SetPointsShadingEnabled(
205 const HdBoolDataSourceHandle &pointsShadingEnabled);
206 HD_API
207 Builder &SetMaterialIsFinal(
208 const HdBoolDataSourceHandle &materialIsFinal);
209 HD_API
210 Builder &SetShadingStyle(
211 const HdTokenDataSourceHandle &shadingStyle);
212 HD_API
213 Builder &SetReprSelector(
214 const HdTokenArrayDataSourceHandle &reprSelector);
215 HD_API
216 Builder &SetCullStyle(
217 const HdTokenDataSourceHandle &cullStyle);
218
220 HD_API
221 HdContainerDataSourceHandle Build();
222
223 private:
224 HdIntDataSourceHandle _refineLevel;
225 HdBoolDataSourceHandle _flatShadingEnabled;
226 HdBoolDataSourceHandle _displacementEnabled;
227 HdBoolDataSourceHandle _occludedSelectionShowsThrough;
228 HdBoolDataSourceHandle _pointsShadingEnabled;
229 HdBoolDataSourceHandle _materialIsFinal;
230 HdTokenDataSourceHandle _shadingStyle;
231 HdTokenArrayDataSourceHandle _reprSelector;
232 HdTokenDataSourceHandle _cullStyle;
233
234 };
235
237};
238
239PXR_NAMESPACE_CLOSE_SCOPE
240
241#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:43
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98