HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resolverScopedCache.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_AR_RESOLVER_SCOPED_CACHE_H
25 #define PXR_USD_AR_RESOLVER_SCOPED_CACHE_H
26 
27 /// \file ar/resolverScopedCache.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/ar/api.h"
31 #include "pxr/base/vt/value.h"
32 
34 
35 /// \class ArResolverScopedCache
36 ///
37 /// Helper object for managing asset resolver cache scopes.
38 ///
39 /// A scoped resolution cache indicates to the resolver that results of
40 /// calls to Resolve should be cached for a certain scope. This is
41 /// important for performance and also for consistency -- it ensures
42 /// that repeated calls to Resolve with the same parameters will
43 /// return the same result.
44 ///
45 /// \see \ref ArResolver_scopedCache "Scoped Resolution Cache"
47 {
48 public:
49 
50  // Disallow copies
53 
54  /// Begin an asset resolver cache scope.
55  ///
56  /// Calls ArResolver::BeginCacheScope on the configured asset resolver
57  /// and saves the cacheScopeData populated by that function.
58  AR_API
60 
61  /// Begin an asset resolver cache scope that shares data
62  /// with the given \p parent scope.
63  ///
64  /// Calls ArResolver::BeginCacheScope on the configured asset resolver,
65  /// saves the cacheScopeData stored in \p parent and passes that to that
66  /// function.
67  AR_API
68  explicit ArResolverScopedCache(const ArResolverScopedCache* parent);
69 
70  /// End an asset resolver cache scope.
71  ///
72  /// Calls ArResolver::EndCacheScope on the configured asset resolver,
73  /// passing the saved cacheScopeData to that function.
74  AR_API
76 
77 private:
78  VtValue _cacheScopeData;
79 };
80 
82 
83 #endif // PXR_USD_AR_RESOLVER_SCOPED_CACHE_H
ArResolverScopedCache & operator=(const ArResolverScopedCache &)=delete
#define AR_API
Definition: api.h:40
AR_API ArResolverScopedCache()
AR_API ~ArResolverScopedCache()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: value.h:174