All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
definePackageResolver.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 AR_DEFINE_PACKAGE_RESOLVER_H
25 #define AR_DEFINE_PACKAGE_RESOLVER_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/ar/api.h"
32 #include "pxr/usd/ar/packageResolver.h"
33 
34 #include "pxr/base/tf/registryManager.h"
35 #include "pxr/base/tf/type.h"
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
49 #ifdef doxygen
50 #define AR_DEFINE_PACKAGE_RESOLVER(PackageResolverClass, BaseClass1, ...)
51 #else
52 
53 #define AR_DEFINE_PACKAGE_RESOLVER(...) \
54 TF_REGISTRY_FUNCTION(TfType) { \
55  Ar_DefinePackageResolver<__VA_ARGS__>(); \
56 }
57 
58 class Ar_PackageResolverFactoryBase
59  : public TfType::FactoryBase
60 {
61 public:
62  AR_API
63  virtual ArPackageResolver* New() const = 0;
64 };
65 
66 template <class T>
67 class Ar_PackageResolverFactory
68  : public Ar_PackageResolverFactoryBase
69 {
70 public:
71  virtual ArPackageResolver* New() const override
72  {
73  return new T;
74  }
75 };
76 
77 template <class PackageResolver, class ...Bases>
78 void Ar_DefinePackageResolver()
79 {
80  TfType::Define<PackageResolver, TfType::Bases<Bases...>>()
81  .template SetFactory<Ar_PackageResolverFactory<PackageResolver>>();
82 }
83 
84 #endif // doxygen
85 
86 PXR_NAMESPACE_CLOSE_SCOPE
87 
88 #endif // AR_DEFINE_PACKAGE_RESOLVER_H
Base class of all factory types.
Definition: type.h:79
A type-list of C++ base types.
Definition: type.h:106
Interface for resolving assets within package assets.
static TfType const & Define()
Define a TfType with the given C++ type T and C++ base types B.
Definition: type_Impl.h:78