defaultResolver.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_AR_DEFAULT_RESOLVER_H
#define PXR_USD_AR_DEFAULT_RESOLVER_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/ar/api.h"
#include "pxr/usd/ar/defaultResolverContext.h"
#include "pxr/usd/ar/resolvedPath.h"
#include "pxr/usd/ar/resolver.h"
 
#include <memory>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class ArDefaultResolver
    : public ArResolver
{
public:
    AR_API 
    ArDefaultResolver() = default;
 
    AR_API 
    virtual ~ArDefaultResolver() = default;
 
    AR_API
    static void SetDefaultSearchPath(
        const std::vector<std::string>& searchPath);
 
protected:
    AR_API
    std::string _CreateIdentifier(
        const std::string& assetPath,
        const ArResolvedPath& anchorAssetPath) const override;
 
    AR_API
    std::string _CreateIdentifierForNewAsset(
        const std::string& assetPath,
        const ArResolvedPath& anchorAssetPath) const override;
 
    AR_API
    ArResolvedPath _Resolve(
        const std::string& assetPath) const override;
 
    AR_API
    ArResolvedPath _ResolveForNewAsset(
        const std::string& assetPath) const override;
 
    AR_API
    ArResolverContext _CreateDefaultContext() const override;
 
    AR_API
    ArResolverContext _CreateDefaultContextForAsset(
        const std::string& assetPath) const override;
 
    AR_API
    ArResolverContext _CreateContextFromString(
        const std::string& contextStr) const override;
 
    AR_API
    bool _IsContextDependentPath(
        const std::string& assetPath) const override;
 
    AR_API
    ArTimestamp _GetModificationTimestamp(
        const std::string& path,
        const ArResolvedPath& resolvedPath) const override;
 
    AR_API
    std::shared_ptr<ArAsset> _OpenAsset(
        const ArResolvedPath& resolvedPath) const override;
 
    AR_API
    std::shared_ptr<ArWritableAsset> _OpenAssetForWrite(
        const ArResolvedPath& resolvedPath,
        WriteMode writeMode) const override;
 
private:
    const ArDefaultResolverContext* _GetCurrentContextPtr() const;
 
    ArResolverContext _defaultContext;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_AR_DEFAULT_RESOLVER_H