field3dAssetAdapter.h
1 //
2 // Copyright 2018 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_VOL_IMAGING_FIELD3D_ASSET_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_VOL_IMAGING_FIELD3D_ASSET_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
31 #include "pxr/usdImaging/usdVolImaging/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdPrim;
37 
43 public:
45 
48  {}
49 
50  USDVOLIMAGING_API
52 
53  // ---------------------------------------------------------------------- //
55  // ---------------------------------------------------------------------- //
56 
57  USDIMAGING_API
58  TfTokenVector GetImagingSubprims() override;
59 
60  USDIMAGING_API
61  TfToken GetImagingSubprimType(TfToken const& subprim) override;
62 
63  USDIMAGING_API
64  HdContainerDataSourceHandle GetImagingSubprimData(
65  TfToken const& subprim,
66  UsdPrim const& prim,
67  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
68 
69  // ---------------------------------------------------------------------- //
71  // ---------------------------------------------------------------------- //
72 
73  USDVOLIMAGING_API
74  VtValue Get(UsdPrim const& prim,
75  SdfPath const& cachePath,
76  TfToken const& key,
77  UsdTimeCode time,
78  VtIntArray *outIndices) const override;
79 
80  USDVOLIMAGING_API
81  TfToken GetPrimTypeToken() const override;
82 };
83 
84 
85 PXR_NAMESPACE_CLOSE_SCOPE
86 
87 #endif // PXR_USD_IMAGING_USD_VOL_IMAGING_FIELD3D_ASSET_ADAPTER_H
Base class for all USD fields.
Definition: fieldAdapter.h:42
USDVOLIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Adapter class for fields of type Field3DAsset.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
This class is used as a context object with global stage information, that gets passed down to dataso...
Base class for all PrimAdapters.
Definition: primAdapter.h:67
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
USDVOLIMAGING_API TfToken GetPrimTypeToken() const override
Returns the token specifying the Hydra primitive type that is created by this adapter.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166