unf::StageDispatcher Class Reference

Default dispatcher which emits UnfNotice::StageNotice derived notices corresponding to each PXR_NS::UsdNotice::StageNotice derived notice received. More...

#include <dispatcher.h>

Inheritance diagram for unf::StageDispatcher:

Public Member Functions
virtual std::string	GetIdentifier () const override
	Get unique string identifier.
virtual void	Register () override
	Register listeners to each PXR_NS::UsdNotice::StageNotice derived notices.
Public Member Functions inherited from unf::Dispatcher
virtual UNF_API	~Dispatcher ()
	Revoke all registered listeners on destruction.
virtual UNF_API void	Revoke ()
	Revoke all registered listeners.

Friends
class	Broker
	Only a Broker can create a StageDispatcher.

Additional Inherited Members
Protected Member Functions inherited from unf::Dispatcher
UNF_API	Dispatcher (const BrokerWeakPtr &)
	Create a dispatcher targeting a Broker.
template<class InputNotice , class OutputNotice >
void	_Register ()
	Convenient templated method to register a listener for incoming InputNotice notice which emits a OutputNotice notice.
template<class InputNotice , class OutputNotice >
void	_OnReceiving (const InputNotice &notice)
	Convenient templated method to emit a OutputNotice notice from an incoming InputNotice notice.
Protected Attributes inherited from unf::Dispatcher
BrokerWeakPtr	_broker
	Broker that the dispatcher is attached to.
std::vector< PXR_NS::TfNotice::Key >	_keys
	List of handle-objects used for registering listeners.

Detailed Description

Default dispatcher which emits UnfNotice::StageNotice derived notices corresponding to each PXR_NS::UsdNotice::StageNotice derived notice received.

Member Function Documentation

GetIdentifier()

virtual std::string unf::StageDispatcher::GetIdentifier ( ) const

inlineoverridevirtual

Get unique string identifier.

Identifier will be used to retrieve Dispatcher from the Broker.

See also

Broker::GetDispatcher

Implements unf::Dispatcher.

Register()

virtual void unf::StageDispatcher::Register ( )

overridevirtual

Register listeners to each PXR_NS::UsdNotice::StageNotice derived notices.

Implements unf::Dispatcher.

---

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

• dispatcher.h