All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 USDIMAGING_COLLECTION_CACHE_H
25 #define USDIMAGING_COLLECTION_CACHE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/usd/usd/collectionAPI.h"
32 
33 #include <boost/noncopyable.hpp>
34 #include <tbb/concurrent_unordered_map.h>
35 #include <tbb/concurrent_queue.h>
36 #include <unordered_map>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
58 class UsdImaging_CollectionCache : boost::noncopyable {
59 public:
62 
67  TfToken UpdateCollection(UsdCollectionAPI const& collection);
68 
71  void RemoveCollection(UsdCollectionAPI const& collection);
72 
74  TfToken
75  GetIdForCollection(UsdCollectionAPI const& collection);
76 
78  // the given path.
80  ComputeCollectionsContainingPath(SdfPath const& path) const;
81 
82 private:
83  // The cache boils down to tracking the correspondence of
84  // collection paths, their computed queries, and the id
85  // assigned to each unique query:
86  //
87  // CollectionPath <=> MembershipQuery <=> AssignedId
88  //
89  // In this scheme, the assigned id provides a compact but
90  // potentially human-meaningful reference to the query,
91  // which we can pass to the renderer.
92  //
93  std::unordered_map<Query, TfToken, Query::Hash> _idForQuery;
94  std::unordered_map<TfToken, Query, TfToken::HashFunctor> _queryForId;
95  std::unordered_map<SdfPath, TfToken, SdfPath::Hash> _idForPath;
96  std::unordered_map<Query, SdfPathSet, Query::Hash> _pathsForQuery;
97 
98  std::mutex _mutex;
99 };
100 
101 
102 PXR_NAMESPACE_CLOSE_SCOPE
103 
104 #endif // USDIMAGING_COLLECTION_CACHE_H
Represents a flattened view of a collection.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
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:287