Loading...
Searching...
No Matches
renderVarSchema.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_RENDER_VAR_SCHEMA_H
19#define PXR_IMAGING_HD_RENDER_VAR_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_RENDER_VAR_SCHEMA_TOKENS \
36 (renderVar) \
37 (path) \
38 (dataType) \
39 (sourceName) \
40 (sourceType) \
41 (namespacedSettings) \
42
43TF_DECLARE_PUBLIC_TOKENS(HdRenderVarSchemaTokens, HD_API,
44 HD_RENDER_VAR_SCHEMA_TOKENS);
45
46//-----------------------------------------------------------------------------
47
48
51class HdRenderVarSchema : public HdSchema
52{
53public:
56
57 HdRenderVarSchema(HdContainerDataSourceHandle container)
58 : HdSchema(container) {}
59
65 HD_API
66 static HdRenderVarSchema GetFromParent(
67 const HdContainerDataSourceHandle &fromParentContainer);
68
70
71// --(BEGIN CUSTOM CODE: Schema Methods)--
72// --(END CUSTOM CODE: Schema Methods)--
73
76
77 HD_API
78 HdPathDataSourceHandle GetPath() const;
79
80 HD_API
81 HdTokenDataSourceHandle GetDataType() const;
82
83 HD_API
84 HdTokenDataSourceHandle GetSourceName() const;
85
86 HD_API
87 HdTokenDataSourceHandle GetSourceType() const;
88
89 HD_API
90 HdContainerDataSourceHandle GetNamespacedSettings() const;
91
93
96
99 HD_API
100 static const TfToken &GetSchemaToken();
101
104 HD_API
105 static const HdDataSourceLocator &GetDefaultLocator();
106
108
117
119 HD_API
120 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
122
125
133 HD_API
134 static HdContainerDataSourceHandle
135 BuildRetained(
136 const HdPathDataSourceHandle &path,
137 const HdTokenDataSourceHandle &dataType,
138 const HdTokenDataSourceHandle &sourceName,
139 const HdTokenDataSourceHandle &sourceType,
140 const HdContainerDataSourceHandle &namespacedSettings
141 );
142
150 {
151 public:
152 HD_API
153 Builder &SetPath(
154 const HdPathDataSourceHandle &path);
155 HD_API
156 Builder &SetDataType(
157 const HdTokenDataSourceHandle &dataType);
158 HD_API
159 Builder &SetSourceName(
160 const HdTokenDataSourceHandle &sourceName);
161 HD_API
162 Builder &SetSourceType(
163 const HdTokenDataSourceHandle &sourceType);
164 HD_API
165 Builder &SetNamespacedSettings(
166 const HdContainerDataSourceHandle &namespacedSettings);
167
169 HD_API
170 HdContainerDataSourceHandle Build();
171
172 private:
173 HdPathDataSourceHandle _path;
174 HdTokenDataSourceHandle _dataType;
175 HdTokenDataSourceHandle _sourceName;
176 HdTokenDataSourceHandle _sourceType;
177 HdContainerDataSourceHandle _namespacedSettings;
178
179 };
180
182};
183
184PXR_NAMESPACE_CLOSE_SCOPE
185
186#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