assetPath.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_SDF_ASSET_PATH_H
#define PXR_USD_SDF_ASSET_PATH_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/base/tf/hash.h"
#include "pxr/base/vt/traits.h"
#include "pxr/usd/sdf/declareHandles.h"
 
#include <iosfwd>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfAssetPath;
class VtDictionary;
class VtValue;
template<typename T> class TfSpan;
SDF_DECLARE_HANDLES(SdfLayer);
 
class SdfAssetPathParams {
public:
    SdfAssetPathParams& Authored(const std::string &authoredPath_) {
        authoredPath = authoredPath_;
        return *this;
    }
 
    SdfAssetPathParams& Evaluated(const std::string &evaluatedPath_) {
        evaluatedPath = evaluatedPath_;
        return *this;
    }
 
    SdfAssetPathParams& Resolved(const std::string &resolvedPath_) {
        resolvedPath = resolvedPath_;
        return *this;
    }
 
private:
    friend class SdfAssetPath;
 
    std::string authoredPath;
    std::string evaluatedPath;
    std::string resolvedPath;
};
 
class SdfAssetPath
{
public:
 
    SDF_API SdfAssetPath();
 
    SDF_API explicit SdfAssetPath(const std::string &authoredPath);
 
    SDF_API
    SdfAssetPath(const std::string &authoredPath, 
                 const std::string &resolvedPath);
 
    SDF_API
    SdfAssetPath(const SdfAssetPathParams &params);
 
 
 
    bool operator==(const SdfAssetPath &rhs) const {
        return _authoredPath == rhs._authoredPath &&
               _evaluatedPath == rhs._evaluatedPath &&
               _resolvedPath == rhs._resolvedPath;
    }
 
    bool operator!=(const SdfAssetPath& rhs) const {
        return !(*this == rhs);
    }
 
    SDF_API bool operator<(const SdfAssetPath &rhs) const;
 
    bool operator<=(const SdfAssetPath& rhs) const {
        return !(rhs < *this);
    }
 
    bool operator>(const SdfAssetPath& rhs) const {
        return rhs < *this;
    }
 
    bool operator>=(const SdfAssetPath& rhs) const {
        return !(*this < rhs);
    }
 
    size_t GetHash() const {
        return TfHash::Combine(_authoredPath, _evaluatedPath, _resolvedPath);
    }
 
    struct Hash
    {
        size_t operator()(const SdfAssetPath &ap) const {
            return ap.GetHash();
        }
    };
 
    friend size_t hash_value(const SdfAssetPath &ap) { return ap.GetHash(); }
 
 
 
    const std::string &GetAuthoredPath() const & {
        return _authoredPath;
    }
 
    std::string GetAuthoredPath() const && {
        return std::move(_authoredPath);
    }
 
    const std::string &GetEvaluatedPath() const & {
        return _evaluatedPath;
    }
 
    std::string GetEvaluatedPath() const && {
        return std::move(_evaluatedPath);
    }
 
    const std::string &GetAssetPath() const & {
        return _evaluatedPath.empty() ? _authoredPath : _evaluatedPath;
    }
 
    std::string GetAssetPath() const && {
        return std::move(
                _evaluatedPath.empty() ? _authoredPath : _evaluatedPath);
    }
 
    const std::string &GetResolvedPath() const & {
        return _resolvedPath;
    }
 
    std::string GetResolvedPath() const && {
        return std::move(_resolvedPath);
    }
 
 
 
    void SetAuthoredPath(const std::string &authoredPath) {
        _authoredPath = authoredPath;
    }
 
    void SetEvaluatedPath(const std::string &evaluatedPath) {
        _evaluatedPath = evaluatedPath;
    }
 
    void SetResolvedPath(const std::string &resolvedPath) {
        _resolvedPath = resolvedPath;
    }
 
 
private:
    friend inline void swap(SdfAssetPath &lhs, SdfAssetPath &rhs) {
        lhs._authoredPath.swap(rhs._authoredPath);
        lhs._evaluatedPath.swap(rhs._evaluatedPath);
        lhs._resolvedPath.swap(rhs._resolvedPath);
    }
 
    std::string _authoredPath;
    std::string _evaluatedPath;
    std::string _resolvedPath;
};
 
// SdfAssetPath supports value transforms.
VT_VALUE_TYPE_CAN_TRANSFORM(SdfAssetPath);
 
 
SDF_API std::ostream& operator<<(std::ostream& out, const SdfAssetPath& ap);
 
 
SDF_API
void SdfAnchorAssetPaths(const SdfLayerHandle &anchor,
                    const VtDictionary &exprVars,
                    TfSpan<SdfAssetPath> assetPaths,
                    std::vector<std::string> *errors);
 
SDF_API
void SdfResolveAssetPaths(const SdfLayerHandle &anchor,
                        const VtDictionary &exprVars,
                        TfSpan<SdfAssetPath> assetPaths,
                        std::vector<std::string> *errors);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_ASSET_PATH_H