HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dependencySchema.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 // This file is generated by a script. Do not edit directly. Edit the
26 // schema.template.h file to make changes.
27 
28 #ifndef PXR_IMAGING_HD_DEPENDENCY_SCHEMA_H
29 #define PXR_IMAGING_HD_DEPENDENCY_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/schema.h"
34 
36 
37 //-----------------------------------------------------------------------------
38 
39 #define HDDEPENDENCY_SCHEMA_TOKENS \
40  (dependedOnPrimPath) \
41  (dependedOnDataSourceLocator) \
42  (affectedDataSourceLocator) \
43 
44 TF_DECLARE_PUBLIC_TOKENS(HdDependencySchemaTokens, HD_API,
46 
47 //-----------------------------------------------------------------------------
48 
50 {
51 public:
52  HdDependencySchema(HdContainerDataSourceHandle container)
53  : HdSchema(container) {}
54 
55  //ACCESSORS
56 
57  HD_API
59  HD_API
61  HD_API
63 
64  // RETRIEVING AND CONSTRUCTING
65 
66  /// Builds a container data source which includes the provided child data
67  /// sources. Parameters with nullptr values are excluded. This is a
68  /// low-level interface. For cases in which it's desired to define
69  /// the container with a sparse set of child fields, the Builder class
70  /// is often more convenient and readable.
71  HD_API
72  static HdContainerDataSourceHandle
74  const HdPathDataSourceHandle &dependedOnPrimPath,
75  const HdLocatorDataSourceHandle &dependedOnDataSourceLocator,
76  const HdLocatorDataSourceHandle &affectedDataSourceLocator
77  );
78 
79  /// \class HdDependencySchema::Builder
80  ///
81  /// Utility class for setting sparse sets of child data source fields to be
82  /// filled as arguments into BuildRetained. Because all setter methods
83  /// return a reference to the instance, this can be used in the "builder
84  /// pattern" form.
85  class Builder
86  {
87  public:
88  HD_API
90  const HdPathDataSourceHandle &dependedOnPrimPath);
91  HD_API
93  const HdLocatorDataSourceHandle &dependedOnDataSourceLocator);
94  HD_API
96  const HdLocatorDataSourceHandle &affectedDataSourceLocator);
97 
98  /// Returns a container data source containing the members set thus far.
99  HD_API
100  HdContainerDataSourceHandle Build();
101 
102  private:
103  HdPathDataSourceHandle _dependedOnPrimPath;
104  HdLocatorDataSourceHandle _dependedOnDataSourceLocator;
105  HdLocatorDataSourceHandle _affectedDataSourceLocator;
106  };
107 
108 };
109 
111 
112 #endif
HdDependencySchema(HdContainerDataSourceHandle container)
HD_API Builder & SetAffectedDataSourceLocator(const HdLocatorDataSourceHandle &affectedDataSourceLocator)
HD_API HdLocatorDataSourceHandle GetDependedOnDataSourceLocator()
#define HD_API
Definition: api.h:40
#define HDDEPENDENCY_SCHEMA_TOKENS
TF_DECLARE_PUBLIC_TOKENS(HdDependencySchemaTokens, HD_API, HDDEPENDENCY_SCHEMA_TOKENS)
HD_API Builder & SetDependedOnPrimPath(const HdPathDataSourceHandle &dependedOnPrimPath)
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
HdLocatorDataSource::Handle HdLocatorDataSourceHandle
HD_API Builder & SetDependedOnDataSourceLocator(const HdLocatorDataSourceHandle &dependedOnDataSourceLocator)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API HdContainerDataSourceHandle BuildRetained(const HdPathDataSourceHandle &dependedOnPrimPath, const HdLocatorDataSourceHandle &dependedOnDataSourceLocator, const HdLocatorDataSourceHandle &affectedDataSourceLocator)
HD_API HdLocatorDataSourceHandle GetAffectedDataSourceLocator()
HD_API HdPathDataSourceHandle GetDependedOnPrimPath()
HdPathDataSource::Handle HdPathDataSourceHandle