dataSourceFieldAsset.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 
25 #ifndef PXR_USD_IMAGING_USD_VOL_IMAGING_DATA_SOURCE_FIELD_ASSET_H
26 #define PXR_USD_IMAGING_USD_VOL_IMAGING_DATA_SOURCE_FIELD_ASSET_H
27 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usdImaging/usdVolImaging/api.h"
32 
33 #include "pxr/usdImaging/usdImaging/dataSourcePrim.h"
34 #include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
35 #include "pxr/imaging/hd/dataSource.h"
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
45 {
46 public:
47  HD_DECLARE_DATASOURCE(UsdImagingDataSourceFieldAsset);
48 
49  bool Has(const TfToken &name) override;
50  TfTokenVector GetNames() override;
51  HdDataSourceBaseHandle Get(const TfToken &name) override;
52 
53  USDVOLIMAGING_API
55 
56 private:
57 
58  // Private constructor, use static New() instead.
60  const SdfPath &sceneIndexPath,
61  UsdPrim usdPrim,
62  const UsdImagingDataSourceStageGlobals &stageGlobals);
63 
64 private:
65  const SdfPath _sceneIndexPath;
66  UsdPrim _usdPrim;
67  const UsdImagingDataSourceStageGlobals & _stageGlobals;
68 };
69 
70 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceFieldAsset);
71 
77 {
78 public:
79  HD_DECLARE_DATASOURCE(UsdImagingDataSourceFieldAssetPrim);
80 
81  bool Has(const TfToken &name) override;
82  TfTokenVector GetNames() override;
83  HdDataSourceBaseHandle Get(const TfToken &name) override;
84 
85 private:
86 
87  // Private constructor, use static New() instead.
89  const SdfPath &sceneIndexPath,
90  UsdPrim usdPrim,
91  const UsdImagingDataSourceStageGlobals &stageGlobals);
92 };
93 
94 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceFieldAssetPrim);
95 
96 PXR_NAMESPACE_CLOSE_SCOPE
97 
98 #endif // PXR_USD_IMAGING_USD_VOL_IMAGING_DATA_SOURCE_FIELD_ASSET_H
A prim data source representing UsdVolOpenVDBAsset or UsdVolField3DAsset.
bool Has(const TfToken &name) override
Returns whether or not this data source can return a meaningful data source for name.
A container data source representing volumeField info.
TfTokenVector GetNames() override
Returns the names for which this data source can return meaningful results.
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition: dataSource.h:102
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...
bool Has(const TfToken &name) override
Returns true if the container has a child datasource of the given name, in which case Get(name) is ex...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
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
HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the data source representing name, if valid.
HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the child datasource of the given name.
TfTokenVector GetNames() override
Returns the list of names for which Get(...) is expected to return a non-null value.