adapterRegistry.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H
#define PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H


#include "pxr/pxr.h"
#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/base/tf/singleton.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

#include <unordered_map>

PXR_NAMESPACE_OPEN_SCOPE


class UsdImagingPrimAdapter;
using UsdImagingPrimAdapterSharedPtr = std::shared_ptr<UsdImagingPrimAdapter>;

class UsdImagingAPISchemaAdapter;
using UsdImagingAPISchemaAdapterSharedPtr =
    std::shared_ptr<UsdImagingAPISchemaAdapter>;

#define USD_IMAGING_ADAPTER_KEY_TOKENS          \
    ((instanceAdapterKey, "__instanceAdapter")) \
    ((drawModeAdapterKey, "__drawModeAdapter"))       \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingAdapterKeyTokens,
                         USDIMAGING_API,
                         USD_IMAGING_ADAPTER_KEY_TOKENS);

class UsdImagingAdapterRegistry : public TfSingleton<UsdImagingAdapterRegistry> 
{
    friend class TfSingleton<UsdImagingAdapterRegistry>;
    UsdImagingAdapterRegistry();

    typedef std::unordered_map<TfToken,TfType,TfToken::HashFunctor> _TypeMap;
    _TypeMap _typeMap;
    TfTokenVector _adapterKeys;
    _TypeMap _apiSchemaTypeMap;
    TfTokenVector _apiSchemaAdapterKeys;

    typedef std::vector<TfType> _TypeVector;
    _TypeVector _keylessApiSchemaAdapterTypes;

    template <typename T, typename factoryT>
    std::shared_ptr<T> _ConstructAdapter(
        TfToken const& adapterKey, const _TypeMap &tm);

    template <typename T, typename factoryT>
    std::shared_ptr<T> _ConstructAdapter(
        TfToken const& adapterKey, const TfType &adapterType);

public:

    USDIMAGING_API
    static bool AreExternalPluginsEnabled();

    USDIMAGING_API
    static UsdImagingAdapterRegistry& GetInstance() {
        return TfSingleton<UsdImagingAdapterRegistry>::GetInstance();
    }

    USDIMAGING_API
    bool HasAdapter(TfToken const& adapterKey);

    USDIMAGING_API
    UsdImagingPrimAdapterSharedPtr ConstructAdapter(TfToken const& adapterKey);

    USDIMAGING_API
    const TfTokenVector& GetAdapterKeys();

    USDIMAGING_API
    bool HasAPISchemaAdapter(TfToken const& adapterKey);

    USDIMAGING_API
    UsdImagingAPISchemaAdapterSharedPtr ConstructAPISchemaAdapter(
        TfToken const& adapterKey);

    USDIMAGING_API
    const TfTokenVector& GetAPISchemaAdapterKeys();

    using ApiSchemaAdapters = std::vector<UsdImagingAPISchemaAdapterSharedPtr>;

    USDIMAGING_API
    ApiSchemaAdapters ConstructKeylessAPISchemaAdapters();

};

USDIMAGING_API_TEMPLATE_CLASS(TfSingleton<UsdImagingAdapterRegistry>);

PXR_NAMESPACE_CLOSE_SCOPE

#endif //PXR_USD_IMAGING_USD_IMAGING_ADAPTER_REGISTRY_H