7#ifndef PXR_USD_SDF_LIST_OP_H
8#define PXR_USD_SDF_LIST_OP_H
11#include "pxr/usd/sdf/api.h"
23PXR_NAMESPACE_OPEN_SCOPE
30 SdfListOpTypeExplicit,
34 SdfListOpTypePrepended,
44struct Sdf_ListOpTraits
46 typedef std::less<T> ItemComparator;
72 typedef std::vector<ItemType> ItemVector;
73 typedef ItemType value_type;
74 typedef ItemVector value_vector_type;
79 const ItemVector& explicitItems = ItemVector());
85 const ItemVector& prependedItems = ItemVector(),
86 const ItemVector& appendedItems = ItemVector(),
87 const ItemVector& deletedItems = ItemVector());
102 if (_addedItems.size() != 0 ||
103 _prependedItems.size() != 0 ||
104 _appendedItems.size() != 0 ||
105 _deletedItems.size() != 0) {
108 return _orderedItems.size() != 0;
123 return _explicitItems;
129 return _prependedItems;
135 return _appendedItems;
141 return _deletedItems;
145 SDF_API
const ItemVector&
GetItems(SdfListOpType type)
const;
173 SDF_API
void SetItems(
const ItemVector &items, SdfListOpType type);
182 typedef std::function<
183 std::optional<ItemType>(SdfListOpType,
const ItemType&)
206 std::optional<SdfListOp<T>>
210 typedef std::function<
211 std::optional<ItemType>(
const ItemType&)
231 bool unusedRemoveDuplicates);
238 const ItemVector& newItems);
256 return _orderedItems;
266 friend inline size_t hash_value(
const SdfListOp &op) {
279 return _isExplicit == rhs._isExplicit &&
280 _explicitItems == rhs._explicitItems &&
281 _addedItems == rhs._addedItems &&
282 _prependedItems == rhs._prependedItems &&
283 _appendedItems == rhs._appendedItems &&
284 _deletedItems == rhs._deletedItems &&
285 _orderedItems == rhs._orderedItems;
289 return !(*
this == rhs);
293 void _SetExplicit(
bool isExplicit);
295 typedef typename Sdf_ListOpTraits<T>::ItemComparator _ItemComparator;
296 typedef std::list<ItemType> _ApplyList;
297 typedef std::map<ItemType, typename _ApplyList::iterator, _ItemComparator>
301 _ApplyList* result, _ApplyMap* search)
const;
303 _ApplyList* result, _ApplyMap* search)
const;
305 _ApplyList* result, _ApplyMap* search)
const;
310 _ApplyList* result, _ApplyMap* search)
const;
315 _ApplyList* result, _ApplyMap* search)
const;
316 static void _ReorderKeysHelper(ItemVector order,
const ApplyCallback& cb,
317 _ApplyList *result, _ApplyMap *search);
318 template <
class ItemType>
319 friend void SdfApplyListOrdering(std::vector<ItemType> *v,
320 const std::vector<ItemType> &order);
324 ItemVector _explicitItems;
325 ItemVector _addedItems;
326 ItemVector _prependedItems;
327 ItemVector _appendedItems;
328 ItemVector _deletedItems;
329 ItemVector _orderedItems;
341template <
class ItemType>
343void SdfApplyListOrdering(std::vector<ItemType>* v,
344 const std::vector<ItemType>& order);
353typedef class SdfListOp<int> SdfIntListOp;
354typedef class SdfListOp<unsigned int> SdfUIntListOp;
355typedef class SdfListOp<int64_t> SdfInt64ListOp;
356typedef class SdfListOp<uint64_t> SdfUInt64ListOp;
359typedef class
SdfListOp<class SdfPath> SdfPathListOp;
360typedef class
SdfListOp<class SdfReference> SdfReferenceListOp;
361typedef class
SdfListOp<class SdfPayload> SdfPayloadListOp;
362typedef class
SdfListOp<class SdfUnregisteredValue> SdfUnregisteredValueListOp;
364PXR_NAMESPACE_CLOSE_SCOPE
SdfListOp is a value type representing an operation that edits a list.
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 void SetAppendedItems(const ItemVector &items)
Sets the appended items.
SDF_API std::optional< SdfListOp< T > > ApplyOperations(const SdfListOp< T > &inner) const
Applies edit operations to the given ListOp.
SDF_API bool ModifyOperations(const ModifyCallback &callback, bool unusedRemoveDuplicates)
SDF_API void SetOrderedItems(const ItemVector &items)
std::function< std::optional< ItemType >(const ItemType &) > ModifyCallback
Callback type for ModifyOperations.
SDF_API bool ModifyOperations(const ModifyCallback &callback)
Modifies operations specified in this object.
SDF_API void SetAddedItems(const ItemVector &items)
SDF_API void SetExplicitItems(const ItemVector &items)
Sets the explicit items.
SDF_API void SetPrependedItems(const ItemVector &items)
Sets the prepended items.
SDF_API void SetDeletedItems(const ItemVector &items)
Sets the deleted items.
const ItemVector & GetOrderedItems() const
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
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...