dataSourceGprim.h
1 //
2 // Copyright 2022 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 #ifndef PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_GPRIM_H
25 #define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_GPRIM_H
26 
27 #include "pxr/imaging/hd/dataSource.h"
28 #include "pxr/imaging/hd/dataSourceTypeDefs.h"
29 
30 #include "pxr/usdImaging/usdImaging/dataSourcePrim.h"
31 #include "pxr/usdImaging/usdImaging/dataSourcePrimvars.h"
32 #include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
43 {
44 public:
45  HD_DECLARE_DATASOURCE(UsdImagingDataSourceGprim);
46 
50  bool Has(const TfToken &name) override;
51 
55  TfTokenVector GetNames() override;
56 
59  HdDataSourceBaseHandle Get(const TfToken &name) override;
60 
61 protected:
62 
74  const SdfPath &sceneIndexPath,
75  UsdPrim usdPrim,
76  const UsdImagingDataSourceStageGlobals &stageGlobals);
77 
87  void _AddCustomPrimvar(const TfToken &primvarName, const TfToken &attrName);
88 
89 private:
90  UsdImagingDataSourcePrimvarsAtomicHandle _primvars;
91 
92  UsdImagingDataSourcePrimvars::CustomPrimvarMapping _customPrimvarMapping;
93 };
94 
95 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceGprim);
96 
97 PXR_NAMESPACE_CLOSE_SCOPE
98 
99 #endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_GPRIM_H
Data source representing a USD gprim.
HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the data source representing name, if valid.
TfTokenVector GetNames() override
Returns the names for which this data source can return meaningful results.
UsdImagingDataSourceGprim(const SdfPath &sceneIndexPath, UsdPrim usdPrim, const UsdImagingDataSourceStageGlobals &stageGlobals)
Use to construct a new UsdImagingDataSourceGprim.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Data source representing a basic USD prim.
This class is used as a context object with global stage information, that gets passed down to dataso...
void _AddCustomPrimvar(const TfToken &primvarName, const TfToken &attrName)
Used by derived classes to add primvars not in the primvars: namespace, e.g.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
bool Has(const TfToken &name) override
Returns whether or not this data source can return a meaningful data source for name.