unf::UnfNotice::ObjectsChanged Class Reference

Notice sent in response to authored changes that affect any PXR_NS::UsdObject. More...

#include <notice.h>

Inheritance diagram for unf::UnfNotice::ObjectsChanged:

Public Member Functions
UNF_API	ObjectsChanged (const ObjectsChanged &)
	Copy constructor.
UNF_API ObjectsChanged &	operator= (const ObjectsChanged &)
	Assignment operator.
virtual UNF_API void	Merge (ObjectsChanged &&) override
	Merge notice with another ObjectsChanged notice. More...
virtual UNF_API void	PostProcess () override
	Base method for adding post process after merging data within a transaction. More...
UNF_API bool	AffectedObject (const PXR_NS::UsdObject &object) const
	Indicate whether object was affected by the change that generated this notice. More...
UNF_API bool	ResyncedObject (const PXR_NS::UsdObject &) const
	Indicate whether object was resynced by the change that generated this notice. More...
UNF_API bool	ChangedInfoOnly (const PXR_NS::UsdObject &) const
	Indicate whether object was modified but not resynced by the change that generated this notice. More...
UNF_API const PXR_NS::SdfPathVector &	GetResyncedPaths () const
	Return vector of paths that are resynced in lexicographical order. More...
UNF_API const PXR_NS::SdfPathVector &	GetChangedInfoOnlyPaths () const
	Return vector of paths that are modified but not resynced in lexicographical order. More...
UNF_API TfTokenSet	GetChangedFields (const PXR_NS::UsdObject &) const
	Return the set of changed fields in layers that affected the object. More...
UNF_API TfTokenSet	GetChangedFields (const PXR_NS::SdfPath &) const
	Return the set of changed fields in layers that affected the path. More...
UNF_API bool	HasChangedFields (const PXR_NS::UsdObject &) const
	Indicate whether any changed fields affected the object. More...
UNF_API bool	HasChangedFields (const PXR_NS::SdfPath &) const
	Indicate whether any changed fields affected the path. More...
const ChangedFieldMap &	GetChangedFieldMap () const
	Return map of affected token sets organized per path.
Public Member Functions inherited from unf::UnfNotice::StageNoticeImpl< ObjectsChanged >
PXR_NS::TfRefPtr< ObjectsChanged >	Clone () const
	Return a copy of the notice.
virtual void	Merge (StageNotice &&notice) override
	Interface method for merging StageNotice. More...
virtual std::string	GetTypeId () const override
	Base method for returing unique type identifier. More...
Public Member Functions inherited from unf::UnfNotice::StageNotice
virtual UNF_API bool	IsMergeable () const
	Indicate whether notice from the same type can be consolidated during a transaction. More...
PXR_NS::TfRefPtr< StageNotice >	Clone () const
	Interface method to return a copy of the notice. More...

Protected Member Functions
	ObjectsChanged (const PXR_NS::UsdNotice::ObjectsChanged &)
	Create notice from PXR_NS::UsdNotice::ObjectsChanged instance.

Protected Attributes
friend	StageNoticeImpl< ObjectsChanged >
	Ensure that StageNoticeImpl::Create method can call constructor.

Additional Inherited Members
Static Public Member Functions inherited from unf::UnfNotice::StageNoticeImpl< ObjectsChanged >
static PXR_NS::TfRefPtr< ObjectsChanged >	Create (Args &&... args)
	Create a notice with variadic arguments.

Detailed Description

Notice sent in response to authored changes that affect any PXR_NS::UsdObject.

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

Member Function Documentation

Merge()

virtual UNF_API void unf::UnfNotice::ObjectsChanged::Merge ( ObjectsChanged &&  )

overridevirtual

Merge notice with another ObjectsChanged notice.

Note

Data will be move out of incoming ObjectsChanged notice.

Reimplemented from unf::UnfNotice::StageNoticeImpl< ObjectsChanged >.

PostProcess()

virtual UNF_API void unf::UnfNotice::ObjectsChanged::PostProcess ( )

overridevirtual

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

By default, no process is done.

Reimplemented from unf::UnfNotice::StageNotice.

AffectedObject()

UNF_API bool unf::UnfNotice::ObjectsChanged::AffectedObject ( const PXR_NS::UsdObject &  object ) const

inline

Indicate whether object was affected by the change that generated this notice.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::AffectedObject

ResyncedObject()

UNF_API bool unf::UnfNotice::ObjectsChanged::ResyncedObject

(

const PXR_NS::UsdObject &

)

const

Indicate whether object was resynced by the change that generated this notice.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::ResyncedObject

ChangedInfoOnly()

UNF_API bool unf::UnfNotice::ObjectsChanged::ChangedInfoOnly

(

const PXR_NS::UsdObject &

)

const

Indicate whether object was modified but not resynced by the change that generated this notice.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::ChangedInfoOnly

GetResyncedPaths()

UNF_API const PXR_NS::SdfPathVector& unf::UnfNotice::ObjectsChanged::GetResyncedPaths ( ) const

inline

Return vector of paths that are resynced in lexicographical order.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::GetResyncedPaths

GetChangedInfoOnlyPaths()

UNF_API const PXR_NS::SdfPathVector& unf::UnfNotice::ObjectsChanged::GetChangedInfoOnlyPaths ( ) const

inline

Return vector of paths that are modified but not resynced in lexicographical order.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::GetChangedInfoOnlyPaths

GetChangedFields() [1/2]

UNF_API TfTokenSet unf::UnfNotice::ObjectsChanged::GetChangedFields

(

const PXR_NS::UsdObject &

)

const

Return the set of changed fields in layers that affected the object.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::GetChangedFields(const UsdObject&) const

GetChangedFields() [2/2]

UNF_API TfTokenSet unf::UnfNotice::ObjectsChanged::GetChangedFields

(

const PXR_NS::SdfPath &

)

const

Return the set of changed fields in layers that affected the path.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::GetChangedFields(const SdfPath&) const

HasChangedFields() [1/2]

UNF_API bool unf::UnfNotice::ObjectsChanged::HasChangedFields

(

const PXR_NS::UsdObject &

)

const

Indicate whether any changed fields affected the object.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::HasChangedFields(const UsdObject&) const

HasChangedFields() [2/2]

UNF_API bool unf::UnfNotice::ObjectsChanged::HasChangedFields

(

const PXR_NS::SdfPath &

)

const

Indicate whether any changed fields affected the path.

Note

Equivalent from PXR_NS::UsdNotice::ObjectsChanged::HasChangedFields(const SdfPath&) const

---

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

• notice.h