All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdNotice::LayerMutingChanged Class Reference

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

+ Inheritance diagram for UsdNotice::LayerMutingChanged:

Public Member Functions

 LayerMutingChanged (const UsdStageWeakPtr &stage, const std::vector< std::string > &mutedLayers, const std::vector< std::string > &unmutedLayers)
 
const std::vector< std::string > & GetMutedLayers () const
 Returns the identifier of the layers that were muted. More...
 
const std::vector< std::string > & GetUnmutedLayers () const
 Returns the identifier of the layers that were unmuted. More...
 
- Public Member Functions inherited from UsdNotice::StageNotice
USD_API StageNotice (const UsdStageWeakPtr &stage)
 
const UsdStageWeakPtr & GetStage () const
 Return the stage associated with this notice. More...
 
- Public Member Functions inherited from TfNotice
TF_API size_t Send () const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
template<typename SenderPtr >
size_t Send (SenderPtr const &s) const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
TF_API size_t SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const
 Variant of Send() that takes a specific sender in the form of a TfWeakBase pointer and a typeid. More...
 

Additional Inherited Members

- Public Types inherited from TfNotice
typedef TfWeakPtr< ProbeWeakProbePtr
 
typedef std::vector< KeyKeys
 A TfNotice::Key container. More...
 
- Static Public Member Functions inherited from TfNotice
static void InsertProbe (const WeakProbePtr &probe)
 Register a probe that will be invoked when notices are sent and delivered. More...
 
static void RemoveProbe (const WeakProbePtr &probe)
 Remove a probe that was previously registered with InsertProbe. More...
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method)
 Register a listener as being interested in a TfNotice. More...
 
template<class LPtr , class MethodPtr , class SenderPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, SenderPtr const &sender)
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, const TfType &noticeType, const TfAnyWeakPtr &sender)
 
static TF_API bool Revoke (TfNotice::Key &key)
 Revoke interest by a listener. More...
 
static TF_API void Revoke (TfNotice::Keys *keys)
 Revoke interest by listeners. More...
 

Detailed Description

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

Note this does not necessarily mean the specified layers are currently loaded.

LayerMutingChanged notice is sent before any UsdNotice::ObjectsChanged or UsdNotice::StageContentsChanged notices are sent resulting from muting or unmuting of layers.

Note that LayerMutingChanged notice is sent even if the muting/unmuting layer does not belong to the current stage, or is a layer that does belong to the current stage but is not yet loaded because it is behind an unloaded payload or unselected variant.

Definition at line 308 of file notice.h.

Member Function Documentation

const std::vector<std::string>& GetMutedLayers ( ) const
inline

Returns the identifier of the layers that were muted.

The stage's resolver context must be bound when looking up layers using the returned identifiers to ensure the same layers that would be used by the stage are found.

Definition at line 324 of file notice.h.

const std::vector<std::string>& GetUnmutedLayers ( ) const
inline

Returns the identifier of the layers that were unmuted.

The stage's resolver context must be bound when looking up layers using the returned identifiers to ensure the same layers that would be used by the stage are found.

Definition at line 333 of file notice.h.


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