Usd Notice Framework  0.7.0
unf::UnfNotice::LayerMutingChanged Class Reference

Notice sent after a set of layers have been newly muted or unmuted. More...

#include <notice.h>

Inheritance diagram for unf::UnfNotice::LayerMutingChanged:
unf::UnfNotice::StageNoticeImpl< LayerMutingChanged > unf::UnfNotice::StageNotice PXR_NS::TfNotice PXR_NS::TfRefBase

Public Member Functions

UNF_API LayerMutingChanged (const LayerMutingChanged &)
 Copy constructor.
 
UNF_API LayerMutingChangedoperator= (const LayerMutingChanged &)
 Assignment operator.
 
virtual UNF_API void Merge (LayerMutingChanged &&) override
 Merge notice with another LayerMutingChanged notice. More...
 
UNF_API const std::vector< std::string > & GetMutedLayers () const
 Returns identifiers of the layers that were muted. More...
 
UNF_API const std::vector< std::string > & GetUnmutedLayers () const
 Returns identifiers of the layers that were unmuted. More...
 
- Public Member Functions inherited from unf::UnfNotice::StageNoticeImpl< LayerMutingChanged >
PXR_NS::TfRefPtr< LayerMutingChangedClone () 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...
 
virtual void PostProcess ()
 Base method for adding post process after merging data within a transaction. More...
 
PXR_NS::TfRefPtr< StageNoticeClone () const
 Interface method to return a copy of the notice. More...
 

Protected Member Functions

 LayerMutingChanged (const PXR_NS::UsdNotice::LayerMutingChanged &)
 Create notice from PXR_NS::UsdNotice::LayerMutingChanged instance.
 

Protected Attributes

friend StageNoticeImpl< LayerMutingChanged >
 Ensure that StageNoticeImpl::Create method can call constructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from unf::UnfNotice::StageNoticeImpl< LayerMutingChanged >
static PXR_NS::TfRefPtr< LayerMutingChangedCreate (Args &&... args)
 Create a notice with variadic arguments.
 

Detailed Description

Notice sent after a set of layers have been newly muted or unmuted.

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

Member Function Documentation

◆ Merge()

virtual UNF_API void unf::UnfNotice::LayerMutingChanged::Merge ( LayerMutingChanged &&  )
overridevirtual

Merge notice with another LayerMutingChanged notice.

Note
Data will be move out of incoming LayerMutingChanged notice.

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

◆ GetMutedLayers()

UNF_API const std::vector<std::string>& unf::UnfNotice::LayerMutingChanged::GetMutedLayers ( ) const
inline

Returns identifiers of the layers that were muted.

Note
Equivalent from PXR_NS::UsdNotice::LayerMutingChanged::GetMutedLayers

◆ GetUnmutedLayers()

UNF_API const std::vector<std::string>& unf::UnfNotice::LayerMutingChanged::GetUnmutedLayers ( ) const
inline

Returns identifiers of the layers that were unmuted.

Note
Equivalent from PXR_NS::UsdNotice::LayerMutingChanged::GetUnmutedLayers

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