HDK
 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 PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H
25 #define PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H
26 
27 /// \file usdImaging/adapterRegistry.h
28 
29 #include "pxr/pxr.h"
31 #include "pxr/base/tf/singleton.h"
33 #include "pxr/base/tf/token.h"
34 #include "pxr/base/tf/type.h"
35 
36 #include <unordered_map>
37 
39 
40 
42 using UsdImagingPrimAdapterSharedPtr = std::shared_ptr<UsdImagingPrimAdapter>;
43 
44 #define USD_IMAGING_ADAPTER_KEY_TOKENS \
45  ((instanceAdapterKey, "__instanceAdapter")) \
46  ((drawModeAdapterKey, "__drawModeAdapter")) \
47 
48 TF_DECLARE_PUBLIC_TOKENS(UsdImagingAdapterKeyTokens,
51 
52 /// \class UsdImagingAdapterRegistry
53 ///
54 /// Registry of PrimAdapter plug-ins.
55 ///
56 class UsdImagingAdapterRegistry : public TfSingleton<UsdImagingAdapterRegistry>
57 {
60 
61  typedef std::unordered_map<TfToken,TfType,TfToken::HashFunctor> _TypeMap;
62  _TypeMap _typeMap;
63 
64 public:
65 
66  /// Returns true if external plugins are enabled.
67  /// Internal plugins have isInternal=1 set in their metadata. This flag is
68  /// only intended to be set for critical imaging plugins (mesh, cube,
69  /// sphere, curve, etc). This allows users to disable plugins that are
70  /// crashing or executing slowly.
71  ///
72  /// Driven by by the USDIMAGING_ENABLE_PLUGINS environment variable.
74  static bool AreExternalPluginsEnabled();
75 
79  }
80 
81  /// Returns true if an adapter has been registered to handle the given
82  /// \p adapterKey.
84  bool HasAdapter(TfToken const& adapterKey);
85 
86  /// Returns a new instance of the UsdImagingPrimAdapter that has been
87  /// registered to handle the given \p adapterKey. This key is either
88  /// a prim typename or a key specified in UsdImagingAdapterKeyTokens.
89  /// Returns NULL if no adapter was registered for this key.
92 };
93 
95 
97 
98 #endif //PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H
static T & GetInstance()
Definition: singleton.h:137
#define USDIMAGING_API
Definition: api.h:40
USDIMAGING_API bool HasAdapter(TfToken const &adapterKey)
#define USD_IMAGING_ADAPTER_KEY_TOKENS
USDIMAGING_API_TEMPLATE_CLASS(TfSingleton< UsdImagingAdapterRegistry >)
Definition: token.h:87
static USDIMAGING_API bool AreExternalPluginsEnabled()
USDIMAGING_API UsdImagingPrimAdapterSharedPtr ConstructAdapter(TfToken const &adapterKey)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< UsdImagingPrimAdapter > UsdImagingPrimAdapterSharedPtr
static USDIMAGING_API UsdImagingAdapterRegistry & GetInstance()
TF_DECLARE_PUBLIC_TOKENS(UsdImagingAdapterKeyTokens, USDIMAGING_API, USD_IMAGING_ADAPTER_KEY_TOKENS)