All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
adapterRegistry.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 USD_ADAPTER_REGISTRY_H
25 #define USD_ADAPTER_REGISTRY_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/base/tf/singleton.h"
32 #include "pxr/base/tf/staticTokens.h"
33 #include "pxr/base/tf/token.h"
34 
35 #include <boost/shared_ptr.hpp>
36 #include <boost/unordered_map.hpp>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 
41 class TfType;
43 typedef boost::shared_ptr<UsdImagingPrimAdapter> UsdImagingPrimAdapterSharedPtr;
44 
45 #define USD_IMAGING_ADAPTER_KEY_TOKENS \
46  ((instanceAdapterKey, "__instanceAdapter")) \
47  ((drawModeAdapterKey, "__drawModeAdapter")) \
48 
49 TF_DECLARE_PUBLIC_TOKENS(UsdImagingAdapterKeyTokens,
50  USDIMAGING_API,
51  USD_IMAGING_ADAPTER_KEY_TOKENS);
52 
57 class UsdImagingAdapterRegistry : public TfSingleton<UsdImagingAdapterRegistry>
58 {
59  friend class TfSingleton<UsdImagingAdapterRegistry>;
60  UsdImagingAdapterRegistry();
61 
62  typedef boost::unordered_map<TfToken,TfType,TfToken::HashFunctor> _TypeMap;
63  _TypeMap _typeMap;
64 
65 public:
66 
74  USDIMAGING_API
75  static bool AreExternalPluginsEnabled();
76 
77  USDIMAGING_API
78  static UsdImagingAdapterRegistry& GetInstance() {
80  }
81 
84  USDIMAGING_API
85  bool HasAdapter(TfToken const& adapterKey);
86 
91  USDIMAGING_API
92  UsdImagingPrimAdapterSharedPtr ConstructAdapter(TfToken const& adapterKey);
93 };
94 
95 USDIMAGING_API_TEMPLATE_CLASS(TfSingleton<UsdImagingAdapterRegistry>);
96 
97 PXR_NAMESPACE_CLOSE_SCOPE
98 
99 #endif //USD_ADAPTER_REGISTRY_H
Manage a single instance of an object (see.
Definition: singleton.h:122
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
USDIMAGING_API bool HasAdapter(TfToken const &adapterKey)
Returns true if an adapter has been registered to handle the given adapterKey.
Base class for all PrimAdapters.
Definition: primAdapter.h:67
USDIMAGING_API UsdImagingPrimAdapterSharedPtr ConstructAdapter(TfToken const &adapterKey)
Returns a new instance of the UsdImagingPrimAdapter that has been registered to handle the given adap...
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
static T & GetInstance()
Return a reference to an object of type T, creating it if necessary.
Definition: singleton.h:137
Registry of PrimAdapter plug-ins.
TfType represents a dynamic runtime type.
Definition: type.h:70
static USDIMAGING_API bool AreExternalPluginsEnabled()
Returns true if external plugins are enabled.