unf::UnfNotice::StageNotice Class Reference

Base class for standalone PXR_NS::UsdStage notices. More...

#include <notice.h>

Inheritance diagram for unf::UnfNotice::StageNotice:

Public Member Functions
virtual UNF_API bool	IsMergeable () const
	Indicate whether notice from the same type can be consolidated during a transaction. More...
virtual void	Merge (StageNotice &&)
	Interface method for merging StageNotice. More...
virtual void	PostProcess ()
	Base method for adding post process after merging data within a transaction. More...
virtual UNF_API std::string	GetTypeId () const
	Interface method for returing unique type identifier. More...
PXR_NS::TfRefPtr< StageNotice >	Clone () const
	Interface method to return a copy of the notice. More...

Detailed Description

Base class for standalone PXR_NS::UsdStage notices.

This notice type is the standalone equivalent of the PXR_NS::UsdNotice::StageNotice notice type.

Note

This class is not abstact so that a corresponding Python type can be created.

Member Function Documentation

IsMergeable()

virtual UNF_API bool unf::UnfNotice::StageNotice::IsMergeable ( ) const

inlinevirtual

Indicate whether notice from the same type can be consolidated during a transaction.

By default, this method return true.

See also

Merge

NoticeTransaction

Merge()

virtual void unf::UnfNotice::StageNotice::Merge ( StageNotice &&  )

inlinevirtual

Interface method for merging StageNotice.

Warning

This method should be considered as pure virtual.

Reimplemented in unf::UnfNotice::StageNoticeImpl< Self >, unf::UnfNotice::StageNoticeImpl< ObjectsChanged >, unf::UnfNotice::StageNoticeImpl< StageContentsChanged >, unf::UnfNotice::StageNoticeImpl< LayerMutingChanged >, and unf::UnfNotice::StageNoticeImpl< StageEditTargetChanged >.

PostProcess()

virtual void unf::UnfNotice::StageNotice::PostProcess ( )

inlinevirtual

Base method for adding post process after merging data within a transaction.

By default, no process is done.

Reimplemented in unf::UnfNotice::ObjectsChanged.

GetTypeId()

virtual UNF_API std::string unf::UnfNotice::StageNotice::GetTypeId ( ) const

inlinevirtual

Interface method for returing unique type identifier.

Warning

This method should be considered as pure virtual.

Reimplemented in unf::UnfNotice::StageNoticeImpl< Self >, unf::UnfNotice::StageNoticeImpl< ObjectsChanged >, unf::UnfNotice::StageNoticeImpl< StageContentsChanged >, unf::UnfNotice::StageNoticeImpl< LayerMutingChanged >, and unf::UnfNotice::StageNoticeImpl< StageEditTargetChanged >.

Clone()

PXR_NS::TfRefPtr<StageNotice> unf::UnfNotice::StageNotice::Clone ( ) const

inline

Interface method to return a copy of the notice.

Warning

This method should be considered as pure virtual.

---

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

• notice.h