Loading...
Searching...
No Matches
rileyLightInstanceSchema.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 EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_H
19#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_H
20
22
23#include "hdPrman/api.h"
25
26#include "pxr/imaging/hd/schema.h"
27#include "pxr/imaging/hd/version.h"
28
29// --(BEGIN CUSTOM CODE: Includes)--
30// --(END CUSTOM CODE: Includes)--
31
32PXR_NAMESPACE_OPEN_SCOPE
33
34// --(BEGIN CUSTOM CODE: Declares)--
35// --(END CUSTOM CODE: Declares)--
36
37#define HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_TOKENS \
38 (RileyLightInstance) \
39 (groupPrototype) \
40 (geoPrototype) \
41 (material) \
42 (lightShader) \
43 (coordsys) \
44 (xform) \
45 (attributes) \
46
47TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyLightInstanceSchemaTokens, HDPRMAN_API,
48 HD_PRMAN_RILEY_LIGHT_INSTANCE_SCHEMA_TOKENS);
49
50//-----------------------------------------------------------------------------
51
52
53class HdPrmanRileyLightInstanceSchema : public HdSchema
54{
55public:
58
59 HdPrmanRileyLightInstanceSchema(HdContainerDataSourceHandle container)
60 : HdSchema(container) {}
61
67 HDPRMAN_API
68 static HdPrmanRileyLightInstanceSchema GetFromParent(
69 const HdContainerDataSourceHandle &fromParentContainer);
70
72
73// --(BEGIN CUSTOM CODE: Schema Methods)--
74// --(END CUSTOM CODE: Schema Methods)--
75
78
79 HDPRMAN_API
80 HdPathDataSourceHandle GetGroupPrototype()
81#if HD_API_VERSION >= 66
82 const;
83#else
84 ;
85#endif
86
87
88 HDPRMAN_API
89 HdPathDataSourceHandle GetGeoPrototype()
90#if HD_API_VERSION >= 66
91 const;
92#else
93 ;
94#endif
95
96
97 HDPRMAN_API
98 HdPathDataSourceHandle GetMaterial()
99#if HD_API_VERSION >= 66
100 const;
101#else
102 ;
103#endif
104
105
106 HDPRMAN_API
107 HdPathDataSourceHandle GetLightShader()
108#if HD_API_VERSION >= 66
109 const;
110#else
111 ;
112#endif
113
114
115 HDPRMAN_API
116 HdPathArrayDataSourceHandle GetCoordsys()
117#if HD_API_VERSION >= 66
118 const;
119#else
120 ;
121#endif
122
123
124 HDPRMAN_API
125 HdMatrixDataSourceHandle GetXform()
126#if HD_API_VERSION >= 66
127 const;
128#else
129 ;
130#endif
131
132
133 HDPRMAN_API
134 HdPrmanRileyParamListSchema GetAttributes()
135#if HD_API_VERSION >= 66
136 const;
137#else
138 ;
139#endif
140
141
143
146
149 HDPRMAN_API
150 static const TfToken &GetSchemaToken();
151
154 HDPRMAN_API
155 static const HdDataSourceLocator &GetDefaultLocator();
156
158
167
169 HDPRMAN_API
170 static const HdDataSourceLocator &GetGroupPrototypeLocator();
171
173 HDPRMAN_API
174 static const HdDataSourceLocator &GetGeoPrototypeLocator();
175
177 HDPRMAN_API
178 static const HdDataSourceLocator &GetMaterialLocator();
179
181 HDPRMAN_API
182 static const HdDataSourceLocator &GetLightShaderLocator();
183
185 HDPRMAN_API
186 static const HdDataSourceLocator &GetCoordsysLocator();
187
189 HDPRMAN_API
190 static const HdDataSourceLocator &GetXformLocator();
191
193 HDPRMAN_API
194 static const HdDataSourceLocator &GetAttributesLocator();
196
199
207 HDPRMAN_API
208 static HdContainerDataSourceHandle
209 BuildRetained(
210 const HdPathDataSourceHandle &groupPrototype,
211 const HdPathDataSourceHandle &geoPrototype,
212 const HdPathDataSourceHandle &material,
213 const HdPathDataSourceHandle &lightShader,
214 const HdPathArrayDataSourceHandle &coordsys,
215 const HdMatrixDataSourceHandle &xform,
216 const HdContainerDataSourceHandle &attributes
217 );
218
226 {
227 public:
228 HDPRMAN_API
229 Builder &SetGroupPrototype(
230 const HdPathDataSourceHandle &groupPrototype);
231 HDPRMAN_API
232 Builder &SetGeoPrototype(
233 const HdPathDataSourceHandle &geoPrototype);
234 HDPRMAN_API
235 Builder &SetMaterial(
236 const HdPathDataSourceHandle &material);
237 HDPRMAN_API
238 Builder &SetLightShader(
239 const HdPathDataSourceHandle &lightShader);
240 HDPRMAN_API
241 Builder &SetCoordsys(
242 const HdPathArrayDataSourceHandle &coordsys);
243 HDPRMAN_API
244 Builder &SetXform(
245 const HdMatrixDataSourceHandle &xform);
246 HDPRMAN_API
247 Builder &SetAttributes(
248 const HdContainerDataSourceHandle &attributes);
249
251 HDPRMAN_API
252 HdContainerDataSourceHandle Build();
253
254 private:
255 HdPathDataSourceHandle _groupPrototype;
256 HdPathDataSourceHandle _geoPrototype;
257 HdPathDataSourceHandle _material;
258 HdPathDataSourceHandle _lightShader;
259 HdPathArrayDataSourceHandle _coordsys;
260 HdMatrixDataSourceHandle _xform;
261 HdContainerDataSourceHandle _attributes;
262
263 };
264
266};
267
268PXR_NAMESPACE_CLOSE_SCOPE
269
270#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 to describe RtParamList.
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