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

#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)

const std::vector< std::string > &	GetMutedLayers () const
	Returns the identifier of the layers that were muted.

const std::vector< std::string > &	GetUnmutedLayers () const
	Returns the identifier of the layers that were unmuted.

Public Member Functions inherited from UsdNotice::StageNotice
USD_API	StageNotice (const UsdStageWeakPtr &stage)

const UsdStageWeakPtr &	GetStage () const
	Return the stage associated with this notice.

Public Member Functions inherited from TfNotice
TF_API size_t	Send () const
	Deliver the notice to interested listeners, returning the number of interested listeners.

template<typename SenderPtr >
size_t	Send (SenderPtr const &s) const
	Deliver the notice to interested listeners, returning the number of interested listeners.

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.

Additional Inherited Members
Public Types inherited from TfNotice
typedef TfWeakPtr< Probe >	WeakProbePtr

typedef std::vector< Key >	Keys
	A `TfNotice::Key` container.

Static Public Member Functions inherited from TfNotice
static TF_API void	InsertProbe (const WeakProbePtr &probe)
	Register a probe that will be invoked when notices are sent and delivered.

static TF_API void	RemoveProbe (const WeakProbePtr &probe)
	Remove a probe that was previously registered with `InsertProbe`.

template<class LPtr , class MethodPtr >
static TfNotice::Key	Register (LPtr const &listener, MethodPtr method)
	Register a listener as being interested in a `TfNotice`.

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.

static TF_API void	Revoke (TfNotice::Keys *keys)
	Revoke interest by listeners.

static TF_API bool	RevokeAndWait (TfNotice::Key &key)
	Revoke interest by a listener.

static TF_API void	RevokeAndWait (TfNotice::Keys *keys)
	Revoke interest by listeners.

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

◆ 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.

Member Function Documentation

◆ GetMutedLayers()

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

◆ GetUnmutedLayers()

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

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

pxr/usd/usd/notice.h