extComputationPrimvarSchema.h
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 //
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_EXT_COMPUTATION_PRIMVAR_SCHEMA_H
29 #define PXR_IMAGING_HD_EXT_COMPUTATION_PRIMVAR_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/primvarSchema.h"
34 
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 //-----------------------------------------------------------------------------
39 
40 #define HDEXTCOMPUTATIONPRIMVAR_SCHEMA_TOKENS \
41  (interpolation) \
42  (role) \
43  (sourceComputation) \
44  (sourceComputationOutputName) \
45  (valueType) \
46 
47 TF_DECLARE_PUBLIC_TOKENS(HdExtComputationPrimvarSchemaTokens, HD_API,
48  HDEXTCOMPUTATIONPRIMVAR_SCHEMA_TOKENS);
49 
50 //-----------------------------------------------------------------------------
51 
52 class HdExtComputationPrimvarSchema : public HdSchema
53 {
54 public:
55  HdExtComputationPrimvarSchema(HdContainerDataSourceHandle container)
56  : HdSchema(container) {}
57 
58  //ACCESSORS
59 
60  HD_API
61  HdTokenDataSourceHandle GetInterpolation();
62  HD_API
63  HdTokenDataSourceHandle GetRole();
64  HD_API
65  HdPathDataSourceHandle GetSourceComputation();
66  HD_API
67  HdTokenDataSourceHandle GetSourceComputationOutputName();
68  HD_API
69  HdTupleTypeDataSourceHandle GetValueType();
70 
71  // RETRIEVING AND CONSTRUCTING
72 
78  HD_API
79  static HdContainerDataSourceHandle
80  BuildRetained(
81  const HdTokenDataSourceHandle &interpolation,
82  const HdTokenDataSourceHandle &role,
83  const HdPathDataSourceHandle &sourceComputation,
84  const HdTokenDataSourceHandle &sourceComputationOutputName,
85  const HdTupleTypeDataSourceHandle &valueType
86  );
87 
94  class Builder
95  {
96  public:
97  HD_API
98  Builder &SetInterpolation(
99  const HdTokenDataSourceHandle &interpolation);
100  HD_API
101  Builder &SetRole(
102  const HdTokenDataSourceHandle &role);
103  HD_API
104  Builder &SetSourceComputation(
105  const HdPathDataSourceHandle &sourceComputation);
106  HD_API
107  Builder &SetSourceComputationOutputName(
108  const HdTokenDataSourceHandle &sourceComputationOutputName);
109  HD_API
110  Builder &SetValueType(
111  const HdTupleTypeDataSourceHandle &valueType);
112 
114  HD_API
115  HdContainerDataSourceHandle Build();
116 
117  private:
118  HdTokenDataSourceHandle _interpolation;
119  HdTokenDataSourceHandle _role;
120  HdPathDataSourceHandle _sourceComputation;
121  HdTokenDataSourceHandle _sourceComputationOutputName;
122  HdTupleTypeDataSourceHandle _valueType;
123  };
124 
125  // these return statically allocated instances for the common cases.
126  static HdTokenDataSourceHandle BuildInterpolationDataSource(
127  TfToken interpolation) {
128  return HdPrimvarSchema::BuildInterpolationDataSource(interpolation);
129  }
130 
131  static HdTokenDataSourceHandle BuildRoleDataSource(TfToken role) {
132  return HdPrimvarSchema::BuildRoleDataSource(role);
133  }
134 
135 
136 };
137 
138 PXR_NAMESPACE_CLOSE_SCOPE
139 
140 #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.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43