packageResolver.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_AR_PACKAGE_RESOLVER_H
#define PXR_USD_AR_PACKAGE_RESOLVER_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/ar/api.h"
 
#include <memory>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class ArAsset;
class VtValue;
 
class ArPackageResolver
{
public:
    ArPackageResolver(const ArPackageResolver&) = delete;
    ArPackageResolver& operator=(const ArPackageResolver&) = delete;
 
    AR_API
    virtual ~ArPackageResolver();
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    AR_API
    virtual std::string Resolve(
        const std::string& resolvedPackagePath,
        const std::string& packagedPath) = 0;
    
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    AR_API
    virtual std::shared_ptr<ArAsset> OpenAsset(
        const std::string& resolvedPackagePath,
        const std::string& resolvedPackagedPath) = 0;
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    AR_API
    virtual void BeginCacheScope(
        VtValue* cacheScopeData) = 0;
 
    AR_API
    virtual void EndCacheScope(
        VtValue* cacheScopeData) = 0;
    
protected:
    AR_API
    ArPackageResolver();
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_AR_PACKAGE_RESOLVER_H