SdfSimpleLayerStateDelegate Class Reference

A layer state delegate that simply records whether any changes have been made to a layer. More...

+ Inheritance diagram for SdfSimpleLayerStateDelegate:

Static Public Member Functions

static SdfSimpleLayerStateDelegateRefPtr New ()
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

virtual bool _IsDirty () override
 Returns true if the associated layer has been authored to since the last time the layer was marked clean, false otherwise. More...
 
virtual void _MarkCurrentStateAsClean () override
 Mark the current state of the layer as clean, i.e. More...
 
virtual void _MarkCurrentStateAsDirty () override
 Mark the current state of the layer as dirty, i.e. More...
 
virtual void _OnSetLayer (const SdfLayerHandle &layer) override
 Invoked when the state delegate is associated with layer layer. More...
 
virtual void _OnSetField (const SdfPath &path, const TfToken &fieldName, const VtValue &value) override
 Invoked when a field is being changed on the associated layer. More...
 
virtual void _OnSetField (const SdfPath &path, const TfToken &fieldName, const SdfAbstractDataConstValue &value) override
 
virtual void _OnSetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const VtValue &value) override
 Invoked when a field dict key is being changed on the associated layer. More...
 
virtual void _OnSetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const SdfAbstractDataConstValue &value) override
 
virtual void _OnSetTimeSample (const SdfPath &path, double time, const VtValue &value) override
 Invoked when a time sample is being changed on the associated layer. More...
 
virtual void _OnSetTimeSample (const SdfPath &path, double time, const SdfAbstractDataConstValue &value) override
 
virtual void _OnCreateSpec (const SdfPath &path, SdfSpecType specType, bool inert) override
 Invoked when a new spec is created on the associated layer. More...
 
virtual void _OnDeleteSpec (const SdfPath &path, bool inert) override
 Invoked when a spec and its children are deleted from the associated layer. More...
 
virtual void _OnMoveSpec (const SdfPath &oldPath, const SdfPath &newPath) override
 Invoked when a spec and its children are moved. More...
 
virtual void _OnPushChild (const SdfPath &path, const TfToken &fieldName, const TfToken &value) override
 Invoked when a child spec is pushed onto a parent's list of children. More...
 
virtual void _OnPushChild (const SdfPath &path, const TfToken &fieldName, const SdfPath &value) override
 Invoked when a child spec is pushed onto a parent's list of children. More...
 
virtual void _OnPopChild (const SdfPath &path, const TfToken &fieldName, const TfToken &oldValue) override
 Invoked when a child spec is popped off a parent's list of children. More...
 
virtual void _OnPopChild (const SdfPath &path, const TfToken &fieldName, const SdfPath &oldValue) override
 Invoked when a child spec is popped off a parent's list of children. More...
 
- Protected Member Functions inherited from SdfLayerStateDelegateBase
SDF_API SdfLayerHandle _GetLayer () const
 Returns the layer associated with this state delegate. More...
 
SDF_API SdfAbstractDataPtr _GetLayerData () const
 Returns the underlying data object for the layer associated with this state delegate. More...
 
- Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- Public Member Functions inherited from SdfLayerStateDelegateBase
SDF_API bool IsDirty ()
 
SDF_API void SetField (const SdfPath &path, const TfToken &field, const VtValue &value, const VtValue *oldValue=NULL)
 
SDF_API void SetField (const SdfPath &path, const TfToken &field, const SdfAbstractDataConstValue &value, const VtValue *oldValue=NULL)
 
SDF_API void SetFieldDictValueByKey (const SdfPath &path, const TfToken &field, const TfToken &keyPath, const VtValue &value, const VtValue *oldValue=NULL)
 
SDF_API void SetFieldDictValueByKey (const SdfPath &path, const TfToken &field, const TfToken &keyPath, const SdfAbstractDataConstValue &value, const VtValue *oldValue=NULL)
 
SDF_API void SetTimeSample (const SdfPath &path, double time, const VtValue &value)
 
SDF_API void SetTimeSample (const SdfPath &path, double time, const SdfAbstractDataConstValue &value)
 
SDF_API void CreateSpec (const SdfPath &path, SdfSpecType specType, bool inert)
 
SDF_API void DeleteSpec (const SdfPath &path, bool inert)
 
SDF_API void MoveSpec (const SdfPath &oldPath, const SdfPath &newPath)
 
SDF_API void PushChild (const SdfPath &parentPath, const TfToken &field, const TfToken &value)
 
SDF_API void PushChild (const SdfPath &parentPath, const TfToken &field, const SdfPath &value)
 
SDF_API void PopChild (const SdfPath &parentPath, const TfToken &field, const TfToken &oldValue)
 
SDF_API void PopChild (const SdfPath &parentPath, const TfToken &field, const SdfPath &oldValue)
 
- Public Member Functions inherited from TfRefBase
size_t GetCurrentCount () const
 Return the current reference count of this object. More...
 
bool IsUnique () const
 Return true if only one TfRefPtr points to this object. More...
 
const TfRefCountGetRefCount () const
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Detailed Description

A layer state delegate that simply records whether any changes have been made to a layer.

Definition at line 266 of file layerStateDelegate.h.

Member Function Documentation

◆ _IsDirty()

virtual bool _IsDirty ( )
overrideprotectedvirtual

Returns true if the associated layer has been authored to since the last time the layer was marked clean, false otherwise.

Implements SdfLayerStateDelegateBase.

◆ _MarkCurrentStateAsClean()

virtual void _MarkCurrentStateAsClean ( )
overrideprotectedvirtual

Mark the current state of the layer as clean, i.e.

unchanged from its persistent representation.

Implements SdfLayerStateDelegateBase.

◆ _MarkCurrentStateAsDirty()

virtual void _MarkCurrentStateAsDirty ( )
overrideprotectedvirtual

Mark the current state of the layer as dirty, i.e.

modified from its persistent representation.

Implements SdfLayerStateDelegateBase.

◆ _OnCreateSpec()

virtual void _OnCreateSpec ( const SdfPath path,
SdfSpecType  specType,
bool  inert 
)
overrideprotectedvirtual

Invoked when a new spec is created on the associated layer.

Implements SdfLayerStateDelegateBase.

◆ _OnDeleteSpec()

virtual void _OnDeleteSpec ( const SdfPath path,
bool  inert 
)
overrideprotectedvirtual

Invoked when a spec and its children are deleted from the associated layer.

Implements SdfLayerStateDelegateBase.

◆ _OnMoveSpec()

virtual void _OnMoveSpec ( const SdfPath oldPath,
const SdfPath newPath 
)
overrideprotectedvirtual

Invoked when a spec and its children are moved.

Implements SdfLayerStateDelegateBase.

◆ _OnPopChild() [1/2]

virtual void _OnPopChild ( const SdfPath parentPath,
const TfToken fieldName,
const TfToken oldValue 
)
overrideprotectedvirtual

Invoked when a child spec is popped off a parent's list of children.

Implements SdfLayerStateDelegateBase.

◆ _OnPopChild() [2/2]

virtual void _OnPopChild ( const SdfPath parentPath,
const TfToken fieldName,
const SdfPath oldValue 
)
overrideprotectedvirtual

Invoked when a child spec is popped off a parent's list of children.

Implements SdfLayerStateDelegateBase.

◆ _OnPushChild() [1/2]

virtual void _OnPushChild ( const SdfPath parentPath,
const TfToken fieldName,
const TfToken value 
)
overrideprotectedvirtual

Invoked when a child spec is pushed onto a parent's list of children.

Implements SdfLayerStateDelegateBase.

◆ _OnPushChild() [2/2]

virtual void _OnPushChild ( const SdfPath parentPath,
const TfToken fieldName,
const SdfPath value 
)
overrideprotectedvirtual

Invoked when a child spec is pushed onto a parent's list of children.

Implements SdfLayerStateDelegateBase.

◆ _OnSetField()

virtual void _OnSetField ( const SdfPath path,
const TfToken fieldName,
const VtValue value 
)
overrideprotectedvirtual

Invoked when a field is being changed on the associated layer.

Implements SdfLayerStateDelegateBase.

◆ _OnSetFieldDictValueByKey()

virtual void _OnSetFieldDictValueByKey ( const SdfPath path,
const TfToken fieldName,
const TfToken keyPath,
const VtValue value 
)
overrideprotectedvirtual

Invoked when a field dict key is being changed on the associated layer.

Implements SdfLayerStateDelegateBase.

◆ _OnSetLayer()

virtual void _OnSetLayer ( const SdfLayerHandle &  layer)
overrideprotectedvirtual

Invoked when the state delegate is associated with layer layer.

layer may be NULL if the state delegate is being removed.

Implements SdfLayerStateDelegateBase.

◆ _OnSetTimeSample()

virtual void _OnSetTimeSample ( const SdfPath path,
double  time,
const VtValue value 
)
overrideprotectedvirtual

Invoked when a time sample is being changed on the associated layer.

Implements SdfLayerStateDelegateBase.


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