apiSchemaAdapter.h

Go to the documentation of this file.

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


#include "pxr/pxr.h"
#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/usdImaging/usdImaging/version.h"
#include "pxr/usdImaging/usdImaging/types.h"

#include "pxr/usd/usd/prim.h"

#include "pxr/imaging/hd/sceneIndex.h"

#include "pxr/base/tf/type.h"

#include <memory>


PXR_NAMESPACE_OPEN_SCOPE

class UsdImagingDataSourceStageGlobals;

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

class UsdImagingAPISchemaAdapter 
            : public std::enable_shared_from_this<UsdImagingAPISchemaAdapter>
{
public:

    USDIMAGING_API
    virtual ~UsdImagingAPISchemaAdapter();

    USDIMAGING_API
    virtual TfTokenVector GetImagingSubprims(
            UsdPrim const& prim,
            TfToken const& appliedInstanceName);

    USDIMAGING_API
    virtual TfToken GetImagingSubprimType(
            UsdPrim const& prim,
            TfToken const& subprim,
            TfToken const& appliedInstanceName);

    USDIMAGING_API
    virtual HdContainerDataSourceHandle GetImagingSubprimData(
            UsdPrim const& prim,
            TfToken const& subprim,
            TfToken const& appliedInstanceName,
            const UsdImagingDataSourceStageGlobals &stageGlobals);

    USDIMAGING_API
    virtual HdDataSourceLocatorSet InvalidateImagingSubprim(
            UsdPrim const& prim,
            TfToken const& subprim,
            TfToken const& appliedInstanceName,
            TfTokenVector const& properties,
            UsdImagingPropertyInvalidationType invalidationType);
};


class UsdImagingAPISchemaAdapterFactoryBase : public TfType::FactoryBase
{
public:
    virtual UsdImagingAPISchemaAdapterSharedPtr New() const = 0;
};

template <class T>
class UsdImagingAPISchemaAdapterFactory
    : public UsdImagingAPISchemaAdapterFactoryBase
{
public:
    virtual UsdImagingAPISchemaAdapterSharedPtr New() const
    {
        return std::make_shared<T>();
    }
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif