HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
materialConnectionSchema.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 //
7 ////////////////////////////////////////////////////////////////////////
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_CONNECTION_SCHEMA_H
19 #define PXR_IMAGING_HD_MATERIAL_CONNECTION_SCHEMA_H
20 
21 /// \file
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 
31 
32 // --(BEGIN CUSTOM CODE: Declares)--
33 // --(END CUSTOM CODE: Declares)--
34 
35 #define HD_MATERIAL_CONNECTION_SCHEMA_TOKENS \
36  (upstreamNodePath) \
37  (upstreamNodeOutputName) \
38 
39 TF_DECLARE_PUBLIC_TOKENS(HdMaterialConnectionSchemaTokens, HD_API,
41 
42 //-----------------------------------------------------------------------------
43 
44 // The MaterialConnection schema defines an upstream connected node and
45 // output.
46 //
47 // See MaterialNode schema's documentation on its 'inputConnections' member
48 // for an example.
49 //
50 
52 {
53 public:
54  /// \name Schema retrieval
55  /// @{
56 
57  HdMaterialConnectionSchema(HdContainerDataSourceHandle container)
58  : HdSchema(container) {}
59 
60  /// @}
61 
62 // --(BEGIN CUSTOM CODE: Schema Methods)--
63 // --(END CUSTOM CODE: Schema Methods)--
64 
65  /// \name Member accessor
66  /// @{
67 
68  HD_API
70 
71  HD_API
73 
74  /// @}
75 
76  /// \name Schema construction
77  /// @{
78 
79  /// \deprecated Use Builder instead.
80  ///
81  /// Builds a container data source which includes the provided child data
82  /// sources. Parameters with nullptr values are excluded. This is a
83  /// low-level interface. For cases in which it's desired to define
84  /// the container with a sparse set of child fields, the Builder class
85  /// is often more convenient and readable.
86  HD_API
87  static HdContainerDataSourceHandle
89  const HdTokenDataSourceHandle &upstreamNodePath,
90  const HdTokenDataSourceHandle &upstreamNodeOutputName
91  );
92 
93  /// \class HdMaterialConnectionSchema::Builder
94  ///
95  /// Utility class for setting sparse sets of child data source fields to be
96  /// filled as arguments into BuildRetained. Because all setter methods
97  /// return a reference to the instance, this can be used in the "builder
98  /// pattern" form.
99  class Builder
100  {
101  public:
102  HD_API
104  const HdTokenDataSourceHandle &upstreamNodePath);
105  HD_API
107  const HdTokenDataSourceHandle &upstreamNodeOutputName);
108 
109  /// Returns a container data source containing the members set thus far.
110  HD_API
111  HdContainerDataSourceHandle Build();
112 
113  private:
114  HdTokenDataSourceHandle _upstreamNodePath;
115  HdTokenDataSourceHandle _upstreamNodeOutputName;
116 
117  };
118 
119  /// @}
120 };
121 
123 
124 #endif
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
TF_DECLARE_PUBLIC_TOKENS(HdMaterialConnectionSchemaTokens, HD_API, HD_MATERIAL_CONNECTION_SCHEMA_TOKENS)
HD_API HdTokenDataSourceHandle GetUpstreamNodeOutputName() const
#define HD_MATERIAL_CONNECTION_SCHEMA_TOKENS
#define HD_API
Definition: api.h:23
HdMaterialConnectionSchema(HdContainerDataSourceHandle container)
HD_API HdTokenDataSourceHandle GetUpstreamNodePath() const
HD_API Builder & SetUpstreamNodeOutputName(const HdTokenDataSourceHandle &upstreamNodeOutputName)
static HD_API HdContainerDataSourceHandle BuildRetained(const HdTokenDataSourceHandle &upstreamNodePath, const HdTokenDataSourceHandle &upstreamNodeOutputName)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
HD_API Builder & SetUpstreamNodePath(const HdTokenDataSourceHandle &upstreamNodePath)
HdTokenDataSource::Handle HdTokenDataSourceHandle