Loading...
Searching...
No Matches
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 <tbb/concurrent_unordered_map.h>
34#include <tbb/concurrent_queue.h>
35#include <mutex>
36#include <unordered_map>
37
38PXR_NAMESPACE_OPEN_SCOPE
39
58class UsdImaging_CollectionCache {
59public:
60 UsdImaging_CollectionCache() = default;
61 UsdImaging_CollectionCache(const UsdImaging_CollectionCache&) = delete;
62 UsdImaging_CollectionCache& operator=(const UsdImaging_CollectionCache&) = delete;
63
66
73 USDIMAGING_API
74 bool
75 UpdateCollection(UsdCollectionAPI const& collection);
76
78 USDIMAGING_API
79 size_t
80 RemoveCollection(UsdStageWeakPtr const& stage, SdfPath const& path);
81
83 USDIMAGING_API
85 GetIdForCollection(UsdCollectionAPI const& collection);
86
88 // the given path.
89 USDIMAGING_API
91 ComputeCollectionsContainingPath(SdfPath const& path) const;
92
95 USDIMAGING_API
96 SdfPathSet const&
97 GetDirtyPaths() const;
98
100 USDIMAGING_API
101 void
102 ClearDirtyPaths();
103
104private:
105 // The cache boils down to tracking the correspondence of
106 // collection paths, their computed queries, and the id
107 // assigned to each unique query:
108 //
109 // CollectionPath <=> MembershipQuery <=> AssignedId
110 //
111 // In this scheme, the assigned id provides a compact but
112 // potentially human-meaningful reference to the query,
113 // which we can pass to the renderer.
114 //
115 std::unordered_map<Query, TfToken, Query::Hash> _idForQuery;
116 std::unordered_map<TfToken, Query, TfToken::HashFunctor> _queryForId;
117 std::unordered_map<SdfPath, TfToken, SdfPath::Hash> _idForPath;
118 std::unordered_map<Query, SdfPathSet, Query::Hash> _pathsForQuery;
119
120 void
121 _MarkCollectionContentDirty(
122 UsdStageWeakPtr const& stage,
124
125 SdfPathSet _dirtyPaths;
126
127 std::mutex _mutex;
128};
129
130
131PXR_NAMESPACE_CLOSE_SCOPE
132
133#endif // PXR_USD_IMAGING_USD_IMAGING_COLLECTION_CACHE_H
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
This is a general purpose API schema, used to describe a collection of heterogeneous objects within t...
Represents a flattened view of a collection.
Represents an arbitrary dimensional rectangular container class.
Definition: array.h:228