reference.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_SDF_REFERENCE_H
#define PXR_USD_SDF_REFERENCE_H


#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/assetPath.h"
#include "pxr/usd/sdf/layerOffset.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/tf/hash.h"
#include "pxr/base/vt/dictionary.h"
#include "pxr/base/vt/value.h"

#include <boost/operators.hpp>

#include <iosfwd>
#include <string>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class SdfReference;

typedef std::vector<SdfReference> SdfReferenceVector;

class SdfReference : boost::totally_ordered<SdfReference> {
public:
    SDF_API SdfReference(
        const std::string &assetPath = std::string(),
        const SdfPath &primPath = SdfPath(),
        const SdfLayerOffset &layerOffset = SdfLayerOffset(),
        const VtDictionary &customData = VtDictionary());

    const std::string &GetAssetPath() const {
        return _assetPath;
    }

    void SetAssetPath(const std::string &assetPath) {
        // Go through SdfAssetPath() to raise an error if \p assetPath contains
        // illegal characters (i.e. control characters).
        _assetPath = SdfAssetPath(assetPath).GetAssetPath();
    }

    const SdfPath &GetPrimPath() const {
        return _primPath;
    }

    void SetPrimPath(const SdfPath &primPath) {
        _primPath = primPath;
    }

    const SdfLayerOffset &GetLayerOffset() const {
        return _layerOffset;
    }

    void SetLayerOffset(const SdfLayerOffset &layerOffset) {
        _layerOffset = layerOffset;
    }

    const VtDictionary &GetCustomData() const {
        return _customData;
    }

    void SetCustomData(const VtDictionary &customData) {
        _customData = customData;
    }

    SDF_API void SetCustomData(const std::string &name, const VtValue &value);

    void SwapCustomData(VtDictionary &customData) {
        _customData.swap(customData);
    }

    SDF_API bool IsInternal() const;

    friend inline size_t hash_value(const SdfReference &r) {
        return TfHash::Combine(
            r._assetPath,
            r._primPath,
            r._layerOffset,
            r._customData
        );
    }

    SDF_API bool operator==(const SdfReference &rhs) const;

    SDF_API bool operator<(const SdfReference &rhs) const;

    struct IdentityEqual {
        bool operator()(const SdfReference &lhs, const SdfReference &rhs) const {
            return lhs._assetPath == rhs._assetPath &&
                   lhs._primPath  == rhs._primPath;
        }
    };

    struct IdentityLessThan {
        bool operator()(const SdfReference &lhs, const SdfReference &rhs) const {
            return lhs._assetPath <  rhs._assetPath ||
                  (lhs._assetPath == rhs._assetPath &&
                   lhs._primPath  <  rhs._primPath);
        }
    };

private:
    // The asset path to the external layer.
    std::string _assetPath;

    // The path to the referenced prim in the external layer.
    SdfPath _primPath;

    // The layer offset to transform time.
    SdfLayerOffset _layerOffset;

    // The custom data associated with the reference.
    VtDictionary _customData;
};

SDF_API int SdfFindReferenceByIdentity(
    const SdfReferenceVector &references,
    const SdfReference &referenceId);

SDF_API std::ostream & operator<<( std::ostream &out,
                           const SdfReference &reference );

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_SDF_REFERENCE_H