pointsAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_POINTS_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_POINTS_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
42 {
43 public:
45 
48  {}
49 
50  USDIMAGING_API
51  ~UsdImagingPointsAdapter() override;
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  USDIMAGING_API
75  UsdPrim const& prim,
76  UsdImagingIndexProxy* index,
77  UsdImagingInstancerContext const* instancerContext = nullptr) override;
78 
79  USDIMAGING_API
80  bool IsSupported(UsdImagingIndexProxy const* index) const override;
81 
82  // ---------------------------------------------------------------------- //
84  // ---------------------------------------------------------------------- //
85 
87  USDIMAGING_API
88  void TrackVariability(
89  UsdPrim const& prim,
90  SdfPath const& cachePath,
91  HdDirtyBits* timeVaryingBits,
92  UsdImagingInstancerContext const* instancerContext = nullptr)
93  const override;
94 
96  USDIMAGING_API
97  void UpdateForTime(
98  UsdPrim const& prim,
99  SdfPath const& cachePath,
100  UsdTimeCode time,
101  HdDirtyBits requestedBits,
102  UsdImagingInstancerContext const* instancerContext = nullptr)
103  const override;
104 
105  // ---------------------------------------------------------------------- //
107  // ---------------------------------------------------------------------- //
108 
109  USDIMAGING_API
110  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
111  SdfPath const& cachePath,
112  TfToken const& propertyName) override;
113 
114  // ---------------------------------------------------------------------- //
116  // ---------------------------------------------------------------------- //
117 
118  USDIMAGING_API
119  VtValue Get(UsdPrim const& prim,
120  SdfPath const& cachePath,
121  TfToken const& key,
122  UsdTimeCode time,
123  VtIntArray *outIndices) const override;
124 
125 protected:
126  USDIMAGING_API
127  bool _IsBuiltinPrimvar(TfToken const& primvarName) const override;
128 };
129 
130 
131 PXR_NAMESPACE_CLOSE_SCOPE
132 
133 #endif // PXR_USD_IMAGING_USD_IMAGING_POINTS_ADAPTER_H
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:48
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
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
USDIMAGING_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...
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
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
Delegate support for UsdGeomPoints.
Definition: pointsAdapter.h:41
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166