|
Represents a set of list editing operations. More...
#include <listEditorProxy.h>
Public Types | |
typedef _TypePolicy | TypePolicy |
typedef SdfListEditorProxy< TypePolicy > | This |
typedef SdfListProxy< TypePolicy > | ListProxy |
typedef TypePolicy::value_type | value_type |
typedef std::vector< value_type > | value_vector_type |
typedef std::function< std::optional< value_type >(SdfListOpType, const value_type &)> | ApplyCallback |
typedef std::function< std::optional< value_type >(const value_type &)> | ModifyCallback |
Public Member Functions | |
SdfListEditorProxy () | |
Creates a default proxy object. | |
SdfListEditorProxy (const std::shared_ptr< Sdf_ListEditor< TypePolicy > > &listEditor) | |
Creates a new proxy object backed by the supplied list editor. | |
bool | IsExpired () const |
Returns true if the list editor is expired. | |
bool | IsExplicit () const |
Returns true if the editor has an explicit list, false if it has list operations. | |
bool | IsOrderedOnly () const |
Returns true if the editor is not explicit and allows ordering only. | |
bool | HasKeys () const |
Returns true if the editor has an explicit list (even if it's empty) or it has any added, prepended, appended, deleted, or ordered keys. | |
void | ApplyEditsToList (value_vector_type *vec) const |
Apply the edits to vec . | |
template<class CB > | |
void | ApplyEditsToList (value_vector_type *vec, CB callback) const |
Apply the edits to vec . | |
bool | CopyItems (const This &other) |
Copies the keys from other . | |
bool | ClearEdits () |
Removes all keys and changes the editor to have list operations. | |
bool | ClearEditsAndMakeExplicit () |
Removes all keys and changes the editor to be explicit. | |
template<class CB > | |
void | ModifyItemEdits (CB callback) |
callback is called for every key. | |
bool | ContainsItemEdit (const value_type &item, bool onlyAddOrExplicit=false) const |
Check if the given item is explicit, added, prepended, appended, deleted, or ordered by this editor. | |
void | RemoveItemEdits (const value_type &item) |
Remove all occurrences of the given item, regardless of whether the item is explicit, added, prepended, appended, deleted, or ordered. | |
void | ReplaceItemEdits (const value_type &oldItem, const value_type &newItem) |
Replace all occurrences of the given item, regardless of whether the item is explicit, added, prepended, appended, deleted or ordered. | |
ListProxy | GetExplicitItems () const |
Returns the explicitly set items. | |
ListProxy | GetAddedItems () const |
Returns the items added by this list editor. | |
ListProxy | GetPrependedItems () const |
Returns the items prepended by this list editor. | |
ListProxy | GetAppendedItems () const |
Returns the items appended by this list editor. | |
ListProxy | GetDeletedItems () const |
Returns the items deleted by this list editor. | |
ListProxy | GetOrderedItems () const |
Returns the items reordered by this list editor. | |
value_vector_type | GetAddedOrExplicitItems () const |
Deprecated. Please use GetAppliedItems. | |
value_vector_type | GetAppliedItems () const |
Returns the effective list of items represented by the operations in this list op. | |
void | Add (const value_type &value) |
void | Prepend (const value_type &value) |
void | Append (const value_type &value) |
void | Remove (const value_type &value) |
void | Erase (const value_type &value) |
operator bool () const | |
Explicit bool conversion operator. | |
Friends | |
template<class T > | |
class | SdfPyWrapListEditorProxy |
Represents a set of list editing operations.
An SdfListEditorProxy allows consumers to specify a transformation to be applied to a list via a set of list editing operations. Given a starting ordered list, it can either replace the result with another ordered list or apply a sequence of three operations: deleting keys, then adding keys to the end (if they aren't already in the starting list), then reordering keys.
The type policy defines the value type that a particular proxy can operate on.
Definition at line 39 of file listEditorProxy.h.
typedef std::function<std::optional<value_type>(SdfListOpType, const value_type&)> ApplyCallback |
Definition at line 49 of file listEditorProxy.h.
typedef SdfListProxy<TypePolicy> ListProxy |
Definition at line 43 of file listEditorProxy.h.
typedef std::function<std::optional<value_type>(const value_type&)> ModifyCallback |
Definition at line 53 of file listEditorProxy.h.
typedef SdfListEditorProxy<TypePolicy> This |
Definition at line 42 of file listEditorProxy.h.
typedef _TypePolicy TypePolicy |
Definition at line 41 of file listEditorProxy.h.
typedef TypePolicy::value_type value_type |
Definition at line 44 of file listEditorProxy.h.
typedef std::vector<value_type> value_vector_type |
Definition at line 45 of file listEditorProxy.h.
|
inline |
Creates a default proxy object.
The object evaluates to false
in a boolean context and all operations on this object have no effect.
Definition at line 57 of file listEditorProxy.h.
|
inlineexplicit |
Creates a new proxy object backed by the supplied list editor.
Definition at line 62 of file listEditorProxy.h.
|
inline |
Definition at line 301 of file listEditorProxy.h.
|
inline |
Definition at line 331 of file listEditorProxy.h.
|
inline |
Apply the edits to vec
.
Definition at line 101 of file listEditorProxy.h.
|
inline |
Apply the edits to vec
.
If callback
is valid then it's called for every key in the editor before applying it to vec
. If the returned key is invalid then the key will not be applied. Otherwise the returned key is applied, allowing callbacks to perform key translation.
Definition at line 114 of file listEditorProxy.h.
|
inline |
Removes all keys and changes the editor to have list operations.
Not all list editors support changing their mode. If the mode can't be changed to the mode of other
then this does nothing and returns false
, otherwise it returns true
.
Definition at line 139 of file listEditorProxy.h.
|
inline |
Removes all keys and changes the editor to be explicit.
Not all list editors support changing their mode. If the mode can't be changed to the mode of other
then this does nothing and returns false
, otherwise it returns true
.
Definition at line 149 of file listEditorProxy.h.
|
inline |
Check if the given item is explicit, added, prepended, appended, deleted, or ordered by this editor.
If onlyAddOrExplicit
is true
we only check the added or explicit items.
Definition at line 168 of file listEditorProxy.h.
|
inline |
Copies the keys from other
.
This differs from assignment because assignment just makes two list editors refer to the same lists.
Not all list editors support changing their mode. If the mode can't be changed to the mode of other
then this does nothing and returns false
, otherwise it returns true
.
Definition at line 128 of file listEditorProxy.h.
|
inline |
Definition at line 361 of file listEditorProxy.h.
|
inline |
Returns the items added by this list editor.
Definition at line 250 of file listEditorProxy.h.
|
inline |
Deprecated. Please use GetAppliedItems.
Definition at line 280 of file listEditorProxy.h.
|
inline |
Returns the items appended by this list editor.
Definition at line 262 of file listEditorProxy.h.
|
inline |
Returns the effective list of items represented by the operations in this list op.
This function should be used to determine the final list of items added instead of looking at the individual explicit, prepended, and appended item lists.
This is equivalent to calling ApplyOperations on an empty item vector.
Definition at line 292 of file listEditorProxy.h.
|
inline |
Returns the items deleted by this list editor.
Definition at line 268 of file listEditorProxy.h.
|
inline |
Returns the explicitly set items.
Definition at line 244 of file listEditorProxy.h.
|
inline |
Returns the items reordered by this list editor.
Definition at line 274 of file listEditorProxy.h.
|
inline |
Returns the items prepended by this list editor.
Definition at line 256 of file listEditorProxy.h.
|
inline |
Returns true
if the editor has an explicit list (even if it's empty) or it has any added, prepended, appended, deleted, or ordered keys.
Definition at line 95 of file listEditorProxy.h.
|
inline |
Returns true if the list editor is expired.
Definition at line 69 of file listEditorProxy.h.
|
inline |
Returns true
if the editor has an explicit list, false
if it has list operations.
Definition at line 80 of file listEditorProxy.h.
|
inline |
Returns true
if the editor is not explicit and allows ordering only.
Definition at line 87 of file listEditorProxy.h.
|
inline |
callback
is called for every key.
If the returned key is invalid then the key is removed, otherwise it's replaced with the returned key.
Definition at line 158 of file listEditorProxy.h.
|
inlineexplicit |
Explicit bool conversion operator.
A ListEditorProxy object converts to true
iff the list editor is valid, converts to false
otherwise.
Definition at line 380 of file listEditorProxy.h.
|
inline |
Definition at line 316 of file listEditorProxy.h.
|
inline |
Definition at line 346 of file listEditorProxy.h.
|
inline |
Remove all occurrences of the given item, regardless of whether the item is explicit, added, prepended, appended, deleted, or ordered.
Definition at line 212 of file listEditorProxy.h.
|
inline |
Replace all occurrences of the given item, regardless of whether the item is explicit, added, prepended, appended, deleted or ordered.
Definition at line 229 of file listEditorProxy.h.
|
friend |
Definition at line 461 of file listEditorProxy.h.