HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
UsdNotice::LayerMutingChanged Class Reference

#include <notice.h>

+ Inheritance diagram for UsdNotice::LayerMutingChanged:

Public Member Functions

 LayerMutingChanged (const UsdStageWeakPtr &stage, const std::vector< std::string > &mutedLayers, const std::vector< std::string > &unmutedLayers)
 
USD_API ~LayerMutingChanged () override
 
const std::vector< std::string > & GetMutedLayers () const
 
const std::vector< std::string > & GetUnmutedLayers () const
 
- Public Member Functions inherited from UsdNotice::StageNotice
USD_API StageNotice (const UsdStageWeakPtr &stage)
 
USD_API ~StageNotice () override
 
const UsdStageWeakPtr & GetStage () const
 Return the stage associated with this notice. More...
 
- Public Member Functions inherited from TfNotice
TF_API size_t Send () const
 
template<typename SenderPtr >
size_t Send (SenderPtr const &s) const
 
TF_API size_t SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const
 
virtual TF_API ~TfNotice ()
 

Additional Inherited Members

- Public Types inherited from TfNotice
typedef TfWeakPtr< Probe > WeakProbePtr
 
typedef std::vector< Key > Keys
 
- Static Public Member Functions inherited from TfNotice
static TF_API void InsertProbe (const WeakProbePtr &probe)
 
static TF_API void RemoveProbe (const WeakProbePtr &probe)
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method)
 
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)
 
static TF_API void Revoke (TfNotice::Keys *keys)
 
static TF_API bool RevokeAndWait (TfNotice::Key &key)
 
static TF_API void RevokeAndWait (TfNotice::Keys *keys)
 

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 493 of file notice.h.

Constructor & Destructor Documentation

UsdNotice::LayerMutingChanged::LayerMutingChanged ( const UsdStageWeakPtr &  stage,
const std::vector< std::string > &  mutedLayers,
const std::vector< std::string > &  unmutedLayers 
)
inlineexplicit

Definition at line 495 of file notice.h.

USD_API UsdNotice::LayerMutingChanged::~LayerMutingChanged ( )
override

Member Function Documentation

const std::vector<std::string>& UsdNotice::LayerMutingChanged::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 509 of file notice.h.

const std::vector<std::string>& UsdNotice::LayerMutingChanged::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 518 of file notice.h.

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