dataSourceVolume.h
1 //
2 // Copyright 2020 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_IMAGING_DATA_SOURCE_VOLUME_H
26 #define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_VOLUME_H
27 
28 #include "pxr/usdImaging/usdImaging/dataSourceGprim.h"
29 #include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
30 
31 #include "pxr/usd/usdVol/volume.h"
32 
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
41 {
42 public:
43  HD_DECLARE_DATASOURCE(UsdImagingDataSourceVolumeFieldBindings);
44 
45  bool Has(const TfToken & name) override;
46  TfTokenVector GetNames() override;
47  HdDataSourceBaseHandle Get(const TfToken & name) override;
48 
49 private:
50 
51  // Private constructor, use static New() instead.
53  UsdVolVolume usdVolume,
54  const UsdImagingDataSourceStageGlobals &stageGlobals);
55 
56 
57 private:
58  UsdVolVolume _usdVolume;
59  const UsdImagingDataSourceStageGlobals &_stageGlobals;
60 };
61 
62 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceVolumeFieldBindings);
63 
64 // ----------------------------------------------------------------------------
65 
71 {
72 public:
73  HD_DECLARE_DATASOURCE(UsdImagingDataSourceVolumePrim);
74 
75  bool Has(const TfToken &name) override;
76  TfTokenVector GetNames() override;
77  HdDataSourceBaseHandle Get(const TfToken &name) override;
78 
79  static
81  Invalidate(const TfToken &subprim, const TfTokenVector &properties);
82 
83 private:
84  // Private constructor, use static New() instead.
86  const SdfPath &sceneIndexPath,
87  UsdPrim usdPrim,
88  const UsdImagingDataSourceStageGlobals &stageGlobals);
89 };
90 
91 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceVolumePrim);
92 
93 PXR_NAMESPACE_CLOSE_SCOPE
94 
95 #endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_VOLUME_H
Data source representing a USD gprim.
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...
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition: dataSource.h:102
A renderable volume primitive.
Definition: volume.h:73
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
TfTokenVector GetNames() override
Returns the names for which this data source can return meaningful results.
This class is used as a context object with global stage information, that gets passed down to dataso...
A container data source representing volume field binding information.
Represents a set of data source locators closed under descendancy.
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.
TfTokenVector GetNames() override
Returns the list of names for which Get(...) is expected to return a non-null value.
HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the child datasource of the given name.
bool Has(const TfToken &name) override
Returns whether or not this data source can return a meaningful data source for name.
A prim data source representing a UsdVolVolume prim.