Loading...
Searching...
No Matches
rileyLightInstanceSchema.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 EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_H
36#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_H
37
39
40#include "hdPrman/api.h"
42
43#include "pxr/imaging/hd/schema.h"
44#include "pxr/imaging/hd/version.h"
45
46// --(BEGIN CUSTOM CODE: Includes)--
47// --(END CUSTOM CODE: Includes)--
48
49PXR_NAMESPACE_OPEN_SCOPE
50
51// --(BEGIN CUSTOM CODE: Declares)--
52// --(END CUSTOM CODE: Declares)--
53
54#define HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_TOKENS \
55 (RileyLightInstance) \
56 (groupPrototype) \
57 (geoPrototype) \
58 (material) \
59 (lightShader) \
60 (coordsys) \
61 (xform) \
62 (attributes) \
63
64TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyLightInstanceSchemaTokens, HDPRMAN_API,
65 HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_TOKENS);
66
67//-----------------------------------------------------------------------------
68
69
70class HdPrmanRileyLightInstanceSchema : public HdSchema
71{
72public:
75
76 HdPrmanRileyLightInstanceSchema(HdContainerDataSourceHandle container)
77 : HdSchema(container) {}
78
84 HDPRMAN_API
85 static HdPrmanRileyLightInstanceSchema GetFromParent(
86 const HdContainerDataSourceHandle &fromParentContainer);
87
89
90// --(BEGIN CUSTOM CODE: Schema Methods)--
91// --(END CUSTOM CODE: Schema Methods)--
92
95
96 HDPRMAN_API
97 HdPathDataSourceHandle GetGroupPrototype()
98#if HD_API_VERSION >= 66
99 const;
100#else
101 ;
102#endif
103
104
105 HDPRMAN_API
106 HdPathDataSourceHandle GetGeoPrototype()
107#if HD_API_VERSION >= 66
108 const;
109#else
110 ;
111#endif
112
113
114 HDPRMAN_API
115 HdPathDataSourceHandle GetMaterial()
116#if HD_API_VERSION >= 66
117 const;
118#else
119 ;
120#endif
121
122
123 HDPRMAN_API
124 HdPathDataSourceHandle GetLightShader()
125#if HD_API_VERSION >= 66
126 const;
127#else
128 ;
129#endif
130
131
132 HDPRMAN_API
133 HdPathArrayDataSourceHandle GetCoordsys()
134#if HD_API_VERSION >= 66
135 const;
136#else
137 ;
138#endif
139
140
141 HDPRMAN_API
142 HdMatrixDataSourceHandle GetXform()
143#if HD_API_VERSION >= 66
144 const;
145#else
146 ;
147#endif
148
149
150 HDPRMAN_API
151 HdPrmanRileyParamListSchema GetAttributes()
152#if HD_API_VERSION >= 66
153 const;
154#else
155 ;
156#endif
157
158
160
163
166 HDPRMAN_API
167 static const TfToken &GetSchemaToken();
168
171 HDPRMAN_API
172 static const HdDataSourceLocator &GetDefaultLocator();
173
175
184
186 HDPRMAN_API
187 static const HdDataSourceLocator &GetGroupPrototypeLocator();
188
190 HDPRMAN_API
191 static const HdDataSourceLocator &GetGeoPrototypeLocator();
192
194 HDPRMAN_API
195 static const HdDataSourceLocator &GetMaterialLocator();
196
198 HDPRMAN_API
199 static const HdDataSourceLocator &GetLightShaderLocator();
200
202 HDPRMAN_API
203 static const HdDataSourceLocator &GetCoordsysLocator();
204
206 HDPRMAN_API
207 static const HdDataSourceLocator &GetXformLocator();
208
210 HDPRMAN_API
211 static const HdDataSourceLocator &GetAttributesLocator();
213
216
224 HDPRMAN_API
225 static HdContainerDataSourceHandle
226 BuildRetained(
227 const HdPathDataSourceHandle &groupPrototype,
228 const HdPathDataSourceHandle &geoPrototype,
229 const HdPathDataSourceHandle &material,
230 const HdPathDataSourceHandle &lightShader,
231 const HdPathArrayDataSourceHandle &coordsys,
232 const HdMatrixDataSourceHandle &xform,
233 const HdContainerDataSourceHandle &attributes
234 );
235
243 {
244 public:
245 HDPRMAN_API
246 Builder &SetGroupPrototype(
247 const HdPathDataSourceHandle &groupPrototype);
248 HDPRMAN_API
249 Builder &SetGeoPrototype(
250 const HdPathDataSourceHandle &geoPrototype);
251 HDPRMAN_API
252 Builder &SetMaterial(
253 const HdPathDataSourceHandle &material);
254 HDPRMAN_API
255 Builder &SetLightShader(
256 const HdPathDataSourceHandle &lightShader);
257 HDPRMAN_API
258 Builder &SetCoordsys(
259 const HdPathArrayDataSourceHandle &coordsys);
260 HDPRMAN_API
261 Builder &SetXform(
262 const HdMatrixDataSourceHandle &xform);
263 HDPRMAN_API
264 Builder &SetAttributes(
265 const HdContainerDataSourceHandle &attributes);
266
268 HDPRMAN_API
269 HdContainerDataSourceHandle Build();
270
271 private:
272 HdPathDataSourceHandle _groupPrototype;
273 HdPathDataSourceHandle _geoPrototype;
274 HdPathDataSourceHandle _material;
275 HdPathDataSourceHandle _lightShader;
276 HdPathArrayDataSourceHandle _coordsys;
277 HdMatrixDataSourceHandle _xform;
278 HdContainerDataSourceHandle _attributes;
279
280 };
281
283};
284
285PXR_NAMESPACE_CLOSE_SCOPE
286
287#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...
HDPRMAN_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