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

/// \file 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 <iosfwd>
#include <string>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class SdfReference;

typedef std::vector<SdfReference> SdfReferenceVector;

/// \class SdfReference
///
/// Represents a reference and all its meta data.
///
/// A reference is expressed on a prim in a given layer and it identifies a
/// prim in a layer stack.  All opinions in the namespace hierarchy
/// under the referenced prim will be composed with the opinions in the
/// namespace hierarchy under the referencing prim.
///
/// The asset path specifies the layer stack being referenced.  If this
/// asset path is non-empty, this reference is considered an 'external' 
/// reference to the layer stack rooted at the specified layer.  If this
/// is empty, this reference is considered an 'internal' reference to the
/// layer stack containing (but not necessarily rooted at) the layer where
/// the reference is authored.
///
/// The prim path specifies the prim in the referenced layer stack from
/// which opinions will be composed.  If this prim path is empty, it will
/// be considered a reference to the default prim specified in the root layer
/// of the referenced layer stack -- see SdfLayer::GetDefaultPrim.
///
/// The meta data for a reference is its layer offset and custom data.  The
/// layer offset is an affine transformation applied to all anim splines in
/// the referenced prim's namespace hierarchy, see SdfLayerOffset for details.
/// Custom data is for use by plugins or other non-tools supplied extensions
/// that need to be able to store data associated with references.
///
class SdfReference {
public:
    /// Creates a reference with all its meta data.  The default reference is an
    /// internal reference to the default prim.  See SdfAssetPath for what
    /// characters are valid in \p assetPath.  If \p assetPath contains invalid
    /// characters, issue an error and set this reference's asset path to the
    /// empty asset path.
    ///
    SDF_API SdfReference(
        const std::string &assetPath = std::string(),
        const SdfPath &primPath = SdfPath(),
        const SdfLayerOffset &layerOffset = SdfLayerOffset(),
        const VtDictionary &customData = VtDictionary());

    /// Returns the asset path to the root layer of the referenced layer
    /// stack.  This will be empty in the case of an internal reference.
    ///
    const std::string &GetAssetPath() const {
        return _assetPath;
    }

    /// Sets the asset path for the root layer of the referenced layer stack.
    /// This may be set to an empty string to specify an internal reference.
    /// See SdfAssetPath for what characters are valid in \p assetPath.  If \p
    /// assetPath contains invalid characters, issue an error and set this
    /// reference's asset path to the empty asset path.
    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();
    }

    /// Returns the path of the referenced prim.
    /// This will be empty if the referenced prim is the default prim specified
    /// in the referenced layer stack.
    ///
    const SdfPath &GetPrimPath() const {
        return _primPath;
    }

    /// Sets the path of the referenced prim.
    /// This may be set to an empty path to specify a reference to the default
    /// prim in the referenced layer stack.
    ///
    void SetPrimPath(const SdfPath &primPath) {
        _primPath = primPath;
    }

    /// Returns the layer offset associated with the reference.
    ///
    const SdfLayerOffset &GetLayerOffset() const {
        return _layerOffset;
    }

    /// Sets a new layer offset.
    ///
    void SetLayerOffset(const SdfLayerOffset &layerOffset) {
        _layerOffset = layerOffset;
    }

    /// Returns the custom data associated with the reference.
    ///
    const VtDictionary &GetCustomData() const {
        return _customData;
    }

    /// Sets the custom data associated with the reference.
    ///
    void SetCustomData(const VtDictionary &customData) {
        _customData = customData;
    }

    /// Sets a custom data entry for the reference.
    ///
    /// If \a value is empty, then this removes the given custom data entry.
    ///
    SDF_API void SetCustomData(const std::string &name, const VtValue &value);

    /// Swaps the custom data dictionary for this reference.
    void SwapCustomData(VtDictionary &customData) {
        _customData.swap(customData);
    }

    /// Returns \c true in the case of an internal reference.
    ///
    /// An internal reference is a reference with an empty asset path.
    ///
    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
        );
    }

    /// Returns whether this reference equals \a rhs.
    SDF_API bool operator==(const SdfReference &rhs) const;

    /// \sa SdfReference::operator==(const SdfReference&)
    bool operator!=(const SdfReference &rhs) const {
        return !(*this == rhs);
    }

    /// Returns whether this reference is less than \a rhs.  The meaning
    /// of less than is somewhat arbitrary.
    SDF_API bool operator<(const SdfReference &rhs) const;

    /// \sa SdfReference::operator<(const SdfReference&)
    bool operator>(const SdfReference &rhs) const {
        return rhs < *this;
    }

    /// \sa SdfReference::operator<(const SdfReference&)
    bool operator<=(const SdfReference &rhs) const {
        return !(rhs < *this);
    }

    /// \sa SdfReference::operator<(const SdfReference&)
    bool operator>=(const SdfReference &rhs) const {
        return !(*this < rhs);
    }

    /// Struct that defines equality of SdfReferences based on their
    /// identity (the asset path and prim path).
    ///
    struct IdentityEqual {
        bool operator()(const SdfReference &lhs, const SdfReference &rhs) const {
            return lhs._assetPath == rhs._assetPath &&
                   lhs._primPath  == rhs._primPath;
        }
    };

    /// Struct that defines a strict weak ordering of SdfReferences based on
    /// their identity (the asset path and prim path).
    ///
    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;
};

/// Convenience function to find the index of the reference in \a references
/// that has the same identity as the given reference \a referenceId.
///
/// A reference's identity is given by its asset path and prim path alone
/// (i.e. the layer offset and custom data is ignored).
///
/// If no reference with the same identity exists in \a reference, -1 is
/// returned.  If more than one reference with the same identity exist in
/// \a references the index of the first one is returned.
///
SDF_API int SdfFindReferenceByIdentity(
    const SdfReferenceVector &references,
    const SdfReference &referenceId);

/// Writes the string representation of \a SdfReference to \a out.
SDF_API std::ostream & operator<<( std::ostream &out,
                           const SdfReference &reference );

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_SDF_REFERENCE_H