Loading...
Searching...
No Matches
usdRenderVarSchema.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_USD_IMAGING_USD_IMAGING_USD_RENDER_VAR_SCHEMA_H
19#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_VAR_SCHEMA_H
20
22
23#include "pxr/usdImaging/usdImaging/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 USD_IMAGING_USD_RENDER_VAR_SCHEMA_TOKENS \
36 (__usdRenderVar) \
37 (dataType) \
38 (sourceName) \
39 (sourceType) \
40 (namespacedSettings) \
41
42TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderVarSchemaTokens, USDIMAGING_API,
43 USD_IMAGING_USD_RENDER_VAR_SCHEMA_TOKENS);
44
45//-----------------------------------------------------------------------------
46
47
48class UsdImagingUsdRenderVarSchema : public HdSchema
49{
50public:
53
54 UsdImagingUsdRenderVarSchema(HdContainerDataSourceHandle container)
55 : HdSchema(container) {}
56
62 USDIMAGING_API
63 static UsdImagingUsdRenderVarSchema GetFromParent(
64 const HdContainerDataSourceHandle &fromParentContainer);
65
67
68// --(BEGIN CUSTOM CODE: Schema Methods)--
69// --(END CUSTOM CODE: Schema Methods)--
70
73
74 USDIMAGING_API
75 HdTokenDataSourceHandle GetDataType() const;
76
77 USDIMAGING_API
78 HdStringDataSourceHandle GetSourceName() const;
79
80 USDIMAGING_API
81 HdTokenDataSourceHandle GetSourceType() const;
82
83 USDIMAGING_API
84 HdContainerDataSourceHandle GetNamespacedSettings() const;
85
87
90
93 USDIMAGING_API
94 static const TfToken &GetSchemaToken();
95
98 USDIMAGING_API
99 static const HdDataSourceLocator &GetDefaultLocator();
100
102
111
113 USDIMAGING_API
114 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
116
119
127 USDIMAGING_API
128 static HdContainerDataSourceHandle
129 BuildRetained(
130 const HdTokenDataSourceHandle &dataType,
131 const HdStringDataSourceHandle &sourceName,
132 const HdTokenDataSourceHandle &sourceType,
133 const HdContainerDataSourceHandle &namespacedSettings
134 );
135
143 {
144 public:
145 USDIMAGING_API
146 Builder &SetDataType(
147 const HdTokenDataSourceHandle &dataType);
148 USDIMAGING_API
149 Builder &SetSourceName(
150 const HdStringDataSourceHandle &sourceName);
151 USDIMAGING_API
152 Builder &SetSourceType(
153 const HdTokenDataSourceHandle &sourceType);
154 USDIMAGING_API
155 Builder &SetNamespacedSettings(
156 const HdContainerDataSourceHandle &namespacedSettings);
157
159 USDIMAGING_API
160 HdContainerDataSourceHandle Build();
161
162 private:
163 HdTokenDataSourceHandle _dataType;
164 HdStringDataSourceHandle _sourceName;
165 HdTokenDataSourceHandle _sourceType;
166 HdContainerDataSourceHandle _namespacedSettings;
167
168 };
169
171};
172
173PXR_NAMESPACE_CLOSE_SCOPE
174
175#endif
Represents an object that can identify the location of a data source.
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
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
USDIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92