Loading...
Searching...
No Matches
materialInterfaceParameterSchema.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_MATERIAL_INTERFACE_PARAMETER_SCHEMA_H
19#define PXR_IMAGING_HD_MATERIAL_INTERFACE_PARAMETER_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
24#include "pxr/imaging/hd/schemaTypeDefs.h"
25
26#include "pxr/imaging/hd/schema.h"
27
28// --(BEGIN CUSTOM CODE: Includes)--
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
34// --(END CUSTOM CODE: Declares)--
35
36#define HD_MATERIAL_INTERFACE_PARAMETER_SCHEMA_TOKENS \
37 (displayGroup) \
38 (displayName) \
39 (mappings) \
40
41TF_DECLARE_PUBLIC_TOKENS(HdMaterialInterfaceParameterSchemaTokens, HD_API,
42 HD_MATERIAL_INTERFACE_PARAMETER_SCHEMA_TOKENS);
43
44//-----------------------------------------------------------------------------
45
46
81{
82public:
85
86 HdMaterialInterfaceParameterSchema(HdContainerDataSourceHandle container)
87 : HdSchema(container) {}
88
90
91// --(BEGIN CUSTOM CODE: Schema Methods)--
92// --(END CUSTOM CODE: Schema Methods)--
93
96
98 HD_API
99 HdTokenDataSourceHandle GetDisplayGroup() const;
100
102 HD_API
103 HdTokenDataSourceHandle GetDisplayName() const;
104
108 HD_API
110
112
115
123 HD_API
124 static HdContainerDataSourceHandle
126 const HdTokenDataSourceHandle &displayGroup,
127 const HdTokenDataSourceHandle &displayName,
128 const HdVectorDataSourceHandle &mappings
129 );
130
138 {
139 public:
140 HD_API
141 Builder &SetDisplayGroup(
142 const HdTokenDataSourceHandle &displayGroup);
143 HD_API
144 Builder &SetDisplayName(
145 const HdTokenDataSourceHandle &displayName);
146 HD_API
147 Builder &SetMappings(
148 const HdVectorDataSourceHandle &mappings);
149
151 HD_API
152 HdContainerDataSourceHandle Build();
153
154 private:
155 HdTokenDataSourceHandle _displayGroup;
156 HdTokenDataSourceHandle _displayName;
157 HdVectorDataSourceHandle _mappings;
158
159 };
160
162};
163
164PXR_NAMESPACE_CLOSE_SCOPE
165
166#endif
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.
The MaterialInterfaceParameter schema describes a single interface parameter (public UI parameter).
static HD_API HdContainerDataSourceHandle BuildRetained(const HdTokenDataSourceHandle &displayGroup, const HdTokenDataSourceHandle &displayName, const HdVectorDataSourceHandle &mappings)
HD_API HdTokenDataSourceHandle GetDisplayName() const
Optional displayName. Intended for GUI organization.
HD_API HdTokenDataSourceHandle GetDisplayGroup() const
Optional displayGroup. Intended for GUI organization.
HD_API HdMaterialInterfaceMappingVectorSchema GetMappings() const
Maps this singular interface parameter to a vector of target node parameters.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
Template class wrapping a vector data source whose children are container data source conforming to a...
Definition: vectorSchema.h:85
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92