editTarget.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_USD_EDIT_TARGET_H
#define PXR_USD_USD_EDIT_TARGET_H
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/pcp/layerStackIdentifier.h"
#include "pxr/usd/pcp/mapFunction.h"
#include "pxr/usd/pcp/node.h"
#include "pxr/usd/sdf/layer.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/primSpec.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
TF_DECLARE_WEAK_PTRS(UsdStage);
 
class UsdEditTarget
{
public:
 
    USD_API
    UsdEditTarget();
 
    USD_API
    UsdEditTarget(const SdfLayerHandle &layer,
                  SdfLayerOffset offset = SdfLayerOffset());
 
    USD_API
    UsdEditTarget(const SdfLayerRefPtr &layer,
                  SdfLayerOffset offset = SdfLayerOffset());
 
    USD_API
    UsdEditTarget(const SdfLayerHandle &layer, const PcpNodeRef &node);
 
    USD_API
    UsdEditTarget(const SdfLayerRefPtr &layer, const PcpNodeRef &node);
 
    USD_API
    static UsdEditTarget
    ForLocalDirectVariant(const SdfLayerHandle &layer,
                          const SdfPath &varSelPath);
 
    USD_API
    bool operator==(const UsdEditTarget &other) const;
 
    bool operator!=(const UsdEditTarget &other) const {
        return !(*this == other);
    }
 
    bool IsNull() const { return *this == UsdEditTarget(); }
 
    bool IsValid() const { return _layer; }
 
    const SdfLayerHandle &GetLayer() const & { return _layer; }
    SdfLayerHandle GetLayer() && { return std::move(_layer); }
 
    USD_API
    SdfPath MapToSpecPath(const SdfPath &scenePath) const;
 
    USD_API
    SdfPrimSpecHandle
    GetPrimSpecForScenePath(const SdfPath &scenePath) const;
 
    USD_API
    SdfPropertySpecHandle
    GetPropertySpecForScenePath(const SdfPath &scenePath) const;
 
    USD_API
    SdfSpecHandle
    GetSpecForScenePath(const SdfPath &scenePath) const;
 
    const PcpMapFunction &
    GetMapFunction() const { return _mapping; }
 
    USD_API
    UsdEditTarget ComposeOver(const UsdEditTarget &weaker) const;
 
private:
 
    UsdEditTarget(const SdfLayerHandle &layer,
                  const PcpMapFunction &mapping);
 
    SdfLayerHandle _layer;
    PcpMapFunction _mapping;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_EDIT_TARGET_H