HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdImaging/pointsAdapter.h
28 
29 #include "pxr/pxr.h"
33 
35 
36 
37 /// \class UsdImagingPointsAdapter
38 ///
39 /// Delegate support for UsdGeomPoints.
40 ///
42 {
43 public:
45 
48  {}
49 
51  ~UsdImagingPointsAdapter() override;
52 
53  // ---------------------------------------------------------------------- //
54  /// \name Scene Index Support
55  // ---------------------------------------------------------------------- //
56 
58  TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
59 
62  UsdPrim const& prim,
63  TfToken const& subprim) override;
64 
66  HdContainerDataSourceHandle GetImagingSubprimData(
67  UsdPrim const& prim,
68  TfToken const& subprim,
69  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
70 
73  UsdPrim const& prim,
74  TfToken const& subprim,
75  TfTokenVector const& properties,
76  UsdImagingPropertyInvalidationType invalidationType) override;
77 
78  // ---------------------------------------------------------------------- //
79  /// \name Initialization
80  // ---------------------------------------------------------------------- //
81 
84  UsdPrim const& prim,
86  UsdImagingInstancerContext const* instancerContext = nullptr) override;
87 
89  bool IsSupported(UsdImagingIndexProxy const* index) const override;
90 
91  // ---------------------------------------------------------------------- //
92  /// \name Parallel Setup and Resolve
93  // ---------------------------------------------------------------------- //
94 
95  /// Thread Safe.
97  void TrackVariability(
98  UsdPrim const& prim,
99  SdfPath const& cachePath,
100  HdDirtyBits* timeVaryingBits,
101  UsdImagingInstancerContext const* instancerContext = nullptr)
102  const override;
103 
104  /// Thread Safe.
106  void UpdateForTime(
107  UsdPrim const& prim,
108  SdfPath const& cachePath,
110  HdDirtyBits requestedBits,
111  UsdImagingInstancerContext const* instancerContext = nullptr)
112  const override;
113 
114  // ---------------------------------------------------------------------- //
115  /// \name Change Processing
116  // ---------------------------------------------------------------------- //
117 
120  SdfPath const& cachePath,
121  TfToken const& propertyName) override;
122 
123  // ---------------------------------------------------------------------- //
124  /// \name Data access
125  // ---------------------------------------------------------------------- //
126 
128  VtValue Get(UsdPrim const& prim,
129  SdfPath const& cachePath,
130  TfToken const& key,
132  VtIntArray *outIndices) const override;
133 
134 protected:
136  bool _IsBuiltinPrimvar(TfToken const& primvarName) const override;
137 };
138 
139 
141 
142 #endif // PXR_USD_IMAGING_USD_IMAGING_POINTS_ADAPTER_H
#define USDIMAGING_API
Definition: api.h:40
USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
USDIMAGING_API bool _IsBuiltinPrimvar(TfToken const &primvarName) const override
GT_API const UT_StringHolder time
uint32_t HdDirtyBits
Definition: types.h:158
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API TfTokenVector GetImagingSubprims(UsdPrim const &prim) override
Definition: token.h:87
USDIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData(UsdPrim const &prim, TfToken const &subprim, const UsdImagingDataSourceStageGlobals &stageGlobals) override
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API TfToken GetImagingSubprimType(UsdPrim const &prim, TfToken const &subprim) override
Definition: prim.h:135
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:291
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
GLuint index
Definition: glcorearb.h:786
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
USDIMAGING_API ~UsdImagingPointsAdapter() override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim(UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Definition: value.h:167
UsdImagingPropertyInvalidationType
Definition: types.h:34