All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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
49class HdRenderVarSchema : public HdSchema
50{
51public:
54
55 HdRenderVarSchema(HdContainerDataSourceHandle container)
56 : HdSchema(container) {}
57
63 HD_API
64 static HdRenderVarSchema GetFromParent(
65 const HdContainerDataSourceHandle &fromParentContainer);
66
68
69// --(BEGIN CUSTOM CODE: Schema Methods)--
70// --(END CUSTOM CODE: Schema Methods)--
71
74
75 HD_API
76 HdPathDataSourceHandle GetPath() const;
77
78 HD_API
79 HdTokenDataSourceHandle GetDataType() const;
80
81 HD_API
82 HdTokenDataSourceHandle GetSourceName() const;
83
84 HD_API
85 HdTokenDataSourceHandle GetSourceType() const;
86
87 HD_API
88 HdContainerDataSourceHandle GetNamespacedSettings() const;
89
91
94
97 HD_API
98 static const TfToken &GetSchemaToken();
99
102 HD_API
103 static const HdDataSourceLocator &GetDefaultLocator();
104
106
115
117 HD_API
118 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
120
123
131 HD_API
132 static HdContainerDataSourceHandle
133 BuildRetained(
134 const HdPathDataSourceHandle &path,
135 const HdTokenDataSourceHandle &dataType,
136 const HdTokenDataSourceHandle &sourceName,
137 const HdTokenDataSourceHandle &sourceType,
138 const HdContainerDataSourceHandle &namespacedSettings
139 );
140
148 {
149 public:
150 HD_API
151 Builder &SetPath(
152 const HdPathDataSourceHandle &path);
153 HD_API
154 Builder &SetDataType(
155 const HdTokenDataSourceHandle &dataType);
156 HD_API
157 Builder &SetSourceName(
158 const HdTokenDataSourceHandle &sourceName);
159 HD_API
160 Builder &SetSourceType(
161 const HdTokenDataSourceHandle &sourceType);
162 HD_API
163 Builder &SetNamespacedSettings(
164 const HdContainerDataSourceHandle &namespacedSettings);
165
167 HD_API
168 HdContainerDataSourceHandle Build();
169
170 private:
171 HdPathDataSourceHandle _path;
172 HdTokenDataSourceHandle _dataType;
173 HdTokenDataSourceHandle _sourceName;
174 HdTokenDataSourceHandle _sourceType;
175 HdContainerDataSourceHandle _namespacedSettings;
176
177 };
178
180};
181
182PXR_NAMESPACE_CLOSE_SCOPE
183
184#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:81