Loading...
Searching...
No Matches
materialInterfaceMappingSchema.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_MAPPING_SCHEMA_H
19#define PXR_IMAGING_HD_MATERIAL_INTERFACE_MAPPING_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_MATERIAL_INTERFACE_MAPPING_SCHEMA_TOKENS \
36 (nodePath) \
37 (inputName) \
38
39TF_DECLARE_PUBLIC_TOKENS(HdMaterialInterfaceMappingSchemaTokens, HD_API,
40 HD_MATERIAL_INTERFACE_MAPPING_SCHEMA_TOKENS);
41
42//-----------------------------------------------------------------------------
43
44// The MaterialInterfaceMapping schema identifies a material node parameter
45// using its two members 'nodePath' and 'inputName'.
46//
47// See MaterialNetwork schema's documentation on its 'interfaceMappings'
48// member for an example.
49//
50
51class HdMaterialInterfaceMappingSchema : public HdSchema
52{
53public:
56
57 HdMaterialInterfaceMappingSchema(HdContainerDataSourceHandle container)
58 : HdSchema(container) {}
59
61
62// --(BEGIN CUSTOM CODE: Schema Methods)--
63
67 HdDataSourceLocator BuildNetworkRelativeLocator();
68
69// --(END CUSTOM CODE: Schema Methods)--
70
73
74 HD_API
75 HdTokenDataSourceHandle GetNodePath() const;
76
77 HD_API
78 HdTokenDataSourceHandle GetInputName() const;
79
81
84
92 HD_API
93 static HdContainerDataSourceHandle
94 BuildRetained(
95 const HdTokenDataSourceHandle &nodePath,
96 const HdTokenDataSourceHandle &inputName
97 );
98
106 {
107 public:
108 HD_API
109 Builder &SetNodePath(
110 const HdTokenDataSourceHandle &nodePath);
111 HD_API
112 Builder &SetInputName(
113 const HdTokenDataSourceHandle &inputName);
114
116 HD_API
117 HdContainerDataSourceHandle Build();
118
119 private:
120 HdTokenDataSourceHandle _nodePath;
121 HdTokenDataSourceHandle _inputName;
122
123 };
124
126};
127
128PXR_NAMESPACE_CLOSE_SCOPE
129
130#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
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81