SdfLayerStateDelegateBase Class Referenceabstract

Maintains authoring state information for an associated layer. More...

+ Inheritance diagram for SdfLayerStateDelegateBase:

Public Member Functions

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
 

Protected Member Functions

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...
 
virtual bool _IsDirty ()=0
 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 ()=0
 Mark the current state of the layer as clean, i.e. More...
 
virtual void _MarkCurrentStateAsDirty ()=0
 Mark the current state of the layer as dirty, i.e. More...
 
virtual void _OnSetLayer (const SdfLayerHandle &layer)=0
 Invoked when the state delegate is associated with layer layer. More...
 
virtual void _OnSetField (const SdfPath &path, const TfToken &fieldName, const VtValue &value)=0
 Invoked when a field is being changed on the associated layer. More...
 
virtual void _OnSetField (const SdfPath &path, const TfToken &fieldName, const SdfAbstractDataConstValue &value)=0
 
virtual void _OnSetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const VtValue &value)=0
 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)=0
 
virtual void _OnSetTimeSample (const SdfPath &path, double time, const VtValue &value)=0
 Invoked when a time sample is being changed on the associated layer. More...
 
virtual void _OnSetTimeSample (const SdfPath &path, double time, const SdfAbstractDataConstValue &value)=0
 
virtual void _OnCreateSpec (const SdfPath &path, SdfSpecType specType, bool inert)=0
 Invoked when a new spec is created on the associated layer. More...
 
virtual void _OnDeleteSpec (const SdfPath &path, bool inert)=0
 Invoked when a spec and its children are deleted from the associated layer. More...
 
virtual void _OnMoveSpec (const SdfPath &oldPath, const SdfPath &newPath)=0
 Invoked when a spec and its children are moved. More...
 
virtual void _OnPushChild (const SdfPath &parentPath, const TfToken &fieldName, const TfToken &value)=0
 Invoked when a child spec is pushed onto a parent's list of children. More...
 
virtual void _OnPushChild (const SdfPath &parentPath, const TfToken &fieldName, const SdfPath &value)=0
 Invoked when a child spec is pushed onto a parent's list of children. More...
 
virtual void _OnPopChild (const SdfPath &parentPath, const TfToken &fieldName, const TfToken &oldValue)=0
 Invoked when a child spec is popped off a parent's list of children. More...
 
virtual void _OnPopChild (const SdfPath &parentPath, const TfToken &fieldName, const SdfPath &oldValue)=0
 Invoked when a child spec is popped off a parent's list of children. 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
 

Friends

class SdfLayer
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Detailed Description

Maintains authoring state information for an associated layer.

For example, layers rely on a state delegate to determine whether or not they have been dirtied by authoring operations.

A layer's state delegate is invoked on every authoring operation on that layer. The delegate may keep track of these operations for various purposes.

Definition at line 58 of file layerStateDelegate.h.

Member Function Documentation

◆ _GetLayer()

SDF_API SdfLayerHandle _GetLayer ( ) const
protected

Returns the layer associated with this state delegate.

May be NULL if no layer is associated.

◆ _GetLayerData()

SDF_API SdfAbstractDataPtr _GetLayerData ( ) const
protected

Returns the underlying data object for the layer associated with this state delegate.

May be NULL if no layer is associated.

◆ _IsDirty()

virtual bool _IsDirty ( )
protectedpure virtual

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _MarkCurrentStateAsClean()

virtual void _MarkCurrentStateAsClean ( )
protectedpure virtual

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

unchanged from its persistent representation.

Implemented in SdfSimpleLayerStateDelegate.

◆ _MarkCurrentStateAsDirty()

virtual void _MarkCurrentStateAsDirty ( )
protectedpure virtual

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

modified from its persistent representation.

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnCreateSpec()

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnDeleteSpec()

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnMoveSpec()

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

Invoked when a spec and its children are moved.

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnPopChild() [1/2]

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnPopChild() [2/2]

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnPushChild() [1/2]

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnPushChild() [2/2]

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnSetField()

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnSetFieldDictValueByKey()

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

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnSetLayer()

virtual void _OnSetLayer ( const SdfLayerHandle &  layer)
protectedpure virtual

Invoked when the state delegate is associated with layer layer.

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

Implemented in SdfSimpleLayerStateDelegate.

◆ _OnSetTimeSample()

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

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

Implemented in SdfSimpleLayerStateDelegate.


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