24#ifndef PXR_USD_SDF_LIST_OP_H
25#define PXR_USD_SDF_LIST_OP_H
28#include "pxr/usd/sdf/api.h"
40PXR_NAMESPACE_OPEN_SCOPE
47 SdfListOpTypeExplicit,
51 SdfListOpTypePrepended,
61struct Sdf_ListOpTraits
63 typedef std::less<T> ItemComparator;
77 typedef std::vector<ItemType> ItemVector;
78 typedef ItemType value_type;
79 typedef ItemVector value_vector_type;
84 const ItemVector& explicitItems = ItemVector());
90 const ItemVector& prependedItems = ItemVector(),
91 const ItemVector& appendedItems = ItemVector(),
92 const ItemVector& deletedItems = ItemVector());
107 if (_addedItems.size() != 0 ||
108 _prependedItems.size() != 0 ||
109 _appendedItems.size() != 0 ||
110 _deletedItems.size() != 0) {
113 return _orderedItems.size() != 0;
128 return _explicitItems;
140 return _prependedItems;
146 return _appendedItems;
152 return _deletedItems;
158 return _orderedItems;
162 SDF_API
const ItemVector&
GetItems(SdfListOpType type)
const;
172 SDF_API
void SetExplicitItems(
const ItemVector &items);
173 SDF_API
void SetAddedItems(
const ItemVector &items);
174 SDF_API
void SetPrependedItems(
const ItemVector &items);
175 SDF_API
void SetAppendedItems(
const ItemVector &items);
176 SDF_API
void SetDeletedItems(
const ItemVector &items);
177 SDF_API
void SetOrderedItems(
const ItemVector &items);
180 SDF_API
void SetItems(
const ItemVector &items, SdfListOpType type);
189 typedef std::function<
190 std::optional<ItemType>(SdfListOpType,
const ItemType&)
213 std::optional<SdfListOp<T>>
217 typedef std::function<
218 std::optional<ItemType>(
const ItemType&)
233 bool removeDuplicates =
false);
240 const ItemVector& newItems);
247 friend inline size_t hash_value(
const SdfListOp &op) {
260 return _isExplicit == rhs._isExplicit &&
261 _explicitItems == rhs._explicitItems &&
262 _addedItems == rhs._addedItems &&
263 _prependedItems == rhs._prependedItems &&
264 _appendedItems == rhs._appendedItems &&
265 _deletedItems == rhs._deletedItems &&
266 _orderedItems == rhs._orderedItems;
270 return !(*
this == rhs);
274 void _SetExplicit(
bool isExplicit);
276 typedef typename Sdf_ListOpTraits<T>::ItemComparator _ItemComparator;
277 typedef std::list<ItemType> _ApplyList;
278 typedef std::map<ItemType, typename _ApplyList::iterator, _ItemComparator>
282 _ApplyList* result, _ApplyMap* search)
const;
284 _ApplyList* result, _ApplyMap* search)
const;
286 _ApplyList* result, _ApplyMap* search)
const;
288 _ApplyList* result, _ApplyMap* search)
const;
290 _ApplyList* result, _ApplyMap* search)
const;
294 ItemVector _explicitItems;
295 ItemVector _addedItems;
296 ItemVector _prependedItems;
297 ItemVector _appendedItems;
298 ItemVector _deletedItems;
299 ItemVector _orderedItems;
311template <
class ItemType>
313void SdfApplyListOrdering(std::vector<ItemType>* v,
314 const std::vector<ItemType>& order);
323typedef class SdfListOp<int> SdfIntListOp;
324typedef class SdfListOp<unsigned int> SdfUIntListOp;
325typedef class SdfListOp<int64_t> SdfInt64ListOp;
326typedef class SdfListOp<uint64_t> SdfUInt64ListOp;
329typedef class
SdfListOp<class SdfPath> SdfPathListOp;
330typedef class
SdfListOp<class SdfReference> SdfReferenceListOp;
331typedef class
SdfListOp<class SdfPayload> SdfPayloadListOp;
332typedef class
SdfListOp<class SdfUnregisteredValue> SdfUnregisteredValueListOp;
334PXR_NAMESPACE_CLOSE_SCOPE
Value type representing a list-edit operation.
SDF_API bool HasItem(const T &item) const
Returns true if the given item is in any of the item lists.
static SDF_API SdfListOp CreateExplicit(const ItemVector &explicitItems=ItemVector())
Create a ListOp in explicit mode with the given explicitItems.
SDF_API std::optional< SdfListOp< T > > ApplyOperations(const SdfListOp< T > &inner) const
Applies edit operations to the given ListOp.
std::function< std::optional< ItemType >(const ItemType &) > ModifyCallback
Callback type for ModifyOperations.
const ItemVector & GetOrderedItems() const
Returns the ordered items.
static SDF_API SdfListOp Create(const ItemVector &prependedItems=ItemVector(), const ItemVector &appendedItems=ItemVector(), const ItemVector &deletedItems=ItemVector())
Create a ListOp in non-explicit mode with the given prependedItems, appendedItems,...
const ItemVector & GetDeletedItems() const
Returns the deleted items.
SDF_API const ItemVector & GetItems(SdfListOpType type) const
Return the item vector identified by type.
bool IsExplicit() const
Returns true if the list is explicit.
SDF_API void Clear()
Removes all items and changes the list to be non-explicit.
const ItemVector & GetPrependedItems() const
Returns the explicit items.
const ItemVector & GetExplicitItems() const
Returns the explicit items.
SDF_API bool ReplaceOperations(const SdfListOpType op, size_t index, size_t n, const ItemVector &newItems)
Replaces the items in the specified operation vector in the range (index, index + n] with the given n...
SDF_API SdfListOp()
Create an empty ListOp in non-explicit mode.
SDF_API void SetItems(const ItemVector &items, SdfListOpType type)
Sets the item vector for the given operation type.
SDF_API void ApplyOperations(ItemVector *vec, const ApplyCallback &cb=ApplyCallback()) const
Applies edit operations to the given ItemVector.
SDF_API void ClearAndMakeExplicit()
Removes all items and changes the list to be explicit.
SDF_API void ComposeOperations(const SdfListOp< T > &stronger, SdfListOpType op)
Composes a stronger SdfListOp's opinions for a given operation list over this one.
bool HasKeys() const
Returns true if the editor has an explicit list (even if it's empty) or it has any added,...
const ItemVector & GetAppendedItems() const
Returns the explicit items.
SDF_API ItemVector GetAppliedItems() const
Returns the effective list of items represented by the operations in this list op.
std::function< std::optional< ItemType >(SdfListOpType, const ItemType &) > ApplyCallback
Callback type for ApplyOperations.
const ItemVector & GetAddedItems() const
Returns the explicit items.
SDF_API bool ModifyOperations(const ModifyCallback &callback, bool removeDuplicates=false)
Modifies operations specified in this object.
static size_t Combine(Args &&... args)
Produce a hash code by combining the hash codes of several objects.
Token for efficient comparison, assignment, and hashing of known strings.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...