#include <layerStateDelegate.h>

Inheritance diagram for SdfLayerStateDelegateBase:

Public Member Functions
virtual SDF_API	~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 (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

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

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase ()

	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Protected Member Functions
SDF_API	SdfLayerStateDelegateBase ()

SDF_API SdfLayerHandle	_GetLayer () const

SDF_API SdfAbstractDataPtr	_GetLayerData () const

virtual bool	_IsDirty ()=0

virtual void	_MarkCurrentStateAsClean ()=0

virtual void	_MarkCurrentStateAsDirty ()=0

virtual void	_OnSetLayer (const SdfLayerHandle &layer)=0

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

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 TfRefBase
virtual TF_API	~TfRefBase ()

Protected Member Functions inherited from TfWeakBase
	~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.

Constructor & Destructor Documentation

virtual SDF_API SdfLayerStateDelegateBase::~SdfLayerStateDelegateBase ( )

virtual

SDF_API SdfLayerStateDelegateBase::SdfLayerStateDelegateBase ( )

protected

Member Function Documentation

SDF_API SdfLayerHandle SdfLayerStateDelegateBase::_GetLayer ( ) const

protected

Returns the layer associated with this state delegate. May be NULL if no layer is associated.

SDF_API SdfAbstractDataPtr SdfLayerStateDelegateBase::_GetLayerData ( ) const

protected

Returns the underlying data object for the layer associated with this state delegate. May be NULL if no layer is associated.

virtual bool SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_MarkCurrentStateAsClean ( )

protectedpure virtual

Mark the current state of the layer as clean, i.e. unchanged from its persistent representation.

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_MarkCurrentStateAsDirty ( )

protectedpure virtual

Mark the current state of the layer as dirty, i.e. modified from its persistent representation.

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_OnCreateSpec	(	const SdfPath &	path,
		SdfSpecType	specType,
		bool	inert
	)

protectedpure virtual

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

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_OnDeleteSpec	(	const SdfPath &	path,
		bool	inert
	)

protectedpure virtual

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

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_OnMoveSpec	(	const SdfPath &	oldPath,
		const SdfPath &	newPath
	)

protectedpure virtual

Invoked when a spec and its children are moved.

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_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.

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

protectedpure virtual

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_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.

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

protectedpure virtual

Implemented in SdfSimpleLayerStateDelegate.

virtual void SdfLayerStateDelegateBase::_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.

virtual void SdfLayerStateDelegateBase::_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.

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

protectedpure virtual

Implemented in SdfSimpleLayerStateDelegate.

SDF_API void SdfLayerStateDelegateBase::CreateSpec	(	const SdfPath &	path,
		SdfSpecType	specType,
		bool	inert
	)

SDF_API void SdfLayerStateDelegateBase::DeleteSpec	(	const SdfPath &	path,
		bool	inert
	)

SDF_API bool SdfLayerStateDelegateBase::IsDirty ( )

SDF_API void SdfLayerStateDelegateBase::MoveSpec	(	const SdfPath &	oldPath,
		const SdfPath &	newPath
	)

SDF_API void SdfLayerStateDelegateBase::PopChild	(	const SdfPath &	parentPath,
		const TfToken &	field,
		const TfToken &	oldValue
	)

SDF_API void SdfLayerStateDelegateBase::PopChild	(	const SdfPath &	parentPath,
		const TfToken &	field,
		const SdfPath &	oldValue
	)

SDF_API void SdfLayerStateDelegateBase::PushChild	(	const SdfPath &	parentPath,
		const TfToken &	field,
		const TfToken &	value
	)

SDF_API void SdfLayerStateDelegateBase::PushChild	(	const SdfPath &	parentPath,
		const TfToken &	field,
		const SdfPath &	value
	)

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

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

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

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

SDF_API void SdfLayerStateDelegateBase::SetTimeSample	(	const SdfPath &	path,
		double	time,
		const VtValue &	value
	)

SDF_API void SdfLayerStateDelegateBase::SetTimeSample	(	const SdfPath &	path,
		double	time,
		const SdfAbstractDataConstValue &	value
	)

Friends And Related Function Documentation

friend class SdfLayer

friend

Definition at line 256 of file layerStateDelegate.h.

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

pxr/usd/sdf/layerStateDelegate.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation