7#ifndef PXR_USD_USD_PAYLOADS_H
8#define PXR_USD_USD_PAYLOADS_H
11#include "pxr/usd/usd/api.h"
16#include "pxr/usd/sdf/path.h"
19PXR_NAMESPACE_OPEN_SCOPE
94 explicit operator bool() {
return bool(_prim); }
100PXR_NAMESPACE_CLOSE_SCOPE
Represents a time offset and scale between layers.
A path value used to locate objects in layers or scenegraphs.
Represents a payload and all its meta data.
UsdPayloads provides an interface to authoring and introspecting payloads.
USD_API bool AddPayload(const std::string &identifier, const SdfLayerOffset &layerOffset=SdfLayerOffset(), UsdListPosition position=UsdListPositionBackOfPrependList)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetPayloads(const SdfPayloadVector &items)
Explicitly set the payloads, potentially blocking weaker opinions that add or remove items.
USD_API bool ClearPayloads()
Removes the authored payload listOp edits at the current EditTarget.
USD_API bool AddPayload(const SdfPayload &payload, UsdListPosition position=UsdListPositionBackOfPrependList)
Adds a payload to the payload listOp at the current EditTarget, in the position specified by position...
USD_API bool AddPayload(const std::string &identifier, const SdfPath &primPath, const SdfLayerOffset &layerOffset=SdfLayerOffset(), UsdListPosition position=UsdListPositionBackOfPrependList)
This is an overloaded member function, provided for convenience. It differs from the above function o...
const UsdPrim & GetPrim() const
Return the prim this object is bound to.
USD_API bool RemovePayload(const SdfPayload &ref)
Removes the specified payload from the payloads listOp at the current EditTarget.
USD_API bool AddInternalPayload(const SdfPath &primPath, const SdfLayerOffset &layerOffset=SdfLayerOffset(), UsdListPosition position=UsdListPositionBackOfPrependList)
Add an internal payload to the specified prim.
UsdPrim GetPrim()
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
UsdListPosition
Specifies a position to add items to lists.
@ UsdListPositionBackOfPrependList
The position at the back of the prepend list.