collectionCache.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_COLLECTION_CACHE_H
25 #define PXR_USD_IMAGING_USD_IMAGING_COLLECTION_CACHE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 #include <boost/noncopyable.hpp>
34 #include <tbb/concurrent_unordered_map.h>
35 #include <tbb/concurrent_queue.h>
36 #include <mutex>
37 #include <unordered_map>
38 
39 PXR_NAMESPACE_OPEN_SCOPE
40 
59 class UsdImaging_CollectionCache : boost::noncopyable {
60 public:
63 
70  bool
71  UpdateCollection(UsdCollectionAPI const& collection);
72 
74  size_t
75  RemoveCollection(UsdStageWeakPtr const& stage, SdfPath const& path);
76 
78  TfToken
79  GetIdForCollection(UsdCollectionAPI const& collection);
80 
82  // the given path.
84  ComputeCollectionsContainingPath(SdfPath const& path) const;
85 
88  SdfPathSet const&
89  GetDirtyPaths() const;
90 
92  void
93  ClearDirtyPaths();
94 
95 private:
96  // The cache boils down to tracking the correspondence of
97  // collection paths, their computed queries, and the id
98  // assigned to each unique query:
99  //
100  // CollectionPath <=> MembershipQuery <=> AssignedId
101  //
102  // In this scheme, the assigned id provides a compact but
103  // potentially human-meaningful reference to the query,
104  // which we can pass to the renderer.
105  //
106  std::unordered_map<Query, TfToken, Query::Hash> _idForQuery;
107  std::unordered_map<TfToken, Query, TfToken::HashFunctor> _queryForId;
108  std::unordered_map<SdfPath, TfToken, SdfPath::Hash> _idForPath;
109  std::unordered_map<Query, SdfPathSet, Query::Hash> _pathsForQuery;
110 
111  void
112  _MarkCollectionContentDirty(
113  UsdStageWeakPtr const& stage,
114  UsdCollectionAPI::MembershipQuery const& query);
115 
116  SdfPathSet _dirtyPaths;
117 
118  std::mutex _mutex;
119 };
120 
121 
122 PXR_NAMESPACE_CLOSE_SCOPE
123 
124 #endif // PXR_USD_IMAGING_USD_IMAGING_COLLECTION_CACHE_H
Represents a flattened view of a collection.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
This is a general purpose API schema, used to describe a collection of heterogeneous objects within t...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290