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

#include <layerStateDelegate.h>

Inheritance diagram for SdfSimpleLayerStateDelegate:

Static Public Member Functions
static SDF_API SdfSimpleLayerStateDelegateRefPtr	New ()

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

Protected Member Functions
virtual SDF_API bool	_IsDirty () override
	Returns true if the associated layer has been authored to since the last time the layer was marked clean, false otherwise.

virtual SDF_API void	_MarkCurrentStateAsClean () override
	Mark the current state of the layer as clean, i.e.

virtual SDF_API void	_MarkCurrentStateAsDirty () override
	Mark the current state of the layer as dirty, i.e.

virtual SDF_API void	_OnSetLayer (const SdfLayerHandle &layer) override
	Invoked when the state delegate is associated with layer `layer`.

virtual SDF_API void	_OnSetField (const SdfPath &path, const TfToken &fieldName, const VtValue &value) override
	Invoked when a field is being changed on the associated layer.

virtual SDF_API void	_OnSetField (const SdfPath &path, const TfToken &fieldName, const SdfAbstractDataConstValue &value) override

virtual SDF_API 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.

virtual SDF_API void	_OnSetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const SdfAbstractDataConstValue &value) override

virtual SDF_API void	_OnSetTimeSample (const SdfPath &path, double time, const VtValue &value) override
	Invoked when a time sample is being changed on the associated layer.

virtual SDF_API void	_OnSetTimeSample (const SdfPath &path, double time, const SdfAbstractDataConstValue &value) override

virtual SDF_API void	_OnCreateSpec (const SdfPath &path, SdfSpecType specType, bool inert) override
	Invoked when a new spec is created on the associated layer.

virtual SDF_API void	_OnDeleteSpec (const SdfPath &path, bool inert) override
	Invoked when a spec and its children are deleted from the associated layer.

virtual SDF_API void	_OnMoveSpec (const SdfPath &oldPath, const SdfPath &newPath) override
	Invoked when a spec and its children are moved.

virtual SDF_API 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.

virtual SDF_API 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.

virtual SDF_API 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.

virtual SDF_API 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.

Protected Member Functions inherited from SdfLayerStateDelegateBase
SDF_API SdfLayerHandle	_GetLayer () const
	Returns the layer associated with this state delegate.

SDF_API SdfAbstractDataPtr	_GetLayerData () const
	Returns the underlying data object for the layer associated with this state delegate.

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.

virtual void	_MarkCurrentStateAsClean ()=0
	Mark the current state of the layer as clean, i.e.

virtual void	_MarkCurrentStateAsDirty ()=0
	Mark the current state of the layer as dirty, i.e.

virtual void	_OnSetLayer (const SdfLayerHandle &layer)=0
	Invoked when the state delegate is associated with layer `layer`.

virtual void	_OnSetField (const SdfPath &path, const TfToken &fieldName, const VtValue &value)=0
	Invoked when a field is being changed on the associated layer.

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.

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.

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.

virtual void	_OnDeleteSpec (const SdfPath &path, bool inert)=0
	Invoked when a spec and its children are deleted from the associated layer.

virtual void	_OnMoveSpec (const SdfPath &oldPath, const SdfPath &newPath)=0
	Invoked when a spec and its children are moved.

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.

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.

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.

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.

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, VtValue *oldValue=NULL)

SDF_API void	SetField (const SdfPath &path, const TfToken &field, const SdfAbstractDataConstValue &value, VtValue *oldValue=NULL)

SDF_API void	SetFieldDictValueByKey (const SdfPath &path, const TfToken &field, const TfToken &keyPath, const VtValue &value, VtValue *oldValue=NULL)

SDF_API void	SetFieldDictValueByKey (const SdfPath &path, const TfToken &field, const TfToken &keyPath, const SdfAbstractDataConstValue &value, 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
	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object.

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object.

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (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 SDF_API 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 SDF_API void _MarkCurrentStateAsClean ( )

overrideprotectedvirtual

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

unchanged from its persistent representation.

Implements SdfLayerStateDelegateBase.

◆ _MarkCurrentStateAsDirty()

virtual SDF_API void _MarkCurrentStateAsDirty ( )

overrideprotectedvirtual

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

modified from its persistent representation.

Implements SdfLayerStateDelegateBase.

◆ _OnCreateSpec()

virtual SDF_API 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 SDF_API 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 SDF_API void _OnMoveSpec	(	const SdfPath &	oldPath,
		const SdfPath &	newPath
	)

overrideprotectedvirtual

Invoked when a spec and its children are moved.

Implements SdfLayerStateDelegateBase.

◆ _OnPopChild() [1/2]

virtual SDF_API 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.

◆ _OnPopChild() [2/2]

virtual SDF_API 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.

◆ _OnPushChild() [1/2]

virtual SDF_API 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.

◆ _OnPushChild() [2/2]

virtual SDF_API 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.

◆ _OnSetField() [1/2]

virtual SDF_API void _OnSetField	(	const SdfPath &	path,
		const TfToken &	fieldName,
		const SdfAbstractDataConstValue &	value
	)

overrideprotectedvirtual

Implements SdfLayerStateDelegateBase.

◆ _OnSetField() [2/2]

virtual SDF_API 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() [1/2]

virtual SDF_API void _OnSetFieldDictValueByKey	(	const SdfPath &	path,
		const TfToken &	fieldName,
		const TfToken &	keyPath,
		const SdfAbstractDataConstValue &	value
	)

overrideprotectedvirtual

Implements SdfLayerStateDelegateBase.

◆ _OnSetFieldDictValueByKey() [2/2]

virtual SDF_API 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 SDF_API 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() [1/2]

virtual SDF_API void _OnSetTimeSample	(	const SdfPath &	path,
		double	time,
		const SdfAbstractDataConstValue &	value
	)

overrideprotectedvirtual

Implements SdfLayerStateDelegateBase.

◆ _OnSetTimeSample() [2/2]

virtual SDF_API 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:

pxr/usd/sdf/layerStateDelegate.h

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _IsDirty()

◆ _MarkCurrentStateAsClean()

◆ _MarkCurrentStateAsDirty()

◆ _OnCreateSpec()

◆ _OnDeleteSpec()

◆ _OnMoveSpec()

◆ _OnPopChild() [1/2]

◆ _OnPopChild() [2/2]

◆ _OnPushChild() [1/2]

◆ _OnPushChild() [2/2]

◆ _OnSetField() [1/2]

◆ _OnSetField() [2/2]

◆ _OnSetFieldDictValueByKey() [1/2]

◆ _OnSetFieldDictValueByKey() [2/2]

◆ _OnSetLayer()

◆ _OnSetTimeSample() [1/2]

◆ _OnSetTimeSample() [2/2]