HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
indexProxy.h
Go to the documentation of this file.
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_IMAGING_INDEX_PROXY_H
25 #define PXR_USD_IMAGING_USD_IMAGING_INDEX_PROXY_H
26 
27 /// \file usdImaging/indexProxy.h
28 
29 #include "pxr/pxr.h"
32 
33 #include "pxr/usd/sdf/path.h"
34 #include "pxr/usd/usd/prim.h"
35 
36 #include "pxr/base/tf/token.h"
37 
38 
40 
41 
42 /// \class UsdImagingIndexProxy
43 ///
44 /// This proxy class exposes a subset of the private Delegate API to
45 /// PrimAdapters.
46 ///
48 public:
49  /// A note on paths/prims: the core function of UsdImagingIndexProxy and
50  /// UsdImagingDelegate is to maintain a set of mappings between USD prims
51  /// and hydra prims (and a set of adapters that know how to translate
52  /// USD properties to hydra buffers). A USD prim can represent multiple
53  /// hydra prims (e.g. point instancer prototypes that are referenced twice),
54  /// and a hydra prim can represent multiple USD prims (e.g. a single hydra
55  /// instancer prim representing multiple native instances).
56  ///
57  /// There are three different prim "namespaces" that the delegate works
58  /// with: "USD paths", which represent paths to USD prims; "index paths",
59  /// which represent paths to hydra prims in the render index; and
60  /// "cache paths", which represent paths to buffers in the value cache
61  /// backing hydra prims. Cache paths and index paths are the same,
62  /// except that index paths have the "delegateID" prefixed onto their path.
63  ///
64  /// Index paths are only used in the interface to hydra. In IndexProxy
65  /// and the adapters, the pattern is to use "cachePath" as a key to look
66  /// up state for a hydra prim; and pass "usdPrim" when we additionally
67  /// need to specify the related USD prim. The naming helps clarify them,
68  /// and the fact that we pass a UsdPrim and not an SdfPath further ensures
69  /// that we pass valid USD paths instead of passing cache paths by mistake.
70 
71 
72  /// Adds a dependency from the given usdPrim to the given cache path.
73  /// Insert* will automatically add a dependency, so this is for hydra prims
74  /// that may depend on more than one usd prim (e.g. subsets, instancers)
76  void AddDependency(SdfPath const& cachePath,
77  UsdPrim const& usdPrim);
78 
79  /// Insert a hydra prim with the specified cache path. As mentioned above,
80  /// the delegateID will be prepended before adding the prim in hydra, but
81  /// cachePath will be the key into all internal usdImaging datastructures.
82  /// usdPrim is the USD prim this hydra prim is representing (e.g. the
83  /// UsdGeomMesh for which we are inserting a hydra mesh). If no
84  /// adapter is specified, UsdImagingDelegate will choose based on Usd
85  /// prim type; some clients (e.g. instancing) want to override the adapter
86  /// choice but this should be used sparingly.
87  ///
88  /// For Rprims and Instancers, "parentPath" is the parent instancer.
90  void InsertRprim(TfToken const& primType,
91  SdfPath const& cachePath,
92  UsdPrim const& usdPrim,
95 
97  void InsertSprim(TfToken const& primType,
98  SdfPath const& cachePath,
99  UsdPrim const& usdPrim,
102 
104  void InsertBprim(TfToken const& primType,
105  SdfPath const& cachePath,
106  UsdPrim const& usdPrim,
109 
111  void InsertInstancer(SdfPath const& cachePath,
112  UsdPrim const& usdPrim,
115 
116  // Mark a prim as needing follow-up work by the delegate
117  // (e.g. TrackVariability); this is automatically called on Insert*, but
118  // needs to manually be called in some special cases like native
119  // instancer population.
121  void Refresh(SdfPath const& cachePath);
122 
123  //
124  // All removals are deferred to avoid surprises during change processing.
125  //
126 
127  // Removes the Rprim at the specified cache path.
128  void RemoveRprim(SdfPath const& cachePath) {
129  _rprimsToRemove.push_back(cachePath);
130  _hdPrimInfoToRemove.push_back(cachePath);
131  _RemoveDependencies(cachePath);
132  }
133 
134  // Removes the Sprim at the specified cache path.
135  void RemoveSprim(TfToken const& primType, SdfPath const& cachePath) {
136  _TypeAndPath primToRemove = {primType, cachePath};
137  _sprimsToRemove.push_back(primToRemove);
138  _hdPrimInfoToRemove.push_back(cachePath);
139  _RemoveDependencies(cachePath);
140  }
141 
142  // Removes the Bprim at the specified cache path.
143  void RemoveBprim(TfToken const& primType, SdfPath const& cachePath) {
144  _TypeAndPath primToRemove = {primType, cachePath};
145  _bprimsToRemove.push_back(primToRemove);
146  _hdPrimInfoToRemove.push_back(cachePath);
147  _RemoveDependencies(cachePath);
148  }
149 
150  // Removes the HdInstancer at the specified cache path.
151  void RemoveInstancer(SdfPath const& cachePath) {
152  _instancersToRemove.push_back(cachePath);
153  _hdPrimInfoToRemove.push_back(cachePath);
154  _RemoveDependencies(cachePath);
155  }
156 
158  void MarkRprimDirty(SdfPath const& cachePath, HdDirtyBits dirtyBits);
159 
161  void MarkSprimDirty(SdfPath const& cachePath, HdDirtyBits dirtyBits);
162 
164  void MarkBprimDirty(SdfPath const& cachePath, HdDirtyBits dirtyBits);
165 
167  void MarkInstancerDirty(SdfPath const& cachePath, HdDirtyBits dirtyBits);
168 
170  bool IsRprimTypeSupported(TfToken const& typeId) const;
171 
173  bool IsSprimTypeSupported(TfToken const& typeId) const;
174 
176  bool IsBprimTypeSupported(TfToken const& typeId) const;
177 
178  // Check if the given path has been populated yet.
180  bool IsPopulated(SdfPath const& cachePath) const;
181 
182  // Recursively repopulate the specified usdPath into the render index.
184  void Repopulate(SdfPath const& usdPath);
185 
188  UsdPrim const& materialPrim);
189 
190  // XXX: This is a workaround for some bugs in USD edit processing, and
191  // the weird use of HdPrimInfo by instanced prims. It removes the dependency
192  // between a hydra prim and whatever USD prim is in its primInfo, since this
193  // dependency is automatically inserted and for instanced prims will
194  // erroneously add a dependency between a hydra prototype and
195  // a USD instancer.
196  //
197  // Pending some refactoring, hopefully this API will disappear.
199  void RemovePrimInfoDependency(SdfPath const& cachePath);
200 
201 private:
202  friend class UsdImagingDelegate;
204  UsdImagingDelegate::_Worker* worker)
205  : _delegate(delegate)
206  , _worker(worker)
207  {}
208 
209  // Sort and de-duplicate "repopulate" paths to prevent double-inserts.
210  // Called by UsdImagingDelegate::ApplyPendingUpdates.
211  void _UniqueifyPathsToRepopulate();
212 
213  bool _AddHdPrimInfo(SdfPath const& cachePath,
214  UsdPrim const& usdPrim,
215  UsdImagingPrimAdapterSharedPtr const& adapter);
216 
218  void _RemoveDependencies(SdfPath const& cachePath);
219 
220  SdfPathVector const& _GetUsdPathsToRepopulate() {
221  return _usdPathsToRepopulate;
222  }
223  void _ProcessRemovals();
224 
225  void _AddTask(SdfPath const& usdPath);
226 
227  struct _TypeAndPath {
228  TfToken primType;
229  SdfPath cachePath;
230  };
231 
232  typedef std::vector<_TypeAndPath> _TypeAndPathVector;
233 
234  typedef std::vector<UsdImagingDelegate::_DependencyMap::value_type>
235  _DependencyVector;
236 
237  UsdImagingDelegate* _delegate;
238  UsdImagingDelegate::_Worker* _worker;
239  SdfPathVector _usdPathsToRepopulate;
240  SdfPathVector _rprimsToRemove;
241  _TypeAndPathVector _sprimsToRemove;
242  _TypeAndPathVector _bprimsToRemove;
243  SdfPathVector _instancersToRemove;
244  SdfPathVector _hdPrimInfoToRemove;
245  _DependencyVector _dependenciesToRemove;
246 };
247 
248 
250 
251 #endif //PXR_USD_IMAGING_USD_IMAGING_INDEX_PROXY_H
USDIMAGING_API void Refresh(SdfPath const &cachePath)
USDIMAGING_API bool IsSprimTypeSupported(TfToken const &typeId) const
#define USDIMAGING_API
Definition: api.h:40
USDIMAGING_API void InsertSprim(TfToken const &primType, SdfPath const &cachePath, UsdPrim const &usdPrim, UsdImagingPrimAdapterSharedPtr adapter=UsdImagingPrimAdapterSharedPtr())
void RemoveInstancer(SdfPath const &cachePath)
Definition: indexProxy.h:151
uint32_t HdDirtyBits
Definition: types.h:127
USDIMAGING_API void MarkInstancerDirty(SdfPath const &cachePath, HdDirtyBits dirtyBits)
friend class UsdImagingIndexProxy
Definition: delegate.h:540
void RemoveRprim(SdfPath const &cachePath)
Definition: indexProxy.h:128
USDIMAGING_API UsdImagingPrimAdapterSharedPtr GetMaterialAdapter(UsdPrim const &materialPrim)
Definition: token.h:87
USDIMAGING_API void InsertBprim(TfToken const &primType, SdfPath const &cachePath, UsdPrim const &usdPrim, UsdImagingPrimAdapterSharedPtr adapter=UsdImagingPrimAdapterSharedPtr())
USDIMAGING_API bool IsRprimTypeSupported(TfToken const &typeId) const
Definition: prim.h:132
USDIMAGING_API void AddDependency(SdfPath const &cachePath, UsdPrim const &usdPrim)
USDIMAGING_API void MarkRprimDirty(SdfPath const &cachePath, HdDirtyBits dirtyBits)
Definition: path.h:288
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
Definition: path.h:209
void RemoveBprim(TfToken const &primType, SdfPath const &cachePath)
Definition: indexProxy.h:143
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
void RemoveSprim(TfToken const &primType, SdfPath const &cachePath)
Definition: indexProxy.h:135
USDIMAGING_API bool IsPopulated(SdfPath const &cachePath) const
USDIMAGING_API void RemovePrimInfoDependency(SdfPath const &cachePath)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< UsdImagingPrimAdapter > UsdImagingPrimAdapterSharedPtr
USDIMAGING_API void InsertRprim(TfToken const &primType, SdfPath const &cachePath, UsdPrim const &usdPrim, UsdImagingPrimAdapterSharedPtr adapter=UsdImagingPrimAdapterSharedPtr())
USDIMAGING_API void MarkSprimDirty(SdfPath const &cachePath, HdDirtyBits dirtyBits)
USDIMAGING_API void MarkBprimDirty(SdfPath const &cachePath, HdDirtyBits dirtyBits)
USDIMAGING_API void InsertInstancer(SdfPath const &cachePath, UsdPrim const &usdPrim, UsdImagingPrimAdapterSharedPtr adapter=UsdImagingPrimAdapterSharedPtr())
USDIMAGING_API void Repopulate(SdfPath const &usdPath)
USDIMAGING_API bool IsBprimTypeSupported(TfToken const &typeId) const