payloads.h

//
// Copyright 2019 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_USD_PAYLOADS_H
#define PXR_USD_USD_PAYLOADS_H
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/prim.h"
 
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/payload.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdPayloads {
    friend class UsdPrim;
 
    explicit UsdPayloads(const UsdPrim& prim) : _prim(prim) {}
 
public:
    USD_API
    bool AddPayload(const SdfPayload& payload,
                    UsdListPosition position=UsdListPositionBackOfPrependList);
 
    USD_API
    bool AddPayload(const std::string &identifier,
                    const SdfPath &primPath,
                    const SdfLayerOffset &layerOffset = SdfLayerOffset(),
                    UsdListPosition position=UsdListPositionBackOfPrependList);
 
    USD_API
    bool AddPayload(const std::string &identifier,
                    const SdfLayerOffset &layerOffset = SdfLayerOffset(),
                    UsdListPosition position=UsdListPositionBackOfPrependList);
 
    USD_API
    bool AddInternalPayload(const SdfPath &primPath,
                    const SdfLayerOffset &layerOffset = SdfLayerOffset(),
                    UsdListPosition position=UsdListPositionBackOfPrependList);
 
    USD_API
    bool RemovePayload(const SdfPayload& ref);
 
    USD_API
    bool ClearPayloads();
 
    USD_API
    bool SetPayloads(const SdfPayloadVector& items);
 
    const UsdPrim &GetPrim() const { return _prim; }
 
    UsdPrim GetPrim() { return _prim; }
 
    explicit operator bool() { return bool(_prim); }
 
private:
    UsdPrim _prim;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_PAYLOADS_H