All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
payloads.h
1 //
2 // Copyright 2019 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USD_PAYLOADS_H
25 #define USD_PAYLOADS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/api.h"
29 #include "pxr/usd/usd/common.h"
30 #include "pxr/usd/usd/prim.h"
31 
32 #include "pxr/usd/sdf/declareHandles.h"
33 #include "pxr/usd/sdf/path.h"
34 #include "pxr/usd/sdf/payload.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
43 class UsdPayloads {
44  friend class UsdPrim;
45 
46  explicit UsdPayloads(const UsdPrim& prim) : _prim(prim) {}
47 
48 public:
55  USD_API
56  bool AddPayload(const SdfPayload& payload,
58 
60  USD_API
61  bool AddPayload(const std::string &identifier,
62  const SdfPath &primPath,
63  const SdfLayerOffset &layerOffset = SdfLayerOffset(),
65 
68  USD_API
69  bool AddPayload(const std::string &identifier,
70  const SdfLayerOffset &layerOffset = SdfLayerOffset(),
72 
75  USD_API
76  bool AddInternalPayload(const SdfPath &primPath,
77  const SdfLayerOffset &layerOffset = SdfLayerOffset(),
79 
85  USD_API
86  bool RemovePayload(const SdfPayload& ref);
87 
93  USD_API
94  bool ClearPayloads();
95 
102  USD_API
103  bool SetPayloads(const SdfPayloadVector& items);
104 
106  const UsdPrim &GetPrim() const { return _prim; }
107 
109  UsdPrim GetPrim() { return _prim; }
110 
111  explicit operator bool() { return bool(_prim); }
112 
113 private:
114  UsdPrim _prim;
115 };
116 
117 PXR_NAMESPACE_CLOSE_SCOPE
118 
119 #endif // USD_PAYLOADS_H
USD_API bool SetPayloads(const SdfPayloadVector &items)
Explicitly set the payloads, potentially blocking weaker opinions that add or remove items...
UsdListPosition
Specifies a position to add items to lists.
Definition: common.h:110
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 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.
Represents a payload and all its meta data.
Definition: payload.h:59
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
UsdPayloads provides an interface to authoring and introspecting payloads.
Definition: payloads.h:43
USD_API bool ClearPayloads()
Removes the authored payload listOp edits at the current EditTarget.
UsdPrim GetPrim()
Definition: payloads.h:109
The position at the back of the prepend list.
Definition: common.h:120
Represents a time offset and scale between layers.
Definition: layerOffset.h:61
const UsdPrim & GetPrim() const
Return the prim this object is bound to.
Definition: payloads.h:106