HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stageCache.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_USD_UTILS_STAGE_CACHE_H
25 #define PXR_USD_USD_UTILS_STAGE_CACHE_H
26 
27 /// \file usdUtils/stageCache.h
28 /// A simple interface for handling a singleton usd stage cache.
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/usdUtils/api.h"
32 #include "pxr/usd/usd/stageCache.h"
33 
35 #include "pxr/base/tf/token.h"
36 
37 #include <string>
38 #include <vector>
39 
41 
42 
44 
45 /// \class UsdUtilsStageCache
46 ///
47 /// The UsdUtilsStageCache class provides a simple interface for handling a
48 /// singleton usd stage cache for use by all USD clients. This way code from
49 /// any location can make use of the same cache to maximize stage reuse.
50 ///
52 public:
53 
54  /// Returns the singleton stage cache.
56  static UsdStageCache &Get();
57 
58  /// Given variant selections as a vector of pairs (vector in case order
59  /// matters to the client), constructs a session layer with overs on the
60  /// given root modelName with the variant selections, or returns a cached
61  /// session layer with those opinions.
64  const TfToken& modelName,
65  const std::vector<std::pair<std::string, std::string> > &variantSelections);
66 };
67 
68 
70 
71 #endif /* PXR_USD_USD_UTILS_STAGE_CACHE_H */
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_AND_REF_PTRS(SdfLayer)
Definition: layer.h:96
static USDUTILS_API SdfLayerRefPtr GetSessionLayerForVariantSelections(const TfToken &modelName, const std::vector< std::pair< std::string, std::string > > &variantSelections)
Definition: token.h:87
static USDUTILS_API UsdStageCache & Get()
Returns the singleton stage cache.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define USDUTILS_API
Definition: api.h:40