Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
SdfListEditorProxy< _TypePolicy > Class Template Reference

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
 

Detailed Description

template<class _TypePolicy>
class SdfListEditorProxy< _TypePolicy >

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 56 of file listEditorProxy.h.

Member Typedef Documentation

◆ ApplyCallback

typedef std::function<std::optional<value_type>(SdfListOpType, const value_type&)> ApplyCallback

Definition at line 66 of file listEditorProxy.h.

◆ ListProxy

typedef SdfListProxy<TypePolicy> ListProxy

Definition at line 60 of file listEditorProxy.h.

◆ ModifyCallback

typedef std::function<std::optional<value_type>(const value_type&)> ModifyCallback

Definition at line 70 of file listEditorProxy.h.

◆ This

typedef SdfListEditorProxy<TypePolicy> This

Definition at line 59 of file listEditorProxy.h.

◆ TypePolicy

typedef _TypePolicy TypePolicy

Definition at line 58 of file listEditorProxy.h.

◆ value_type

typedef TypePolicy::value_type value_type

Definition at line 61 of file listEditorProxy.h.

◆ value_vector_type

typedef std::vector<value_type> value_vector_type

Definition at line 62 of file listEditorProxy.h.

Constructor & Destructor Documentation

◆ SdfListEditorProxy() [1/2]

SdfListEditorProxy ( )
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 74 of file listEditorProxy.h.

◆ SdfListEditorProxy() [2/2]

SdfListEditorProxy ( const std::shared_ptr< Sdf_ListEditor< TypePolicy > > &  listEditor)
inlineexplicit

Creates a new proxy object backed by the supplied list editor.

Definition at line 79 of file listEditorProxy.h.

Member Function Documentation

◆ Add()

void Add ( const value_type &  value)
inline

Definition at line 318 of file listEditorProxy.h.

◆ Append()

void Append ( const value_type &  value)
inline

Definition at line 348 of file listEditorProxy.h.

◆ ApplyEditsToList() [1/2]

void ApplyEditsToList ( value_vector_type *  vec) const
inline

Apply the edits to vec.

Definition at line 118 of file listEditorProxy.h.

◆ ApplyEditsToList() [2/2]

void ApplyEditsToList ( value_vector_type *  vec,
CB  callback 
) const
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 131 of file listEditorProxy.h.

◆ ClearEdits()

bool ClearEdits ( )
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 156 of file listEditorProxy.h.

◆ ClearEditsAndMakeExplicit()

bool ClearEditsAndMakeExplicit ( )
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 166 of file listEditorProxy.h.

◆ ContainsItemEdit()

bool ContainsItemEdit ( const value_type &  item,
bool  onlyAddOrExplicit = false 
) const
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 185 of file listEditorProxy.h.

◆ CopyItems()

bool CopyItems ( const This &  other)
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 145 of file listEditorProxy.h.

◆ Erase()

void Erase ( const value_type &  value)
inline

Definition at line 378 of file listEditorProxy.h.

◆ GetAddedItems()

ListProxy GetAddedItems ( ) const
inline

Returns the items added by this list editor.

Definition at line 267 of file listEditorProxy.h.

◆ GetAddedOrExplicitItems()

value_vector_type GetAddedOrExplicitItems ( ) const
inline

Deprecated. Please use GetAppliedItems.

Definition at line 297 of file listEditorProxy.h.

◆ GetAppendedItems()

ListProxy GetAppendedItems ( ) const
inline

Returns the items appended by this list editor.

Definition at line 279 of file listEditorProxy.h.

◆ GetAppliedItems()

value_vector_type GetAppliedItems ( ) const
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 309 of file listEditorProxy.h.

◆ GetDeletedItems()

ListProxy GetDeletedItems ( ) const
inline

Returns the items deleted by this list editor.

Definition at line 285 of file listEditorProxy.h.

◆ GetExplicitItems()

ListProxy GetExplicitItems ( ) const
inline

Returns the explicitly set items.

Definition at line 261 of file listEditorProxy.h.

◆ GetOrderedItems()

ListProxy GetOrderedItems ( ) const
inline

Returns the items reordered by this list editor.

Definition at line 291 of file listEditorProxy.h.

◆ GetPrependedItems()

ListProxy GetPrependedItems ( ) const
inline

Returns the items prepended by this list editor.

Definition at line 273 of file listEditorProxy.h.

◆ HasKeys()

bool HasKeys ( ) const
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 112 of file listEditorProxy.h.

◆ IsExpired()

bool IsExpired ( ) const
inline

Returns true if the list editor is expired.

Definition at line 86 of file listEditorProxy.h.

◆ IsExplicit()

bool IsExplicit ( ) const
inline

Returns true if the editor has an explicit list, false if it has list operations.

Definition at line 97 of file listEditorProxy.h.

◆ IsOrderedOnly()

bool IsOrderedOnly ( ) const
inline

Returns true if the editor is not explicit and allows ordering only.

Definition at line 104 of file listEditorProxy.h.

◆ ModifyItemEdits()

void ModifyItemEdits ( CB  callback)
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 175 of file listEditorProxy.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Explicit bool conversion operator.

A ListEditorProxy object converts to true iff the list editor is valid, converts to false otherwise.

Definition at line 397 of file listEditorProxy.h.

◆ Prepend()

void Prepend ( const value_type &  value)
inline

Definition at line 333 of file listEditorProxy.h.

◆ Remove()

void Remove ( const value_type &  value)
inline

Definition at line 363 of file listEditorProxy.h.

◆ RemoveItemEdits()

void RemoveItemEdits ( const value_type &  item)
inline

Remove 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.

◆ ReplaceItemEdits()

void ReplaceItemEdits ( const value_type &  oldItem,
const value_type &  newItem 
)
inline

Replace all occurrences of the given item, regardless of whether the item is explicit, added, prepended, appended, deleted or ordered.

Definition at line 246 of file listEditorProxy.h.

Friends And Related Function Documentation

◆ SdfPyWrapListEditorProxy

friend class SdfPyWrapListEditorProxy
friend

Definition at line 478 of file listEditorProxy.h.

The documentation for this class was generated from the following file: