HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resolverContextBinder.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_CONTEXT_BINDER_H
25 #define PXR_USD_AR_RESOLVER_CONTEXT_BINDER_H
26 
27 /// \file ar/resolverContextBinder.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/ar/api.h"
32 #include "pxr/base/vt/value.h"
33 
35 
36 class ArResolver;
37 
38 /// \class ArResolverContextBinder
39 ///
40 /// Helper object for managing the binding and unbinding of
41 /// ArResolverContext objects with the asset resolver.
42 ///
43 /// \see \ref ArResolver_context "Asset Resolver Context Operations"
45 {
46 public:
47  /// Bind the given \p context with the asset resolver.
48  ///
49  /// Calls ArResolver::BindContext on the configured asset resolver
50  /// and saves the bindingData populated by that function.
51  AR_API
53  const ArResolverContext& context);
54 
55  /// Bind the given \p context to the given \p assetResolver.
56  ///
57  /// Calls ArResolver::BindContext on the given \p assetResolver
58  /// and saves the bindingData populated by that function.
59  AR_API
61  ArResolver* assetResolver,
62  const ArResolverContext& context);
63 
64  /// Unbinds the context specified in the constructor of this
65  /// object from the asset resolver.
66  ///
67  /// Calls ArResolver::UnbindContext on the asset resolver that was
68  /// bound to originally, passing the saved bindingData to that function.
69  AR_API
71 
72 private:
73  ArResolver* _resolver;
74  ArResolverContext _context;
75  VtValue _bindingData;
76 };
77 
79 
80 #endif // PXR_USD_AR_RESOLVER_CONTEXT_BINDER_H
#define AR_API
Definition: api.h:40
AR_API ~ArResolverContextBinder()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
AR_API ArResolverContextBinder(const ArResolverContext &context)
Definition: value.h:174